Spec-Zone.ru › Symfony 3.3

FlashBag

class FlashBag implements FlashBagInterface

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

Методы

__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()

Получает и очищает всплывающие сообщения из стека.

set(string $type, $messages)

Регистрирует сообщение для заданного типа.

setAll(array $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

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.3/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.html

Spec-Zone.ru

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