W3cubDocs

/Symfony 3.0

Symfony\Component\HttpFoundation\Session\Flash\FlashBag

class FlashBag implements FlashBagInterface

FlashBag flash message container.

Methods

__construct(string $storageKey = '_sf2_flashes')

Constructor.

string getName()

Gets this bag's name.

setName($name)
initialize(array $flashes)

Initializes the Bag.

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

public __construct(string $storageKey = '_sf2_flashes')

Constructor.

Parameters

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

public string getName()

Gets this bag's name.

Return Value

string

public setName($name)

Parameters

$name

public initialize(array $flashes)

Initializes the Bag.

Parameters

array $flashes

public add(string $type, string $message)

Adds a flash message for type.

Parameters

string $type
string $message

public 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

public array peekAll()

Gets all flash messages.

Return Value

array

public 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

public array all()

Gets and clears flashes from the stack.

Return Value

array

public set(string $type, $messages)

Registers a message for a given type.

Parameters

string $type
$messages

public setAll(array $messages)

Sets all flash messages.

Parameters

array $messages

public bool has(string $type)

Has flash messages for a given type?

Parameters

string $type

Return Value

bool

public array keys()

Returns a list of all defined types.

Return Value

array

public string getStorageKey()

Gets the storage key for this bag.

Return Value

string

public mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained.

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.html