@@ -107,10 +107,10 @@ Session Attributes
107
107
Returns true if the attribute exists.
108
108
109
109
:method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Session::replace `
110
- Sets multiple attributes at once: takes a keyed array and sets each key => value pair;
110
+ Sets multiple attributes at once: takes a keyed array and sets each key => value pair.
111
111
112
112
:method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Session::remove `
113
- Deletes an attribute by key;
113
+ Deletes an attribute by key.
114
114
115
115
:method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Session::clear `
116
116
Clear all attributes.
@@ -123,7 +123,7 @@ an array. A few methods exist for "Bag" management:
123
123
124
124
:method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Session::getBag `
125
125
Gets a :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface ` by
126
- bag name;
126
+ bag name.
127
127
128
128
:method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Session::getFlashBag `
129
129
Gets the :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface `.
@@ -157,16 +157,16 @@ bag types if necessary.
157
157
:class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface ` has
158
158
the following API which is intended mainly for internal purposes:
159
159
160
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface::getStorageKey `:
161
- Returns the key which the bag will ultimately store its array under in ``$_SESSION ``.
162
- Generally this value can be left at its default and is for internal use.
160
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface::getStorageKey `
161
+ Returns the key which the bag will ultimately store its array under in ``$_SESSION ``.
162
+ Generally this value can be left at its default and is for internal use.
163
163
164
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface::initialize `:
165
- This is called internally by Symfony session storage classes to link bag data
166
- to the session.
164
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface::initialize `
165
+ This is called internally by Symfony session storage classes to link bag data
166
+ to the session.
167
167
168
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface::getName `:
169
- Returns the name of the session bag.
168
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ SessionBagInterface::getName `
169
+ Returns the name of the session bag.
170
170
171
171
Attributes
172
172
~~~~~~~~~~
@@ -175,11 +175,11 @@ The purpose of the bags implementing the :class:`Symfony\\Component\\HttpFoundat
175
175
is to handle session attribute storage. This might include things like user ID,
176
176
and remember me login settings or other user based state information.
177
177
178
- * :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBag `
179
- This is the standard default implementation.
178
+ :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBag `
179
+ This is the standard default implementation.
180
180
181
- * :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ NamespacedAttributeBag `
182
- This implementation allows for attributes to be stored in a structured namespace.
181
+ :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ NamespacedAttributeBag `
182
+ This implementation allows for attributes to be stored in a structured namespace.
183
183
184
184
Any plain key-value storage system is limited in the extent to which
185
185
complex data can be stored since each key must be unique. You can achieve
@@ -210,29 +210,29 @@ This way you can easily access a key within the stored array directly and easily
210
210
:class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface `
211
211
has a simple API
212
212
213
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::set `:
214
- Sets an attribute by key;
213
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::set `
214
+ Sets an attribute by key.
215
215
216
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::get `:
217
- Gets an attribute by key;
216
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::get `
217
+ Gets an attribute by key.
218
218
219
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::all `:
220
- Gets all attributes as an array of key => value;
219
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::all `
220
+ Gets all attributes as an array of key => value.
221
221
222
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::has `:
223
- Returns true if the attribute exists;
222
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::has `
223
+ Returns true if the attribute exists.
224
224
225
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::keys `:
226
- Returns an array of stored attribute keys;
225
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::keys `
226
+ Returns an array of stored attribute keys.
227
227
228
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::replace `:
229
- Sets multiple attributes at once: takes a keyed array and sets each key => value pair.
228
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::replace `
229
+ Sets multiple attributes at once: takes a keyed array and sets each key => value pair.
230
230
231
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::remove `:
232
- Deletes an attribute by key;
231
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::remove `
232
+ Deletes an attribute by key.
233
233
234
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::clear `:
235
- Clear the bag;
234
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Attribute\\ AttributeBagInterface::clear `
235
+ Clear the bag.
236
236
237
237
Flash Messages
238
238
~~~~~~~~~~~~~~
@@ -246,49 +246,49 @@ updated page or an error page. Flash messages set in the previous page request
246
246
would be displayed immediately on the subsequent page load for that session.
247
247
This is however just one application for flash messages.
248
248
249
- * :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ AutoExpireFlashBag `
250
- In this implementation, messages set in one page-load will
251
- be available for display only on the next page load. These messages will auto
252
- expire regardless of if they are retrieved or not.
249
+ :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ AutoExpireFlashBag `
250
+ In this implementation, messages set in one page-load will
251
+ be available for display only on the next page load. These messages will auto
252
+ expire regardless of if they are retrieved or not.
253
253
254
- * :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBag `
255
- In this implementation, messages will remain in the session until
256
- they are explicitly retrieved or cleared. This makes it possible to use ESI
257
- caching.
254
+ :class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBag `
255
+ In this implementation, messages will remain in the session until
256
+ they are explicitly retrieved or cleared. This makes it possible to use ESI
257
+ caching.
258
258
259
259
:class: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface `
260
260
has a simple API
261
261
262
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::add `:
263
- Adds a flash message to the stack of specified type;
262
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::add `
263
+ Adds a flash message to the stack of specified type.
264
264
265
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::set `:
266
- Sets flashes by type; This method conveniently takes both single messages as
267
- a ``string `` or multiple messages in an ``array ``.
265
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::set `
266
+ Sets flashes by type; This method conveniently takes both single messages as
267
+ a ``string `` or multiple messages in an ``array ``.
268
268
269
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::get `:
270
- Gets flashes by type and clears those flashes from the bag;
269
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::get `
270
+ Gets flashes by type and clears those flashes from the bag.
271
271
272
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::setAll `:
273
- Sets all flashes, accepts a keyed array of arrays ``type => array(messages) ``;
272
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::setAll `
273
+ Sets all flashes, accepts a keyed array of arrays ``type => array(messages) ``.
274
274
275
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::all `:
276
- Gets all flashes (as a keyed array of arrays) and clears the flashes from the bag;
275
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::all `
276
+ Gets all flashes (as a keyed array of arrays) and clears the flashes from the bag.
277
277
278
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::peek `:
279
- Gets flashes by type (read only);
278
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::peek `
279
+ Gets flashes by type (read only).
280
280
281
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::peekAll `:
282
- Gets all flashes (read only) as keyed array of arrays;
281
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::peekAll `
282
+ Gets all flashes (read only) as keyed array of arrays.
283
283
284
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::has `:
285
- Returns true if the type exists, false if not;
284
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::has `
285
+ Returns true if the type exists, false if not.
286
286
287
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::keys `:
288
- Returns an array of the stored flash types;
287
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::keys `
288
+ Returns an array of the stored flash types.
289
289
290
- * :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::clear `:
291
- Clears the bag;
290
+ :method: `Symfony\\ Component\\ HttpFoundation\\ Session\\ Flash\\ FlashBagInterface::clear `
291
+ Clears the bag.
292
292
293
293
For simple applications it is usually sufficient to have one flash message per
294
294
type, for example a confirmation notice after a form is submitted. However,
0 commit comments