Spec-Zone.ru › Symfony 3.0

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

Spec-Zone.ru

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