W3cubDocs

/Symfony 3.0

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface

interface FlashBagInterface implements SessionBagInterface

FlashBagInterface.

Methods

string getName()

Gets this bag's name

from SessionBagInterface
initialize(array $array)

Initializes the Bag

from SessionBagInterface
string getStorageKey()

Gets the storage key for this bag.

from SessionBagInterface
mixed clear()

Clears out data from bag.

from SessionBagInterface
add(string $type, string $message)

Adds a flash message for type.

set(string $type, string|array $message)

Registers a message for a given 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.

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.

Details

public string getName()

Gets this bag's name

Return Value

string

public initialize(array $array)

Initializes the Bag

Parameters

array $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.

public add(string $type, string $message)

Adds a flash message for type.

Parameters

string $type
string $message

public set(string $type, string|array $message)

Registers a message for a given type.

Parameters

string $type
string|array $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 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

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