class FlashBag implements FlashBagInterface, IteratorAggregate

FlashBag flash message container.

\IteratorAggregate implementation is deprecated and will be removed in 3.0.

Methods

__construct(string $storageKey = '_sf2_flashes')

No description

string
getName()

Gets this bag's name.

setName($name)

No description

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.

getIterator() deprecated

Returns an iterator for flashes.

Details

at line line 30
__construct(string $storageKey = '_sf2_flashes')

Parameters

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

at line line 38
string getName()

Gets this bag's name.

Return Value

string

at line line 43
setName($name)

Parameters

$name

at line line 51
initialize(array $flashes)

Initializes the Bag.

Parameters

array $flashes

at line line 59
add(string $type, string $message)

Adds a flash message for type.

Parameters

string $type
string $message

at line line 67
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

at line line 75
array peekAll()

Gets all flash messages.

Return Value

array

at line line 83
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

at line line 99
array all()

Gets and clears flashes from the stack.

Return Value

array

at line line 110
set(string $type, $messages)

Registers a message for a given type.

Parameters

string $type
$messages

at line line 118
setAll(array $messages)

Sets all flash messages.

Parameters

array $messages

at line line 126
bool has(string $type)

Has flash messages for a given type?

Parameters

string $type

Return Value

bool

at line line 134
array keys()

Returns a list of all defined types.

Return Value

array

at line line 142
string getStorageKey()

Gets the storage key for this bag.

Return Value

string

at line line 150
mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained

at line line 162
ArrayIterator getIterator() deprecated

deprecated since version 2.4, to be removed in 3.0.

Returns an iterator for flashes.

Return Value

ArrayIterator An \ArrayIterator instance