123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325 |
- <?php
- 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;
- abstract class BaseNode implements NodeInterface
- {
- protected $name;
- protected $parent;
- protected $normalizationClosures = array();
- protected $finalValidationClosures = array();
- protected $allowOverwrite = true;
- protected $required = false;
- protected $equivalentValues = array();
- protected $attributes = array();
-
- public function __construct($name, NodeInterface $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]);
- }
-
- public function setInfo($info)
- {
- $this->setAttribute('info', $info);
- }
-
- public function getInfo()
- {
- return $this->getAttribute('info');
- }
-
- public function setExample($example)
- {
- $this->setAttribute('example', $example);
- }
-
- public function getExample()
- {
- return $this->getAttribute('example');
- }
-
- public function addEquivalentValue($originalValue, $equivalentValue)
- {
- $this->equivalentValues[] = array($originalValue, $equivalentValue);
- }
-
- public function setRequired($boolean)
- {
- $this->required = (bool) $boolean;
- }
-
- public function setAllowOverwrite($allow)
- {
- $this->allowOverwrite = (bool) $allow;
- }
-
- public function setNormalizationClosures(array $closures)
- {
- $this->normalizationClosures = $closures;
- }
-
- public function setFinalValidationClosures(array $closures)
- {
- $this->finalValidationClosures = $closures;
- }
-
- public function isRequired()
- {
- return $this->required;
- }
-
- public function getName()
- {
- return $this->name;
- }
-
- public function getPath()
- {
- $path = $this->name;
- if (null !== $this->parent) {
- $path = $this->parent->getPath().'.'.$path;
- }
- return $path;
- }
-
- 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);
- }
-
- final public function normalize($value)
- {
- $value = $this->preNormalize($value);
-
- foreach ($this->normalizationClosures as $closure) {
- $value = $closure($value);
- }
-
- foreach ($this->equivalentValues as $data) {
- if ($data[0] === $value) {
- $value = $data[1];
- }
- }
-
- $this->validateType($value);
-
- return $this->normalizeValue($value);
- }
-
- protected function preNormalize($value)
- {
- return $value;
- }
-
- public function getParent()
- {
- return $this->parent;
- }
-
- final public function finalize($value)
- {
- $this->validateType($value);
- $value = $this->finalizeValue($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;
- }
-
- abstract protected function validateType($value);
-
- abstract protected function normalizeValue($value);
-
- abstract protected function mergeValues($leftSide, $rightSide);
-
- abstract protected function finalizeValue($value);
- }
|