Spec-Zone.ru › Symfony 3.4

FlashBag

class FlashBag implements FlashBagInterface

Контейнер сообщений-всплышек FlashBag.

Методы

__construct(string $storageKey = '_symfony_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()

Очищает данные из контейнера.

Подробности

__construct(string $storageKey = '_symfony_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 Любые содержащиеся данные

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API