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