vendor/symfony/config/Definition/VariableNode.php line 51

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\Config\Definition;
  14. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  16. /**
  17.  * This node represents a value of variable type in the config tree.
  18.  *
  19.  * This node is intended for values of arbitrary type.
  20.  * Any PHP type is accepted as a value.
  21.  *
  22.  * @author Jeremy Mikola <jmikola@gmail.com>
  23.  */
  24. class VariableNode extends BaseNode implements PrototypeNodeInterface
  25. {
  26.     protected $defaultValueSet = false;
  27.     protected $defaultValue;
  28.     protected $allowEmptyValue = true;
  30.     public function setDefaultValue($value)
  31.     {
  32.         $this->defaultValueSet = true;
  33.         $this->defaultValue = $value;
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function hasDefaultValue()
  40.     {
  41.         return $this->defaultValueSet;
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function getDefaultValue()
  48.     {
  49.         $v = $this->defaultValue;
  51.         return $v instanceof \Closure ? $v() : $v;
  52.     }
  54.     /**
  55.      * Sets if this node is allowed to have an empty value.
  56.      *
  57.      * @param bool $boolean True if this entity will accept empty values
  58.      */
  59.     public function setAllowEmptyValue(bool $boolean)
  60.     {
  61.         $this->allowEmptyValue = $boolean;
  62.     }
  64.     /**
  65.      * {@inheritdoc}
  66.      */
  67.     public function setName(string $name)
  68.     {
  69.         $this->name = $name;
  70.     }
  72.     /**
  73.      * {@inheritdoc}
  74.      */
  75.     protected function validateType($value)
  76.     {
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     protected function finalizeValue($value)
  83.     {
  84.         // deny environment variables only when using custom validators
  85.         // this avoids ever passing an empty value to final validation closures
  86.         if (!$this->allowEmptyValue && $this->isHandlingPlaceholder() && $this->finalValidationClosures) {
  87.             $e = new InvalidConfigurationException(sprintf('The path "%s" cannot contain an environment variable when empty values are not allowed by definition and are validated.', $this->getPath()));
  88.             if ($hint = $this->getInfo()) {
  89.                 $e->addHint($hint);
  90.             }
  91.             $e->setPath($this->getPath());
  93.             throw $e;
  94.         }
  96.         if (!$this->allowEmptyValue && $this->isValueEmpty($value)) {
  97.             $ex = new InvalidConfigurationException(sprintf('The path "%s" cannot contain an empty value, but got %s.', $this->getPath(), json_encode($value)));
  98.             if ($hint = $this->getInfo()) {
  99.                 $ex->addHint($hint);
  100.             }
  101.             $ex->setPath($this->getPath());
  103.             throw $ex;
  104.         }
  106.         return $value;
  107.     }
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     protected function normalizeValue($value)
  113.     {
  114.         return $value;
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     protected function mergeValues($leftSide, $rightSide)
  121.     {
  122.         return $rightSide;
  123.     }
  125.     /**
  126.      * Evaluates if the given value is to be treated as empty.
  127.      *
  128.      * By default, PHP's empty() function is used to test for emptiness. This
  129.      * method may be overridden by subtypes to better match their understanding
  130.      * of empty data.
  131.      *
  132.      * @param mixed $value
  133.      *
  134.      * @return bool
  135.      *
  136.      * @see finalizeValue()
  137.      */
  138.     protected function isValueEmpty($value)
  139.     {
  140.         return empty($value);
  141.     }
  142. }