123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpFoundation\Session\Storage;
- use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
- /**
- * StorageInterface.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- * @author Drak <drak@zikula.org>
- */
- interface SessionStorageInterface
- {
- /**
- * Starts the session.
- *
- * @throws \RuntimeException If something goes wrong starting the session.
- *
- * @return bool True if started.
- */
- public function start();
- /**
- * Checks if the session is started.
- *
- * @return bool True if started, false otherwise.
- */
- public function isStarted();
- /**
- * Returns the session ID.
- *
- * @return string The session ID or empty.
- */
- public function getId();
- /**
- * Sets the session ID.
- *
- * @param string $id
- */
- public function setId($id);
- /**
- * Returns the session name.
- *
- * @return mixed The session name.
- */
- public function getName();
- /**
- * Sets the session name.
- *
- * @param string $name
- */
- public function setName($name);
- /**
- * Regenerates id that represents this storage.
- *
- * This method must invoke session_regenerate_id($destroy) unless
- * this interface is used for a storage object designed for unit
- * or functional testing where a real PHP session would interfere
- * with testing.
- *
- * Note regenerate+destroy should not clear the session data in memory
- * only delete the session data from persistent storage.
- *
- * Care: When regenerating the session ID no locking is involved in PHPs
- * session design. See https://bugs.php.net/bug.php?id=61470 for a discussion.
- * So you must make sure the regenerated session is saved BEFORE sending the
- * headers with the new ID. Symfonys HttpKernel offers a listener for this.
- * See Symfony\Component\HttpKernel\EventListener\SaveSessionListener.
- * Otherwise session data could get lost again for concurrent requests with the
- * new ID. One result could be that you get logged out after just logging in.
- *
- * @param bool $destroy Destroy session when regenerating?
- * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
- * will leave the system settings unchanged, 0 sets the cookie
- * to expire with browser session. Time is in seconds, and is
- * not a Unix timestamp.
- *
- * @return bool True if session regenerated, false if error
- *
- * @throws \RuntimeException If an error occurs while regenerating this storage
- */
- public function regenerate($destroy = false, $lifetime = null);
- /**
- * Force the session to be saved and closed.
- *
- * This method must invoke session_write_close() unless this interface is
- * used for a storage object design for unit or functional testing where
- * a real PHP session would interfere with testing, in which case it
- * it should actually persist the session data if required.
- *
- * @throws \RuntimeException If the session is saved without being started, or if the session
- * is already closed.
- */
- public function save();
- /**
- * Clear all session data in memory.
- */
- public function clear();
- /**
- * Gets a SessionBagInterface by name.
- *
- * @param string $name
- *
- * @return SessionBagInterface
- *
- * @throws \InvalidArgumentException If the bag does not exist
- */
- public function getBag($name);
- /**
- * Registers a SessionBagInterface for use.
- *
- * @param SessionBagInterface $bag
- */
- public function registerBag(SessionBagInterface $bag);
- /**
- * @return MetadataBag
- */
- public function getMetadataBag();
- }
|