W3cubDocs

/Symfony 4.1

FlashBag

class FlashBag implements FlashBagInterface

FlashBag flash message container.

Methods

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

Gets this bag's name.

setName($name)
initialize(array $flashes)

Initializes the Bag.

add(string $type, mixed $message)

Adds a flash message for type.

array peek(string $type, array $default = array())

Gets flash messages for a given type.

array peekAll()

Gets all flash messages.

array get(string $type, array $default = array())

Gets and clears flash from the stack.

array all()

Gets and clears flashes from the stack.

set(string $type, $messages)

Registers a message for a given type.

setAll(array $messages)

Sets all flash messages.

bool has(string $type)

Has flash messages for a given type?

array keys()

Returns a list of all defined types.

string getStorageKey()

Gets the storage key for this bag.

mixed clear()

Clears out data from bag.

Details

__construct(string $storageKey = '_symfony_flashes')

Parameters

string $storageKey The key used to store flashes in the session

string getName()

Gets this bag's name.

Return Value

string

setName($name)

Parameters

$name

initialize(array $flashes)

Initializes the Bag.

Parameters

array $flashes

add(string $type, mixed $message)

Adds a flash message for type.

Parameters

string $type
mixed $message

array peek(string $type, array $default = array())

Gets flash messages for a given type.

Parameters

string $type Message category type
array $default Default value if $type does not exist

Return Value

array

array peekAll()

Gets all flash messages.

Return Value

array

array get(string $type, array $default = array())

Gets and clears flash from the stack.

Parameters

string $type
array $default Default value if $type does not exist

Return Value

array

array all()

Gets and clears flashes from the stack.

Return Value

array

set(string $type, $messages)

Registers a message for a given type.

Parameters

string $type
$messages

setAll(array $messages)

Sets all flash messages.

Parameters

array $messages

bool has(string $type)

Has flash messages for a given type?

Parameters

string $type

Return Value

bool

array keys()

Returns a list of all defined types.

Return Value

array

string getStorageKey()

Gets the storage key for this bag.

Return Value

string

mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained

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