SymfonyComponentHttpFoundationSessionFlashAutoExpireFlashBag

AutoExpireFlashBag flash message container.

Summary

No protected methods found
No protected properties found
N/A
No private methods found
N/A
File
vendorSymfonyComponentHttpFoundationSessionFlashAutoExpireFlashBag.php
Package
Default
Class hierarchy
SymfonyComponentHttpFoundationSessionFlashAutoExpireFlashBag
Implements
SymfonyComponentHttpFoundationSessionFlashFlashBagInterface

Tags

author

Drak drak@zikula.org

Properties

$name

$name : 

Type

Tags

None found

$flashes

$flashes : array

Flash messages.

Type

array

Tags

None found

$storageKey

$storageKey : string

The storage key for flashes in the session

Type

string

Tags

None found

Methods

__construct()

__construct(string  $storageKey = '_sf2_flashes') 

Constructor.

Parameters

string $storageKey

The key used to store flashes in the session.

Tags

None found

getName()

getName() 

{@inheritdoc}

Tags

None found

setName()

setName(  $name) 

Parameters

$name

Tags

None found

initialize()

initialize(array  $flashes) 

{@inheritdoc}

Parameters

array $flashes

Tags

None found

add()

add(string  $type, string  $message) 

Adds a flash message for type.

Parameters

string $type
string $message

Tags

None found

peek()

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

Gets flash messages for a given type.

Parameters

string $type

Message category type.

array $default

Default value if $type does not exist.

Returns

array

Tags

None found

peekAll()

peekAll() : array

Gets all flash messages.

Returns

array

Tags

None found

get()

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

Gets and clears flash from the stack.

Parameters

string $type
array $default

Default value if $type does not exist.

Returns

array

Tags

None found

all()

all() : array

Gets and clears flashes from the stack.

Returns

array

Tags

None found

setAll()

setAll(array  $messages) 

Sets all flash messages.

Parameters

array $messages

Tags

None found

set()

set(string  $type,   $messages) 

Registers a message for a given type.

Parameters

string $type
$messages

Tags

None found

has()

has(string  $type) : boolean

Has flash messages for a given type?

Parameters

string $type

Returns

boolean

Tags

None found

keys()

keys() : array

Returns a list of all defined types.

Returns

array

Tags

None found

getStorageKey()

getStorageKey() 

{@inheritdoc}

Tags

None found

clear()

clear() 

{@inheritdoc}

Tags

None found