Classes List

Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag

 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 
 150 
 151 
 152 
 153 
 154 
<?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 provides structured storage of session attributes using * a name spacing character in the key. * * @author Drak <drak@zikula.org> */
class NamespacedAttributeBag extends AttributeBag
{
    private $namespaceCharacter;

    /** * @param string $storageKey Session storage key * @param string $namespaceCharacter Namespace character to use in keys */
    public function __construct($storageKey = '_sf2_attributes'$namespaceCharacter = '/')
    {
        $this->namespaceCharacter = $namespaceCharacter;
        parent::__construct($storageKey);
    }

    /** * {@inheritdoc} */
    public function has($name)
    {
        // reference mismatch: if fixed, re-introduced in array_key_exists; keep as it is
        $attributes = $this->resolveAttributePath($name);
        $name = $this->resolveKey($name);

        if (null === $attributes) {
            return false;
        }

        return array_key_exists($name$attributes);
    }

    /** * {@inheritdoc} */
    public function get($name$default = null)
    {
        // reference mismatch: if fixed, re-introduced in array_key_exists; keep as it is
        $attributes = $this->resolveAttributePath($name);
        $name = $this->resolveKey($name);

        if (null === $attributes) {
            return $default;
        }

        return array_key_exists($name$attributes) ? $attributes[$name] : $default;
    }

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

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

        return $retval;
    }

    /** * Resolves a path in attributes property and returns it as a reference. * * This method allows structured namespacing of session attributes. * * @param string $name Key name * @param bool $writeContext Write context, default false * * @return array */
    protected function &resolveAttributePath($name$writeContext = false)
    {
        $array = &$this->attributes;
        $name = (0 === strpos($name$this->namespaceCharacter)) ? substr($name1) : $name;

        // Check if there is anything to do, else return
        if (!$name) {
            return $array;
        }

        $parts = explode($this->namespaceCharacter$name);
        if (count($parts) < 2) {
            if (!$writeContext) {
                return $array;
            }

            $array[$parts[0]] = array();

            return $array;
        }

        unset($parts[count($parts) - 1]);

        foreach ($parts as $part) {
            if (null !== $array && !array_key_exists($part$array)) {
                $array[$part] = $writeContext ? array() : null;
            }

            $array = &$array[$part];
        }

        return $array;
    }

    /** * Resolves the key from the name. * * This is the last part in a dot separated string. * * @param string $name * * @return string */
    protected function resolveKey($name)
    {
        if (false !== $pos = strrpos($name$this->namespaceCharacter)) {
            $name = substr($name$pos + 1);
        }

        return $name;
    }
}