Spec-Zone.ru › Symfony 4.1

FlashBag

class FlashBag implements FlashBagInterface

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

Методы

__construct(string $storageKey = '_symfony_flashes')
string getName()

Получает имя этого пакета.

setName($name)
initialize(array $flashes)

Инициализирует пакет.

add(string $type, mixed $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, mixed $message)

Добавляет сообщение-всплышку для типа.

Параметры

string $type
mixed $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.
https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.html

Spec-Zone.ru

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