Classes List

Symfony\Component\HttpFoundation\Session\SessionInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
<?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 bool True if session started * * @throws \RuntimeException if session fails to start */
    public function start();

    /** * Returns the session ID. * * @return string The session ID */
    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);

    /** * Invalidates the current session. * * Clears all session attributes and flashes and regenerates the * session and deletes the old session from persistence. * * @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 invalidated, false if error */
    public function invalidate($lifetime = null);

    /** * Migrates the current session to a new session id while maintaining all * session attributes. * * @param bool $destroy Whether to delete the old session or leave it to garbage collection * @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 migrated, false if error */
    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 bool true if the attribute is defined, false otherwise */
    public function has($name);

    /** * Returns an attribute. * * @param string $name The attribute name * @param mixed $default The default value if not found * * @return mixed */
    public function get($name$default = null);

    /** * Sets an attribute. * * @param string $name * @param mixed $value */
    public function set($name$value);

    /** * Returns attributes. * * @return array Attributes */
    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 */
    public function remove($name);

    /** * Clears all attributes. */
    public function clear();

    /** * Checks if the session was started. * * @return bool */
    public function isStarted();

    /** * Registers a SessionBagInterface with the session. */
    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();
}