Spec-Zone.ru › Symfony 3.1

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

Spec-Zone.ru

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