vendor/symfony/config/Definition/ArrayNode.php line 234

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;
  15. use Symfony\Component\Config\Definition\Exception\InvalidTypeException;
  16. use Symfony\Component\Config\Definition\Exception\UnsetKeyException;
  18. /**
  19.  * Represents an Array node in the config tree.
  20.  *
  21.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  22.  */
  23. class ArrayNode extends BaseNode implements PrototypeNodeInterface
  24. {
  25.     protected $xmlRemappings = [];
  26.     protected $children = [];
  27.     protected $allowFalse = false;
  28.     protected $allowNewKeys = true;
  29.     protected $addIfNotSet = false;
  30.     protected $performDeepMerging = true;
  31.     protected $ignoreExtraKeys = false;
  32.     protected $removeExtraKeys = true;
  33.     protected $normalizeKeys = true;
  35.     public function setNormalizeKeys($normalizeKeys)
  36.     {
  37.         $this->normalizeKeys = (bool) $normalizeKeys;
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      *
  43.      * Namely, you mostly have foo_bar in YAML while you have foo-bar in XML.
  44.      * After running this method, all keys are normalized to foo_bar.
  45.      *
  46.      * If you have a mixed key like foo-bar_moo, it will not be altered.
  47.      * The key will also not be altered if the target key already exists.
  48.      */
  49.     protected function preNormalize($value)
  50.     {
  51.         if (!$this->normalizeKeys || !\is_array($value)) {
  52.             return $value;
  53.         }
  55.         $normalized = [];
  57.         foreach ($value as $k => $v) {
  58.             if (str_contains($k, '-') && !str_contains($k, '_') && !\array_key_exists($normalizedKey = str_replace('-', '_', $k), $value)) {
  59.                 $normalized[$normalizedKey] = $v;
  60.             } else {
  61.                 $normalized[$k] = $v;
  62.             }
  63.         }
  65.         return $normalized;
  66.     }
  68.     /**
  69.      * Retrieves the children of this node.
  70.      *
  71.      * @return array<string, NodeInterface>
  72.      */
  73.     public function getChildren()
  74.     {
  75.         return $this->children;
  76.     }
  78.     /**
  79.      * Sets the xml remappings that should be performed.
  80.      *
  81.      * @param array $remappings An array of the form [[string, string]]
  82.      */
  83.     public function setXmlRemappings(array $remappings)
  84.     {
  85.         $this->xmlRemappings = $remappings;
  86.     }
  88.     /**
  89.      * Gets the xml remappings that should be performed.
  90.      *
  91.      * @return array an array of the form [[string, string]]
  92.      */
  93.     public function getXmlRemappings()
  94.     {
  95.         return $this->xmlRemappings;
  96.     }
  98.     /**
  99.      * Sets whether to add default values for this array if it has not been
  100.      * defined in any of the configuration files.
  101.      *
  102.      * @param bool $boolean
  103.      */
  104.     public function setAddIfNotSet($boolean)
  105.     {
  106.         $this->addIfNotSet = (bool) $boolean;
  107.     }
  109.     /**
  110.      * Sets whether false is allowed as value indicating that the array should be unset.
  111.      *
  112.      * @param bool $allow
  113.      */
  114.     public function setAllowFalse($allow)
  115.     {
  116.         $this->allowFalse = (bool) $allow;
  117.     }
  119.     /**
  120.      * Sets whether new keys can be defined in subsequent configurations.
  121.      *
  122.      * @param bool $allow
  123.      */
  124.     public function setAllowNewKeys($allow)
  125.     {
  126.         $this->allowNewKeys = (bool) $allow;
  127.     }
  129.     /**
  130.      * Sets if deep merging should occur.
  131.      *
  132.      * @param bool $boolean
  133.      */
  134.     public function setPerformDeepMerging($boolean)
  135.     {
  136.         $this->performDeepMerging = (bool) $boolean;
  137.     }
  139.     /**
  140.      * Whether extra keys should just be ignored without an exception.
  141.      *
  142.      * @param bool $boolean To allow extra keys
  143.      * @param bool $remove  To remove extra keys
  144.      */
  145.     public function setIgnoreExtraKeys($boolean, $remove = true)
  146.     {
  147.         $this->ignoreExtraKeys = (bool) $boolean;
  148.         $this->removeExtraKeys = $this->ignoreExtraKeys && $remove;
  149.     }
  151.     /**
  152.      * {@inheritdoc}
  153.      */
  154.     public function setName($name)
  155.     {
  156.         $this->name = $name;
  157.     }
  159.     /**
  160.      * {@inheritdoc}
  161.      */
  162.     public function hasDefaultValue()
  163.     {
  164.         return $this->addIfNotSet;
  165.     }
  167.     /**
  168.      * {@inheritdoc}
  169.      */
  170.     public function getDefaultValue()
  171.     {
  172.         if (!$this->hasDefaultValue()) {
  173.             throw new \RuntimeException(sprintf('The node at path "%s" has no default value.', $this->getPath()));
  174.         }
  176.         $defaults = [];
  177.         foreach ($this->children as $name => $child) {
  178.             if ($child->hasDefaultValue()) {
  179.                 $defaults[$name] = $child->getDefaultValue();
  180.             }
  181.         }
  183.         return $defaults;
  184.     }
  186.     /**
  187.      * Adds a child node.
  188.      *
  189.      * @throws \InvalidArgumentException when the child node has no name
  190.      * @throws \InvalidArgumentException when the child node's name is not unique
  191.      */
  192.     public function addChild(NodeInterface $node)
  193.     {
  194.         $name = $node->getName();
  195.         if ('' === $name) {
  196.             throw new \InvalidArgumentException('Child nodes must be named.');
  197.         }
  198.         if (isset($this->children[$name])) {
  199.             throw new \InvalidArgumentException(sprintf('A child node named "%s" already exists.', $name));
  200.         }
  202.         $this->children[$name] = $node;
  203.     }
  205.     /**
  206.      * {@inheritdoc}
  207.      *
  208.      * @throws UnsetKeyException
  209.      * @throws InvalidConfigurationException if the node doesn't have enough children
  210.      */
  211.     protected function finalizeValue($value)
  212.     {
  213.         if (false === $value) {
  214.             throw new UnsetKeyException(sprintf('Unsetting key for path "%s", value: "%s".', $this->getPath(), json_encode($value)));
  215.         }
  217.         foreach ($this->children as $name => $child) {
  218.             if (!\array_key_exists($name, $value)) {
  219.                 if ($child->isRequired()) {
  220.                     $ex = new InvalidConfigurationException(sprintf('The child node "%s" at path "%s" must be configured.', $name, $this->getPath()));
  221.                     $ex->setPath($this->getPath());
  223.                     throw $ex;
  224.                 }
  226.                 if ($child->hasDefaultValue()) {
  227.                     $value[$name] = $child->getDefaultValue();
  228.                 }
  230.                 continue;
  231.             }
  233.             if ($child->isDeprecated()) {
  234.                 @trigger_error($child->getDeprecationMessage($name, $this->getPath()), \E_USER_DEPRECATED);
  235.             }
  237.             try {
  238.                 $value[$name] = $child->finalize($value[$name]);
  239.             } catch (UnsetKeyException $e) {
  240.                 unset($value[$name]);
  241.             }
  242.         }
  244.         return $value;
  245.     }
  247.     /**
  248.      * {@inheritdoc}
  249.      */
  250.     protected function validateType($value)
  251.     {
  252.         if (!\is_array($value) && (!$this->allowFalse || false !== $value)) {
  253.             $ex = new InvalidTypeException(sprintf('Invalid type for path "%s". Expected array, but got %s', $this->getPath(), \gettype($value)));
  254.             if ($hint = $this->getInfo()) {
  255.                 $ex->addHint($hint);
  256.             }
  257.             $ex->setPath($this->getPath());
  259.             throw $ex;
  260.         }
  261.     }
  263.     /**
  264.      * {@inheritdoc}
  265.      *
  266.      * @throws InvalidConfigurationException
  267.      */
  268.     protected function normalizeValue($value)
  269.     {
  270.         if (false === $value) {
  271.             return $value;
  272.         }
  274.         $value = $this->remapXml($value);
  276.         $normalized = [];
  277.         foreach ($value as $name => $val) {
  278.             if (isset($this->children[$name])) {
  279.                 try {
  280.                     $normalized[$name] = $this->children[$name]->normalize($val);
  281.                 } catch (UnsetKeyException $e) {
  282.                 }
  283.                 unset($value[$name]);
  284.             } elseif (!$this->removeExtraKeys) {
  285.                 $normalized[$name] = $val;
  286.             }
  287.         }
  289.         // if extra fields are present, throw exception
  290.         if (\count($value) && !$this->ignoreExtraKeys) {
  291.             $proposals = array_keys($this->children);
  292.             sort($proposals);
  293.             $guesses = [];
  295.             foreach (array_keys($value) as $subject) {
  296.                 $minScore = \INF;
  297.                 foreach ($proposals as $proposal) {
  298.                     $distance = levenshtein($subject, $proposal);
  299.                     if ($distance <= $minScore && $distance < 3) {
  300.                         $guesses[$proposal] = $distance;
  301.                         $minScore = $distance;
  302.                     }
  303.                 }
  304.             }
  306.             $msg = sprintf('Unrecognized option%s "%s" under "%s"', 1 === \count($value) ? '' : 's', implode(', ', array_keys($value)), $this->getPath());
  308.             if (\count($guesses)) {
  309.                 asort($guesses);
  310.                 $msg .= sprintf('. Did you mean "%s"?', implode('", "', array_keys($guesses)));
  311.             } else {
  312.                 $msg .= sprintf('. Available option%s %s "%s".', 1 === \count($proposals) ? '' : 's', 1 === \count($proposals) ? 'is' : 'are', implode('", "', $proposals));
  313.             }
  315.             $ex = new InvalidConfigurationException($msg);
  316.             $ex->setPath($this->getPath());
  318.             throw $ex;
  319.         }
  321.         return $normalized;
  322.     }
  324.     /**
  325.      * Remaps multiple singular values to a single plural value.
  326.      *
  327.      * @param array $value The source values
  328.      *
  329.      * @return array The remapped values
  330.      */
  331.     protected function remapXml($value)
  332.     {
  333.         foreach ($this->xmlRemappings as [$singular, $plural]) {
  334.             if (!isset($value[$singular])) {
  335.                 continue;
  336.             }
  338.             $value[$plural] = Processor::normalizeConfig($value, $singular, $plural);
  339.             unset($value[$singular]);
  340.         }
  342.         return $value;
  343.     }
  345.     /**
  346.      * {@inheritdoc}
  347.      *
  348.      * @throws InvalidConfigurationException
  349.      * @throws \RuntimeException
  350.      */
  351.     protected function mergeValues($leftSide, $rightSide)
  352.     {
  353.         if (false === $rightSide) {
  354.             // if this is still false after the last config has been merged the
  355.             // finalization pass will take care of removing this key entirely
  356.             return false;
  357.         }
  359.         if (false === $leftSide || !$this->performDeepMerging) {
  360.             return $rightSide;
  361.         }
  363.         foreach ($rightSide as $k => $v) {
  364.             // no conflict
  365.             if (!\array_key_exists($k, $leftSide)) {
  366.                 if (!$this->allowNewKeys) {
  367.                     $ex = new InvalidConfigurationException(sprintf('You are not allowed to define new elements for path "%s". Please define all elements for this path in one config file. If you are trying to overwrite an element, make sure you redefine it with the same name.', $this->getPath()));
  368.                     $ex->setPath($this->getPath());
  370.                     throw $ex;
  371.                 }
  373.                 $leftSide[$k] = $v;
  374.                 continue;
  375.             }
  377.             if (!isset($this->children[$k])) {
  378.                 if (!$this->ignoreExtraKeys || $this->removeExtraKeys) {
  379.                     throw new \RuntimeException('merge() expects a normalized config array.');
  380.                 }
  382.                 $leftSide[$k] = $v;
  383.                 continue;
  384.             }
  386.             $leftSide[$k] = $this->children[$k]->merge($leftSide[$k], $v);
  387.         }
  389.         return $leftSide;
  390.     }
  392.     /**
  393.      * {@inheritdoc}
  394.      */
  395.     protected function allowPlaceholders(): bool
  396.     {
  397.         return false;
  398.     }
  399. }