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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpFoundation\Session\Attribute;
  14. /**
  15.  * This class relates to session attribute storage.
  16.  *
  17.  * @implements \IteratorAggregate<string, mixed>
  18.  */
  19. class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Countable
  20. {
  21.     private $name = 'attributes';
  22.     private $storageKey;
  24.     protected $attributes = [];
  26.     /**
  27.      * @param string $storageKey The key used to store attributes in the session
  28.      */
  29.     public function __construct(string $storageKey = '_sf2_attributes')
  30.     {
  31.         $this->storageKey = $storageKey;
  32.     }
  34.     /**
  35.      * {@inheritdoc}
  36.      */
  37.     public function getName()
  38.     {
  39.         return $this->name;
  40.     }
  42.     public function setName(string $name)
  43.     {
  44.         $this->name = $name;
  45.     }
  47.     /**
  48.      * {@inheritdoc}
  49.      */
  50.     public function initialize(array &$attributes)
  51.     {
  52.         $this->attributes = &$attributes;
  53.     }
  55.     /**
  56.      * {@inheritdoc}
  57.      */
  58.     public function getStorageKey()
  59.     {
  60.         return $this->storageKey;
  61.     }
  63.     /**
  64.      * {@inheritdoc}
  65.      */
  66.     public function has(string $name)
  67.     {
  68.         return \array_key_exists($name, $this->attributes);
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public function get(string $name, $default = null)
  75.     {
  76.         return \array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default;
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function set(string $name, $value)
  83.     {
  84.         $this->attributes[$name] = $value;
  85.     }
  87.     /**
  88.      * {@inheritdoc}
  89.      */
  90.     public function all()
  91.     {
  92.         return $this->attributes;
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function replace(array $attributes)
  99.     {
  100.         $this->attributes = [];
  101.         foreach ($attributes as $key => $value) {
  102.             $this->set($key, $value);
  103.         }
  104.     }
  106.     /**
  107.      * {@inheritdoc}
  108.      */
  109.     public function remove(string $name)
  110.     {
  111.         $retval = null;
  112.         if (\array_key_exists($name, $this->attributes)) {
  113.             $retval = $this->attributes[$name];
  114.             unset($this->attributes[$name]);
  115.         }
  117.         return $retval;
  118.     }
  120.     /**
  121.      * {@inheritdoc}
  122.      */
  123.     public function clear()
  124.     {
  125.         $return = $this->attributes;
  126.         $this->attributes = [];
  128.         return $return;
  129.     }
  131.     /**
  132.      * Returns an iterator for attributes.
  133.      *
  134.      * @return \ArrayIterator<string, mixed>
  135.      */
  136.     #[\ReturnTypeWillChange]
  137.     public function getIterator()
  138.     {
  139.         return new \ArrayIterator($this->attributes);
  140.     }
  142.     /**
  143.      * Returns the number of attributes.
  144.      *
  145.      * @return int
  146.      */
  147.     #[\ReturnTypeWillChange]
  148.     public function count()
  149.     {
  150.         return \count($this->attributes);
  151.     }
  152. }