Classes List

Symfony\Component\Config\Definition\BaseNode

 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 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
 294 
 295 
 296 
 297 
 298 
 299 
 300 
 301 
 302 
 303 
 304 
 305 
 306 
 307 
 308 
 309 
 310 
 311 
 312 
 313 
 314 
 315 
 316 
 317 
 318 
 319 
 320 
 321 
 322 
 323 
 324 
 325 
 326 
 327 
 328 
 329 
 330 
 331 
 332 
 333 
 334 
 335 
 336 
 337 
 338 
 339 
 340 
 341 
 342 
 343 
 344 
 345 
 346 
 347 
 348 
 349 
 350 
 351 
 352 
 353 
 354 
 355 
 356 
 357 
 358 
 359 
 360 
 361 
 362 
 363 
 364 
 365 
 366 
 367 
 368 
<?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\Config\Definition;

use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Exception\InvalidTypeException;

/** * The base node class. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */
abstract class BaseNode implements NodeInterface
{
    protected $name;
    protected $parent;
    protected $normalizationClosures = array();
    protected $finalValidationClosures = array();
    protected $allowOverwrite = true;
    protected $required = false;
    protected $deprecationMessage = null;
    protected $equivalentValues = array();
    protected $attributes = array();

    /** * @param string|null $name The name of the node * @param NodeInterface|null $parent The parent of this node * * @throws \InvalidArgumentException if the name contains a period */
    public function __construct($nameNodeInterface $parent = null)
    {
        if (false !== strpos($name = (string) $name'.')) {
            throw new \InvalidArgumentException('The name must not contain ".".');
        }

        $this->name = $name;
        $this->parent = $parent;
    }

    public function setAttribute($key$value)
    {
        $this->attributes[$key] = $value;
    }

    public function getAttribute($key$default = null)
    {
        return isset($this->attributes[$key]) ? $this->attributes[$key] : $default;
    }

    public function hasAttribute($key)
    {
        return isset($this->attributes[$key]);
    }

    public function getAttributes()
    {
        return $this->attributes;
    }

    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;
    }

    public function removeAttribute($key)
    {
        unset($this->attributes[$key]);
    }

    /** * Sets an info message. * * @param string $info */
    public function setInfo($info)
    {
        $this->setAttribute('info'$info);
    }

    /** * Returns info message. * * @return string The info text */
    public function getInfo()
    {
        return $this->getAttribute('info');
    }

    /** * Sets the example configuration for this node. * * @param string|array $example */
    public function setExample($example)
    {
        $this->setAttribute('example'$example);
    }

    /** * Retrieves the example configuration for this node. * * @return string|array The example */
    public function getExample()
    {
        return $this->getAttribute('example');
    }

    /** * Adds an equivalent value. * * @param mixed $originalValue * @param mixed $equivalentValue */
    public function addEquivalentValue($originalValue$equivalentValue)
    {
        $this->equivalentValues[] = array($originalValue$equivalentValue);
    }

    /** * Set this node as required. * * @param bool $boolean Required node */
    public function setRequired($boolean)
    {
        $this->required = (bool) $boolean;
    }

    /** * Sets this node as deprecated. * * You can use %node% and %path% placeholders in your message to display, * respectively, the node name and its complete path. * * @param string|null $message Deprecated message */
    public function setDeprecated($message)
    {
        $this->deprecationMessage = $message;
    }

    /** * Sets if this node can be overridden. * * @param bool $allow */
    public function setAllowOverwrite($allow)
    {
        $this->allowOverwrite = (bool) $allow;
    }

    /** * Sets the closures used for normalization. * * @param \Closure[] $closures An array of Closures used for normalization */
    public function setNormalizationClosures(array $closures)
    {
        $this->normalizationClosures = $closures;
    }

    /** * Sets the closures used for final validation. * * @param \Closure[] $closures An array of Closures used for final validation */
    public function setFinalValidationClosures(array $closures)
    {
        $this->finalValidationClosures = $closures;
    }

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

    /** * Checks if this node is deprecated. * * @return bool */
    public function isDeprecated()
    {
        return null !== $this->deprecationMessage;
    }

    /** * Returns the deprecated message. * * @param string $node the configuration node name * @param string $path the path of the node * * @return string */
    public function getDeprecationMessage($node$path)
    {
        return strtr($this->deprecationMessagearray('%node%' => $node'%path%' => $path));
    }

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

    /** * {@inheritdoc} */
    public function getPath()
    {
        $path = $this->name;

        if (null !== $this->parent) {
            $path = $this->parent->getPath().'.'.$path;
        }

        return $path;
    }

    /** * {@inheritdoc} */
    final public function merge($leftSide$rightSide)
    {
        if (!$this->allowOverwrite) {
            throw new ForbiddenOverwriteException(sprintf(
                'Configuration path "%s" cannot be overwritten. You have to '
               .'define all options for this path, and any of its sub-paths in '
               .'one configuration section.',
                $this->getPath()
            ));
        }

        $this->validateType($leftSide);
        $this->validateType($rightSide);

        return $this->mergeValues($leftSide$rightSide);
    }

    /** * {@inheritdoc} */
    final public function normalize($value)
    {
        $value = $this->preNormalize($value);

        // run custom normalization closures
        foreach ($this->normalizationClosures as $closure) {
            $value = $closure($value);
        }

        // replace value with their equivalent
        foreach ($this->equivalentValues as $data) {
            if ($data[0=== $value) {
                $value = $data[1];
            }
        }

        // validate type
        $this->validateType($value);

        // normalize value
        return $this->normalizeValue($value);
    }

    /** * Normalizes the value before any other normalization is applied. * * @param $value * * @return $value The normalized array value */
    protected function preNormalize($value)
    {
        return $value;
    }

    /** * Returns parent node for this node. * * @return NodeInterface|null */
    public function getParent()
    {
        return $this->parent;
    }

    /** * {@inheritdoc} */
    final public function finalize($value)
    {
        $this->validateType($value);

        $value = $this->finalizeValue($value);

        // Perform validation on the final value if a closure has been set.
        // The closure is also allowed to return another value.
        foreach ($this->finalValidationClosures as $closure) {
            try {
                $value = $closure($value);
            } catch (Exception $e) {
                throw $e;
            } catch (\Exception $e) {
                throw new InvalidConfigurationException(sprintf('Invalid configuration for path "%s": %s'$this->getPath(), $e->getMessage()), $e->getCode(), $e);
            }
        }

        return $value;
    }

    /** * Validates the type of a Node. * * @param mixed $value The value to validate * * @throws InvalidTypeException when the value is invalid */
    abstract protected function validateType($value);

    /** * Normalizes the value. * * @param mixed $value The value to normalize * * @return mixed The normalized value */
    abstract protected function normalizeValue($value);

    /** * Merges two values together. * * @param mixed $leftSide * @param mixed $rightSide * * @return mixed The merged value */
    abstract protected function mergeValues($leftSide$rightSide);

    /** * Finalizes a value. * * @param mixed $value The value to finalize * * @return mixed The finalized value */
    abstract protected function finalizeValue($value);
}