class AttributeBag

This class relates to session attribute storage.

@implements \IteratorAggregate<string, mixed>

Hierarchy

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

Expanded class hierarchy of AttributeBag

1 file declares its use of AttributeBag

Session.php in vendor/symfony/http-foundation/Session/Session.php

File

vendor/symfony/http-foundation/Session/Attribute/AttributeBag.php, line 19

Namespace

Symfony\Component\HttpFoundation\Session\Attribute

View source

class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Countable {
    protected array $attributes = [];
    private string $name = 'attributes';
    
    /**
     * @param string $storageKey The key used to store attributes in the session
     */
    public function __construct(string $storageKey = '_sf2_attributes') {
    }
    public function getName() : string {
        return $this->name;
    }
    public function setName(string $name) : void {
        $this->name = $name;
    }
    public function initialize(array &$attributes) : void {
        $this->attributes =& $attributes;
    }
    public function getStorageKey() : string {
        return $this->storageKey;
    }
    public function has(string $name) : bool {
        return \array_key_exists($name, $this->attributes);
    }
    public function get(string $name, mixed $default = null) : mixed {
        return \array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default;
    }
    public function set(string $name, mixed $value) : void {
        $this->attributes[$name] = $value;
    }
    public function all() : array {
        return $this->attributes;
    }
    public function replace(array $attributes) : void {
        $this->attributes = [];
        foreach ($attributes as $key => $value) {
            $this->set($key, $value);
        }
    }
    public function remove(string $name) : mixed {
        $retval = null;
        if (\array_key_exists($name, $this->attributes)) {
            $retval = $this->attributes[$name];
            unset($this->attributes[$name]);
        }
        return $retval;
    }
    public function clear() : mixed {
        $return = $this->attributes;
        $this->attributes = [];
        return $return;
    }
    
    /**
     * Returns an iterator for attributes.
     *
     * @return \ArrayIterator<string, mixed>
     */
    public function getIterator() : \ArrayIterator {
        return new \ArrayIterator($this->attributes);
    }
    
    /**
     * Returns the number of attributes.
     */
    public function count() : int {
        return \count($this->attributes);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
AttributeBag::$attributes	protected	property
AttributeBag::$name	private	property
AttributeBag::all	public	function	Returns attributes.	Overrides AttributeBagInterface::all
AttributeBag::clear	public	function	Clears out data from bag.	Overrides SessionBagInterface::clear
AttributeBag::count	public	function	Returns the number of attributes.
AttributeBag::get	public	function	Returns an attribute.	Overrides AttributeBagInterface::get
AttributeBag::getIterator	public	function	Returns an iterator for attributes.
AttributeBag::getName	public	function	Gets this bag's name.	Overrides SessionBagInterface::getName
AttributeBag::getStorageKey	public	function	Gets the storage key for this bag.	Overrides SessionBagInterface::getStorageKey
AttributeBag::has	public	function	Checks if an attribute is defined.	Overrides AttributeBagInterface::has
AttributeBag::initialize	public	function	Initializes the Bag.	Overrides SessionBagInterface::initialize
AttributeBag::remove	public	function	Removes an attribute.	Overrides AttributeBagInterface::remove
AttributeBag::replace	public	function		Overrides AttributeBagInterface::replace
AttributeBag::set	public	function	Sets an attribute.	Overrides AttributeBagInterface::set
AttributeBag::setName	public	function
AttributeBag::__construct	public	function