AutoExpireFlashBag
class AutoExpireFlashBag implements FlashBagInterface
Контейнер сообщений всплывающего уведомления AutoExpireFlashBag.
Методы
| __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() Получает и очищает всплывающие уведомления из стека. | |
| setAll(array $messages) Устанавливает все сообщения всплывающего уведомления. | ||
| set(string $type, $messages) Регистрирует сообщение для данного типа. | ||
| bool | has(string $type) Есть ли сообщения всплывающего уведомления для данного типа? | |
| array | keys() Возвращает список всех определённых типов. | |
| string | getStorageKey() Получает ключ хранения для этого пакета. | |
| mixed | clear() Очищает данные из пакета. |
Подробное описание
__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 |
setAll(array $messages)
Устанавливает все сообщения всплывающего уведомления.
Параметры
| array | $messages |
set(string $type, $messages)
Регистрирует сообщение для данного типа.
Параметры
| string | $type | |
| $messages |
bool has(string $type)
Есть ли сообщения всплывающего уведомления для данного типа?
Параметры
| string | $type |
Возвращаемое значение
| bool |
array keys()
Возвращает список всех определённых типов.
Возвращаемое значение
| array |
string getStorageKey()
Получает ключ хранения для этого пакета.
Возвращаемое значение
| string |
mixed clear()
Очищает данные из пакета.
Возвращаемое значение
| mixed | Любые содержащиеся данные |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/HttpFoundation/Session/Flash/AutoExpireFlashBag.html