Class AttributeBag

This class relates to session attribute storage.

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag implements Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface, IteratorAggregate, Countable

Direct known subclasses

Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag

Namespace: Symfony\Component\HttpFoundation\Session\Attribute
Located at Session/Attribute/AttributeBag.php

Methods summary
`public`	# `__construct( string $storageKey = '_sf2_attributes' )` Constructor. Constructor. Parameters `$storageKey` The key used to store attributes in the session
`public string`	# `getName( )` Gets this bag's name. Gets this bag's name. Returns string Implementation of `Symfony\Component\HttpFoundation\Session\SessionBagInterface::getName()`
`public`	# `setName( $name )`
`public`	# `initialize( array & $attributes )` Initializes the Bag. Initializes the Bag. Parameters `$attributes` $array Implementation of `Symfony\Component\HttpFoundation\Session\SessionBagInterface::initialize()`
`public string`	# `getStorageKey( )` Gets the storage key for this bag. Gets the storage key for this bag. Returns string Implementation of `Symfony\Component\HttpFoundation\Session\SessionBagInterface::getStorageKey()`
`public boolean`	# `has( string $name )` Checks if an attribute is defined. Checks if an attribute is defined. Parameters `$name` The attribute name Returns boolean true if the attribute is defined, false otherwise Implementation of `Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::has()`
`public mixed`	# `get( string $name, mixed $default = null )` Returns an attribute. Returns an attribute. Parameters `$name` The attribute name `$default` The default value if not found Returns mixed Implementation of `Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::get()`
`public`	# `set( string $name, mixed $value )` Sets an attribute. Sets an attribute. Parameters `$name` `$value` Implementation of `Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::set()`
`public array`	# `all( )` Returns attributes. Returns attributes. Returns array Attributes Implementation of `Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::all()`
`public`	# `replace( array $attributes )` Sets attributes. Sets attributes. Parameters `$attributes` Attributes Implementation of `Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::replace()`
`public mixed`	# `remove( string $name )` Removes an attribute. Removes an attribute. Parameters `$name` Returns mixed The removed value or null when it does not exist Implementation of `Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::remove()`
`public mixed`	# `clear( )` Clears out data from bag. Clears out data from bag. Returns mixed Whatever data was contained. Implementation of `Symfony\Component\HttpFoundation\Session\SessionBagInterface::clear()`
`public ArrayIterator`	# `getIterator( )` Returns an iterator for attributes. Returns an iterator for attributes. Returns `ArrayIterator` An \ArrayIterator instance Implementation of `IteratorAggregate::getIterator()`
`public integer`	# `count( )` Returns the number of attributes. Returns the number of attributes. Returns integer The number of attributes Implementation of `Countable::count()`

Properties summary
`protected array`	`$attributes`	# `array()`