AttributeBagInterface

interface AttributeBagInterface implements SessionBagInterface

Attributes store.

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
bool	has(string $name) Checks if an attribute is defined.
mixed	get(string $name, mixed $default = null) Returns an attribute.
	set(string $name, mixed $value) Sets an attribute.
array	all() Returns attributes.
	replace(array $attributes) Sets attributes.
mixed	remove(string $name) Removes an attribute.

Details

string getName()

Gets this bag's name.

Return Value

string

initialize(array $array)

Initializes the Bag.

Parameters

array

$array

string getStorageKey()

Gets the storage key for this bag.

Return Value

string

mixed clear()

Clears out data from bag.

Return Value

mixed

Whatever data was contained.

bool has(string $name)

Checks if an attribute is defined.

Parameters

string

$name

The attribute name

Return Value

bool	true if the attribute is defined, false otherwise

mixed get(string $name, mixed $default = null)

Returns an attribute.

Parameters

string	$name	The attribute name
mixed	$default	The default value if not found

Return Value

mixed

set(string $name, mixed $value)

Sets an attribute.

Parameters

string	$name
mixed	$value

array all()

Returns attributes.

Return Value

array

Attributes

replace(array $attributes)

Sets attributes.

Parameters

array

$attributes

Attributes

mixed remove(string $name)

Removes an attribute.

Parameters

string

$name

Return Value

mixed

The removed value or null when it does not exist

Links:

http://api.symfony.com/master/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBagInterface.html

doc_Symfony

2016-10-28 06:06:13

Comments