FlashBag
class FlashBag implements FlashBagInterface, IteratorAggregate
Контейнер сообщений флэша FlashBag.
Реализация \IteratorAggregate устарела и будет удалена в версии 3.0.
Методы
| __construct(string $storageKey = '_sf2_flashes') | ||
| string | getName() Получает имя этого контейнера. | |
| setName($name) | ||
| initialize(array $flashes) Инициализирует контейнер. | ||
| add(string $type, string $message) Добавляет сообщение флэша для типа. | ||
| array | peek(string $type, array $default = array()) Получает сообщения флэша для данного типа. | |
| array | peekAll() Получает все сообщения флэша. | |
| array | get(string $type, array $default = array()) Получает и очищает флэш из стека. | |
| array | all() Получает и очищает всплывающие сообщения из стека. | |
| set(string $type, $messages) Регистрирует сообщение для заданного типа. | ||
| setAll(array $messages) Устанавливает все сообщения флэша. | ||
| bool | has(string $type) Есть ли сообщения флэша для данного типа? | |
| array | keys() Возвращает список всех определенных типов. | |
| string | getStorageKey() Получает ключ хранения для этого контейнера. | |
| mixed | clear() Очищает данные из контейнера. | |
| ArrayIterator | getIterator() устарело Возвращает итератор для флэшей. |
Подробности
__construct(string $storageKey = '_sf2_flashes')
Параметры
| string | $storageKey | Ключ, используемый для хранения флэшей в сессии |
string getName()
Получает имя этого контейнера.
Возвращаемое значение
| string |
setName($name)
Параметры
| $name |
initialize(array $flashes)
Инициализирует контейнер.
Параметры
| array | $flashes |
add(string $type, string $message)
Добавляет сообщение флэша для типа.
Параметры
| string | $type | |
| string | $message |
array peek(string $type, array $default = array())
Получает сообщения флэша для данного типа.
Параметры
| string | $type | Тип категории сообщения |
| array | $default | Значение по умолчанию, если $type не существует |
Возвращаемое значение
| array |
array peekAll()
Получает все сообщения флэша.
Возвращаемое значение
| array |
array get(string $type, array $default = array())
Получает и очищает флэш из стека.
Параметры
| string | $type | |
| array | $default | Значение по умолчанию, если $type не существует |
Возвращаемое значение
| array |
array all()
Получает и очищает всплывающие сообщения из стека.
Возвращаемое значение
| array |
set(string $type, $messages)
Регистрирует сообщение для заданного типа.
Параметры
| string | $type | |
| $messages |
setAll(array $messages)
Устанавливает все сообщения флэша.
Параметры
| array | $messages |
bool has(string $type)
Есть ли сообщения флэша для данного типа?
Параметры
| string | $type |
Возвращаемое значение
| bool |
array keys()
Возвращает список всех определенных типов.
Возвращаемое значение
| array |
string getStorageKey()
Получает ключ хранения для этого контейнера.
Возвращаемое значение
| string |
mixed clear()
Очищает данные из контейнера.
Возвращаемое значение
| mixed | Любые содержащиеся данные |
ArrayIterator getIterator() устарело
устарело
Возвращает итератор для флэшей.
Возвращаемое значение
| ArrayIterator | Экземпляр \ArrayIterator |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.html
