1: <?php
  2: 
  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:  */
 11: 
 12: namespace Symfony\Component\HttpFoundation\Session\Attribute;
 13: 
 14: /**
 15:  * This class provides structured storage of session attributes using
 16:  * a name spacing character in the key.
 17:  *
 18:  * @author Drak <drak@zikula.org>
 19:  */
 20: class NamespacedAttributeBag extends AttributeBag
 21: {
 22:     /**
 23:      * Namespace character.
 24:      *
 25:      * @var string
 26:      */
 27:     private $namespaceCharacter;
 28: 
 29:     /**
 30:      * Constructor.
 31:      *
 32:      * @param string $storageKey         Session storage key.
 33:      * @param string $namespaceCharacter Namespace character to use in keys.
 34:      */
 35:     public function __construct($storageKey = '_sf2_attributes', $namespaceCharacter = '/')
 36:     {
 37:         $this->namespaceCharacter = $namespaceCharacter;
 38:         parent::__construct($storageKey);
 39:     }
 40: 
 41:     /**
 42:      * {@inheritdoc}
 43:      */
 44:     public function has($name)
 45:     {
 46:         $attributes = $this->resolveAttributePath($name);
 47:         $name = $this->resolveKey($name);
 48: 
 49:         return array_key_exists($name, $attributes);
 50:     }
 51: 
 52:     /**
 53:      * {@inheritdoc}
 54:      */
 55:     public function get($name, $default = null)
 56:     {
 57:         $attributes = $this->resolveAttributePath($name);
 58:         $name = $this->resolveKey($name);
 59: 
 60:         return array_key_exists($name, $attributes) ? $attributes[$name] : $default;
 61:     }
 62: 
 63:     /**
 64:      * {@inheritdoc}
 65:      */
 66:     public function set($name, $value)
 67:     {
 68:         $attributes = & $this->resolveAttributePath($name, true);
 69:         $name = $this->resolveKey($name);
 70:         $attributes[$name] = $value;
 71:     }
 72: 
 73:     /**
 74:      * {@inheritdoc}
 75:      */
 76:     public function remove($name)
 77:     {
 78:         $retval = null;
 79:         $attributes = & $this->resolveAttributePath($name);
 80:         $name = $this->resolveKey($name);
 81:         if (array_key_exists($name, $attributes)) {
 82:             $retval = $attributes[$name];
 83:             unset($attributes[$name]);
 84:         }
 85: 
 86:         return $retval;
 87:     }
 88: 
 89:     /**
 90:      * Resolves a path in attributes property and returns it as a reference.
 91:      *
 92:      * This method allows structured namespacing of session attributes.
 93:      *
 94:      * @param string  $name         Key name
 95:      * @param boolean $writeContext Write context, default false
 96:      *
 97:      * @return array
 98:      */
 99:     protected function &resolveAttributePath($name, $writeContext = false)
100:     {
101:         $array = & $this->attributes;
102:         $name = (strpos($name, $this->namespaceCharacter) === 0) ? substr($name, 1) : $name;
103: 
104:         // Check if there is anything to do, else return
105:         if (!$name) {
106:             return $array;
107:         }
108: 
109:         $parts = explode($this->namespaceCharacter, $name);
110:         if (count($parts) < 2) {
111:             if (!$writeContext) {
112:                 return $array;
113:             }
114: 
115:             $array[$parts[0]] = array();
116: 
117:             return $array;
118:         }
119: 
120:         unset($parts[count($parts)-1]);
121: 
122:         foreach ($parts as $part) {
123:             if (!array_key_exists($part, $array)) {
124:                 if (!$writeContext) {
125:                     return $array;
126:                 }
127: 
128:                 $array[$part] = array();
129:             }
130: 
131:             $array = & $array[$part];
132:         }
133: 
134:         return $array;
135:     }
136: 
137:     /**
138:      * Resolves the key from the name.
139:      *
140:      * This is the last part in a dot separated string.
141:      *
142:      * @param string $name
143:      *
144:      * @return string
145:      */
146:     protected function resolveKey($name)
147:     {
148:         if (strpos($name, $this->namespaceCharacter) !== false) {
149:             $name = substr($name, strrpos($name, $this->namespaceCharacter)+1, strlen($name));
150:         }
151: 
152:         return $name;
153:     }
154: }
155: