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