Verzeichnisstruktur phpBB-3.1.0
- Veröffentlicht
- 27.10.2014
So funktioniert es
|
|
Auf das letzte Element klicken. Dies geht jeweils ein Schritt zurück |
Auf das Icon klicken, dies öffnet das Verzeichnis. Nochmal klicken schließt das Verzeichnis. |
|
|
(Beispiel Datei-Icons)
|
Auf das Icon klicken um den Quellcode anzuzeigen |
SessionInterface.php
001 <?php
002
003 /*
004 * This file is part of the Symfony package.
005 *
006 * (c) Fabien Potencier <fabien@symfony.com>
007 *
008 * For the full copyright and license information, please view the LICENSE
009 * file that was distributed with this source code.
010 */
011
012 namespace Symfony\Component\HttpFoundation\Session;
013
014 use Symfony\Component\HttpFoundation\Session\Storage\MetadataBag;
015
016 /**
017 * Interface for the session.
018 *
019 * @author Drak <drak@zikula.org>
020 */
021 interface SessionInterface
022 {
023 /**
024 * Starts the session storage.
025 *
026 * @return bool True if session started.
027 *
028 * @throws \RuntimeException If session fails to start.
029 *
030 * @api
031 */
032 public function start();
033
034 /**
035 * Returns the session ID.
036 *
037 * @return string The session ID.
038 *
039 * @api
040 */
041 public function getId();
042
043 /**
044 * Sets the session ID
045 *
046 * @param string $id
047 *
048 * @api
049 */
050 public function setId($id);
051
052 /**
053 * Returns the session name.
054 *
055 * @return mixed The session name.
056 *
057 * @api
058 */
059 public function getName();
060
061 /**
062 * Sets the session name.
063 *
064 * @param string $name
065 *
066 * @api
067 */
068 public function setName($name);
069
070 /**
071 * Invalidates the current session.
072 *
073 * Clears all session attributes and flashes and regenerates the
074 * session and deletes the old session from persistence.
075 *
076 * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
077 * will leave the system settings unchanged, 0 sets the cookie
078 * to expire with browser session. Time is in seconds, and is
079 * not a Unix timestamp.
080 *
081 * @return bool True if session invalidated, false if error.
082 *
083 * @api
084 */
085 public function invalidate($lifetime = null);
086
087 /**
088 * Migrates the current session to a new session id while maintaining all
089 * session attributes.
090 *
091 * @param bool $destroy Whether to delete the old session or leave it to garbage collection.
092 * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
093 * will leave the system settings unchanged, 0 sets the cookie
094 * to expire with browser session. Time is in seconds, and is
095 * not a Unix timestamp.
096 *
097 * @return bool True if session migrated, false if error.
098 *
099 * @api
100 */
101 public function migrate($destroy = false, $lifetime = null);
102
103 /**
104 * Force the session to be saved and closed.
105 *
106 * This method is generally not required for real sessions as
107 * the session will be automatically saved at the end of
108 * code execution.
109 */
110 public function save();
111
112 /**
113 * Checks if an attribute is defined.
114 *
115 * @param string $name The attribute name
116 *
117 * @return bool true if the attribute is defined, false otherwise
118 *
119 * @api
120 */
121 public function has($name);
122
123 /**
124 * Returns an attribute.
125 *
126 * @param string $name The attribute name
127 * @param mixed $default The default value if not found.
128 *
129 * @return mixed
130 *
131 * @api
132 */
133 public function get($name, $default = null);
134
135 /**
136 * Sets an attribute.
137 *
138 * @param string $name
139 * @param mixed $value
140 *
141 * @api
142 */
143 public function set($name, $value);
144
145 /**
146 * Returns attributes.
147 *
148 * @return array Attributes
149 *
150 * @api
151 */
152 public function all();
153
154 /**
155 * Sets attributes.
156 *
157 * @param array $attributes Attributes
158 */
159 public function replace(array $attributes);
160
161 /**
162 * Removes an attribute.
163 *
164 * @param string $name
165 *
166 * @return mixed The removed value
167 *
168 * @api
169 */
170 public function remove($name);
171
172 /**
173 * Clears all attributes.
174 *
175 * @api
176 */
177 public function clear();
178
179 /**
180 * Checks if the session was started.
181 *
182 * @return bool
183 */
184 public function isStarted();
185
186 /**
187 * Registers a SessionBagInterface with the session.
188 *
189 * @param SessionBagInterface $bag
190 */
191 public function registerBag(SessionBagInterface $bag);
192
193 /**
194 * Gets a bag instance by name.
195 *
196 * @param string $name
197 *
198 * @return SessionBagInterface
199 */
200 public function getBag($name);
201
202 /**
203 * Gets session meta.
204 *
205 * @return MetadataBag
206 */
207 public function getMetadataBag();
208 }
209