1. class
  2. Symfony
  3. Component
  4. HttpFoundation
  5. Session
  6. Attribute
  7. AttributeBag

AttributeBag

class AttributeBag implements AttributeBagInterface, IteratorAggregate, Countable

This class relates to session attribute storage.

Methods

__construct(string $storageKey = '_sf2_attributes')

Constructor.

string
getName()

Gets this bag's name.

setName($name)

No description

initialize(array $attributes)

Initializes the Bag.

string
getStorageKey()

Gets the storage key for this bag.

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.

mixed
clear()

Clears out data from bag.

ArrayIterator
getIterator()

Returns an iterator for attributes.

int
count()

Returns the number of attributes.

Details

at line line 36
__construct(string $storageKey = '_sf2_attributes')

Constructor.

Parameters

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

at line line 44
string getName()

Gets this bag's name.

Return Value

string

at line line 49
setName($name)

Parameters

$name

at line line 57
initialize(array $attributes)

Initializes the Bag.

Parameters

array $attributes

at line line 65
string getStorageKey()

Gets the storage key for this bag.

Return Value

string

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

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

at line line 89
set(string $name, mixed $value)

Sets an attribute.

Parameters

string $name
mixed $value

at line line 97
array all()

Returns attributes.

Return Value

array Attributes

at line line 105
replace(array $attributes)

Sets attributes.

Parameters

array $attributes Attributes

at line line 116
mixed remove(string $name)

Removes an attribute.

Parameters

string $name

Return Value

mixed The removed value or null when it does not exist

at line line 130
mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained.

at line line 143
ArrayIterator getIterator()

Returns an iterator for attributes.

Return Value

ArrayIterator An \ArrayIterator instance

at line line 153
int count()

Returns the number of attributes.

Return Value

int The number of attributes