FlashBagInterface
интерфейс FlashBagInterface реализует SessionBagInterface
FlashBagInterface.
Методы
| string | getName() Получает имя этого пакета. | из SessionBagInterface |
| initialize(array $array) Инициализирует пакет. | из SessionBagInterface | |
| string | getStorageKey() Получает ключ хранения для этого пакета. | из SessionBagInterface |
| mixed | clear() Очищает данные из пакета. | из SessionBagInterface |
| add(string $type, string $message) Добавляет сообщение всплывающего уведомления для типа. | ||
| set(string $type, string|array $message) Регистрирует сообщение для заданного типа. | ||
| array | peek(string $type, array $default = array()) Получает сообщения всплывающего уведомления для заданного типа. | |
| array | peekAll() Получает все сообщения всплывающего уведомления. | |
| array | get(string $type, array $default = array()) Получает и очищает всплывающее сообщение из стека. | |
| array | all() Получает и очищает всплывающие сообщения из стека. | |
| setAll(array $messages) Устанавливает все всплывающие сообщения. | ||
| bool | has(string $type) Есть ли сообщения всплывающего уведомления для заданного типа? | |
| array | keys() Возвращает список всех определённых типов. |
Подробности
string getName()
Получает имя этого пакета.
Значение результата
| string |
initialize(array $array)
Инициализирует пакет.
Параметры
| array | $array |
string getStorageKey()
Получает ключ хранения для этого пакета.
Значение результата
| string |
mixed clear()
Очищает данные из пакета.
Значение результата
| mixed | Любые данные, которые были содержались |
add(string $type, string $message)
Добавляет сообщение всплывающего уведомления для типа.
Параметры
| string | $type | |
| string | $message |
set(string $type, string|array $message)
Регистрирует сообщение для заданного типа.
Параметры
| string | $type | |
| string|array | $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 |
setAll(array $messages)
Устанавливает все всплывающие сообщения.
Параметры
| array | $messages |
bool has(string $type)
Есть ли сообщения всплывающего уведомления для заданного типа?
Параметры
| string | $type |
Значение результата
| bool |
array keys()
Возвращает список всех определённых типов.
Значение результата
| array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.html