Classes List

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\HttpFoundation\Session\Attribute;

/** * This class relates to session attribute storage. */
class AttributeBag implements AttributeBagInterface\IteratorAggregate\Countable
{
    private $name = 'attributes';
    private $storageKey;

    protected $attributes = array();

    /** * @param string $storageKey The key used to store attributes in the session */
    public function __construct($storageKey = '_sf2_attributes')
    {
        $this->storageKey = $storageKey;
    }

    /** * {@inheritdoc} */
    public function getName()
    {
        return $this->name;
    }

    public function setName($name)
    {
        $this->name = $name;
    }

    /** * {@inheritdoc} */
    public function initialize(array &$attributes)
    {
        $this->attributes = &$attributes;
    }

    /** * {@inheritdoc} */
    public function getStorageKey()
    {
        return $this->storageKey;
    }

    /** * {@inheritdoc} */
    public function has($name)
    {
        return array_key_exists($name$this->attributes);
    }

    /** * {@inheritdoc} */
    public function get($name$default = null)
    {
        return array_key_exists($name$this->attributes) ? $this->attributes[$name] : $default;
    }

    /** * {@inheritdoc} */
    public function set($name$value)
    {
        $this->attributes[$name] = $value;
    }

    /** * {@inheritdoc} */
    public function all()
    {
        return $this->attributes;
    }

    /** * {@inheritdoc} */
    public function replace(array $attributes)
    {
        $this->attributes = array();
        foreach ($attributes as $key => $value) {
            $this->set($key$value);
        }
    }

    /** * {@inheritdoc} */
    public function remove($name)
    {
        $retval = null;
        if (array_key_exists($name$this->attributes)) {
            $retval = $this->attributes[$name];
            unset($this->attributes[$name]);
        }

        return $retval;
    }

    /** * {@inheritdoc} */
    public function clear()
    {
        $return = $this->attributes;
        $this->attributes = array();

        return $return;
    }

    /** * Returns an iterator for attributes. * * @return \ArrayIterator An \ArrayIterator instance */
    public function getIterator()
    {
        return new \ArrayIterator($this->attributes);
    }

    /** * Returns the number of attributes. * * @return int The number of attributes */
    public function count()
    {
        return count($this->attributes);
    }
}