name : SessionInterface.php <?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; use Symfony\Component\HttpFoundation\Session\Storage\MetadataBag; /** * Interface for the session. * * @author Drak <drak@zikula.org> */ interface SessionInterface { /** * Starts the session storage. * * @return Boolean True if session started. * * @throws \RuntimeException If session fails to start. * * @api */ public function start(); /** * Returns the session ID. * * @return string The session ID. * * @api */ public function getId(); /** * Sets the session ID * * @param string $id * * @api */ public function setId($id); /** * Returns the session name. * * @return mixed The session name. * * @api */ public function getName(); /** * Sets the session name. * * @param string $name * * @api */ public function setName($name); /** * Invalidates the current session. * * Clears all session attributes and flashes and regenerates the * session and deletes the old session from persistence. * * @param integer $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 Boolean True if session invalidated, false if error. * * @api */ public function invalidate($lifetime = null); /** * Migrates the current session to a new session id while maintaining all * session attributes. * * @param Boolean $destroy Whether to delete the old session or leave it to garbage collection. * @param integer $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 Boolean True if session migrated, false if error. * * @api */ public function migrate($destroy = false, $lifetime = null); /** * Force the session to be saved and closed. * * This method is generally not required for real sessions as * the session will be automatically saved at the end of * code execution. */ public function save(); /** * Checks if an attribute is defined. * * @param string $name The attribute name * * @return Boolean true if the attribute is defined, false otherwise * * @api */ public function has($name); /** * Returns an attribute. * * @param string $name The attribute name * @param mixed $default The default value if not found. * * @return mixed * * @api */ public function get($name, $default = null); /** * Sets an attribute. * * @param string $name * @param mixed $value * * @api */ public function set($name, $value); /** * Returns attributes. * * @return array Attributes * * @api */ public function all(); /** * Sets attributes. * * @param array $attributes Attributes */ public function replace(array $attributes); /** * Removes an attribute. * * @param string $name * * @return mixed The removed value or null when it does not exist * * @api */ public function remove($name); /** * Clears all attributes. * * @api */ public function clear(); /** * Checks if the session was started. * * @return Boolean */ public function isStarted(); /** * Registers a SessionBagInterface with the session. * * @param SessionBagInterface $bag */ public function registerBag(SessionBagInterface $bag); /** * Gets a bag instance by name. * * @param string $name * * @return SessionBagInterface */ public function getBag($name); /** * Gets session meta. * * @return MetadataBag */ public function getMetadataBag(); }