class FlashBag implements FlashBagInterface

FlashBag flash message container.

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.

Details

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

Parameters

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

at line line 36
string getName()

Gets this bag's name.

Return Value

string

at line line 41
setName($name)

Parameters

$name

at line line 49
initialize(array $flashes)

Initializes the Bag.

Parameters

array $flashes

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

Adds a flash message for type.

Parameters

string $type
string $message

at line line 65
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 73
array peekAll()

Gets all flash messages.

Return Value

array

at line line 81
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 97
array all()

Gets and clears flashes from the stack.

Return Value

array

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

Registers a message for a given type.

Parameters

string $type
$messages

at line line 116
setAll(array $messages)

Sets all flash messages.

Parameters

array $messages

at line line 124
bool has(string $type)

Has flash messages for a given type?

Parameters

string $type

Return Value

bool

at line line 132
array keys()

Returns a list of all defined types.

Return Value

array

at line line 140
string getStorageKey()

Gets the storage key for this bag.

Return Value

string

at line line 148
mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained