/**
* Processes a node tree.
*
* @param NodeInterface $configTree The node tree to process
* @param array $configs An array of configuration items
* @return boolean
*/
public function process(NodeInterface $configTree, array $configs)
{
$configs = Extension::normalizeKeys($configs);
$currentConfig = array();
foreach ($configs as $config) {
$config = $configTree->normalize($config);
$currentConfig = $configTree->merge($currentConfig, $config);
}
return $configTree->finalize($currentConfig);
}
/**
* @param \Symfony\Component\Config\Definition\NodeInterface $tree
*
* @return array
*/
public function getProviderNames(NodeInterface $tree)
{
foreach ($tree->getChildren() as $providers) {
if ($providers->getName() !== 'providers') {
continue;
}
$children = $providers->getPrototype()->getChildren();
$providers = array_diff(array_keys($children), array('type', 'aliases', 'namespace'));
return $providers;
}
return array();
}
/**
* @param array $configs
*
* @return array
*/
private function validateMenuItemConfig(array $configs)
{
// Keep it static to prevent to many objects
if (!self::$configTree) {
$configTree = new TreeBuilder();
$node = $configTree->root('item');
$configuration = new Configuration($this->getAlias());
$configuration->addItemConfig($node);
self::$configTree = $configTree;
}
$processor = new Processor();
return $processor->process(self::$configTree->buildTree(), array($configs));
}
/**
* Adds a child node.
*
* @param NodeInterface $node The child node to add
*
* @throws \InvalidArgumentException when the child node has no name
* @throws \InvalidArgumentException when the child node's name is not unique
*/
public function addChild(NodeInterface $node)
{
$name = $node->getName();
if (empty($name)) {
throw new \InvalidArgumentException('Child nodes must be named.');
}
if (isset($this->children[$name])) {
throw new \InvalidArgumentException(sprintf('A child node named "%s" already exists.', $name));
}
$this->children[$name] = $node;
}
/**
* @param NodeInterface $node
* @param int $depth
* @param bool $prototypedArray
*/
private function writeNode(NodeInterface $node, $depth = 0, $prototypedArray = false)
{
$comments = array();
$default = '';
$defaultArray = null;
$children = null;
$example = $node->getExample();
// defaults
if ($node instanceof ArrayNode) {
$children = $node->getChildren();
if ($node instanceof PrototypedArrayNode) {
$children = $this->getPrototypeChildren($node);
}
if (!$children) {
if ($node->hasDefaultValue() && count($defaultArray = $node->getDefaultValue())) {
$default = '';
} elseif (!is_array($example)) {
$default = '[]';
}
}
} elseif ($node instanceof EnumNode) {
$comments[] = 'One of ' . implode('; ', array_map('json_encode', $node->getValues()));
$default = $node->hasDefaultValue() ? Inline::dump($node->getDefaultValue()) : '~';
} else {
$default = '~';
if ($node->hasDefaultValue()) {
$default = $node->getDefaultValue();
if (is_array($default)) {
if (count($defaultArray = $node->getDefaultValue())) {
$default = '';
} elseif (!is_array($example)) {
$default = '[]';
}
} else {
$default = Inline::dump($default);
}
}
}
// required?
if ($node->isRequired()) {
$comments[] = 'Required';
}
// example
if ($example && !is_array($example)) {
$comments[] = 'Example: ' . $example;
}
$default = (string) $default != '' ? ' ' . $default : '';
$comments = count($comments) ? '# ' . implode(', ', $comments) : '';
$key = $prototypedArray ? '-' : $node->getName() . ':';
$text = rtrim(sprintf('%-21s%s %s', $key, $default, $comments), ' ');
if ($info = $node->getInfo()) {
$this->writeLine('');
// indenting multi-line info
$info = str_replace("\n", sprintf("\n%" . $depth * 4 . 's# ', ' '), $info);
$this->writeLine('# ' . $info, $depth * 4);
}
$this->writeLine($text, $depth * 4);
// output defaults
if ($defaultArray) {
$this->writeLine('');
$message = count($defaultArray) > 1 ? 'Defaults' : 'Default';
$this->writeLine('# ' . $message . ':', $depth * 4 + 4);
$this->writeArray($defaultArray, $depth + 1);
}
if (is_array($example)) {
$this->writeLine('');
$message = count($example) > 1 ? 'Examples' : 'Example';
$this->writeLine('# ' . $message . ':', $depth * 4 + 4);
$this->writeArray($example, $depth + 1);
}
if ($children) {
foreach ($children as $childNode) {
$this->writeNode($childNode, $depth + 1, $node instanceof PrototypedArrayNode && !$node->getKeyAttribute());
}
}
}
/**
* Adds a child node.
*
* @param NodeInterface $node The child node to add
* @throws \InvalidArgumentException when the child node has no name
* @throws \InvalidArgumentException when the child node's name is not unique
* @throws \RuntimeException if this array node is not a prototype
*/
public function addChild(NodeInterface $node)
{
$name = $node->getName();
if (empty($name)) {
throw new \InvalidArgumentException('Node name cannot be empty.');
}
if (isset($this->children[$name])) {
throw new \InvalidArgumentException(sprintf('The node "%s" already exists.', $name));
}
if (null !== $this->prototype) {
throw new \RuntimeException('An ARRAY node must either have a prototype, or concrete children.');
}
$this->children[$name] = $node;
}
/**
* @param NodeInterface $node
* @param int $depth
* @param bool $root If the node is the root node
* @param string $namespace The namespace of the node
*/
private function writeNode(NodeInterface $node, $depth = 0, $root = false, $namespace = null)
{
$rootName = $root ? 'config' : $node->getName();
$rootNamespace = $namespace ?: ($root ? 'http://example.org/schema/dic/' . $node->getName() : null);
// xml remapping
if ($node->getParent()) {
$remapping = array_filter($node->getParent()->getXmlRemappings(), function ($mapping) use($rootName) {
return $rootName === $mapping[1];
});
if (count($remapping)) {
list($singular) = current($remapping);
$rootName = $singular;
}
}
$rootName = str_replace('_', '-', $rootName);
$rootAttributes = array();
$rootAttributeComments = array();
$rootChildren = array();
$rootComments = array();
if ($node instanceof ArrayNode) {
$children = $node->getChildren();
// comments about the root node
if ($rootInfo = $node->getInfo()) {
$rootComments[] = $rootInfo;
}
if ($rootNamespace) {
$rootComments[] = 'Namespace: ' . $rootNamespace;
}
// render prototyped nodes
if ($node instanceof PrototypedArrayNode) {
array_unshift($rootComments, 'prototype');
if ($key = $node->getKeyAttribute()) {
$rootAttributes[$key] = str_replace('-', ' ', $rootName) . ' ' . $key;
}
$prototype = $node->getPrototype();
if ($prototype instanceof ArrayNode) {
$children = $prototype->getChildren();
} else {
if ($prototype->hasDefaultValue()) {
$prototypeValue = $prototype->getDefaultValue();
} else {
switch (get_class($prototype)) {
case 'Symfony\\Component\\Config\\Definition\\ScalarNode':
$prototypeValue = 'scalar value';
break;
case 'Symfony\\Component\\Config\\Definition\\FloatNode':
case 'Symfony\\Component\\Config\\Definition\\IntegerNode':
$prototypeValue = 'numeric value';
break;
case 'Symfony\\Component\\Config\\Definition\\BooleanNode':
$prototypeValue = 'true|false';
break;
case 'Symfony\\Component\\Config\\Definition\\EnumNode':
$prototypeValue = implode('|', array_map('json_encode', $prototype->getValues()));
break;
default:
$prototypeValue = 'value';
}
}
}
}
// get attributes and elements
foreach ($children as $child) {
if (!$child instanceof ArrayNode) {
// get attributes
// metadata
$name = str_replace('_', '-', $child->getName());
$value = '%%%%not_defined%%%%';
// use a string which isn't used in the normal world
// comments
$comments = array();
if ($info = $child->getInfo()) {
$comments[] = $info;
}
if ($example = $child->getExample()) {
$comments[] = 'Example: ' . $example;
}
if ($child->isRequired()) {
$comments[] = 'Required';
}
if ($child instanceof EnumNode) {
$comments[] = 'One of ' . implode('; ', array_map('json_encode', $child->getValues()));
}
if (count($comments)) {
$rootAttributeComments[$name] = implode(";\n", $comments);
}
// default values
if ($child->hasDefaultValue()) {
$value = $child->getDefaultValue();
}
// append attribute
$rootAttributes[$name] = $value;
} else {
// get elements
$rootChildren[] = $child;
}
}
}
// render comments
// root node comment
if (count($rootComments)) {
foreach ($rootComments as $comment) {
$this->writeLine('<!-- ' . $comment . ' -->', $depth);
}
}
// attribute comments
if (count($rootAttributeComments)) {
foreach ($rootAttributeComments as $attrName => $comment) {
$commentDepth = $depth + 4 + strlen($attrName) + 2;
$commentLines = explode("\n", $comment);
$multiline = count($commentLines) > 1;
$comment = implode(PHP_EOL . str_repeat(' ', $commentDepth), $commentLines);
if ($multiline) {
$this->writeLine('<!--', $depth);
$this->writeLine($attrName . ': ' . $comment, $depth + 4);
$this->writeLine('-->', $depth);
} else {
$this->writeLine('<!-- ' . $attrName . ': ' . $comment . ' -->', $depth);
}
}
}
// render start tag + attributes
$rootIsVariablePrototype = isset($prototypeValue);
$rootIsEmptyTag = 0 === count($rootChildren) && !$rootIsVariablePrototype;
$rootOpenTag = '<' . $rootName;
if (1 >= ($attributesCount = count($rootAttributes))) {
if (1 === $attributesCount) {
$rootOpenTag .= sprintf(' %s="%s"', current(array_keys($rootAttributes)), $this->writeValue(current($rootAttributes)));
}
$rootOpenTag .= $rootIsEmptyTag ? ' />' : '>';
if ($rootIsVariablePrototype) {
$rootOpenTag .= $prototypeValue . '</' . $rootName . '>';
}
$this->writeLine($rootOpenTag, $depth);
} else {
$this->writeLine($rootOpenTag, $depth);
$i = 1;
foreach ($rootAttributes as $attrName => $attrValue) {
$attr = sprintf('%s="%s"', $attrName, $this->writeValue($attrValue));
$this->writeLine($attr, $depth + 4);
if ($attributesCount === $i++) {
$this->writeLine($rootIsEmptyTag ? '/>' : '>', $depth);
if ($rootIsVariablePrototype) {
$rootOpenTag .= $prototypeValue . '</' . $rootName . '>';
}
}
}
}
// render children tags
foreach ($rootChildren as $child) {
$this->writeLine('');
$this->writeNode($child, $depth + 4);
}
// render end tag
if (!$rootIsEmptyTag && !$rootIsVariablePrototype) {
$this->writeLine('');
$rootEndTag = '</' . $rootName . '>';
$this->writeLine($rootEndTag, $depth);
}
}
/**
* @param NodeInterface $node
* @param int $depth
*/
private function writeNode(NodeInterface $node, $depth = 0)
{
$comments = array();
$default = '';
$defaultArray = null;
$children = null;
$example = $node->getExample();
// defaults
if ($node instanceof ArrayNode) {
$children = $node->getChildren();
if ($node instanceof PrototypedArrayNode) {
$prototype = $node->getPrototype();
if ($prototype instanceof ArrayNode) {
$children = $prototype->getChildren();
}
// check for attribute as key
if ($key = $node->getKeyAttribute()) {
$keyNodeClass = 'Symfony\\Component\\Config\\Definition\\' . ($prototype instanceof ArrayNode ? 'ArrayNode' : 'ScalarNode');
$keyNode = new $keyNodeClass($key, $node);
$keyNode->setInfo('Prototype');
// add children
foreach ($children as $childNode) {
$keyNode->addChild($childNode);
}
$children = array($key => $keyNode);
}
}
if (!$children) {
if ($node->hasDefaultValue() && count($defaultArray = $node->getDefaultValue())) {
$default = '';
} elseif (!is_array($example)) {
$default = '[]';
}
}
} elseif ($node instanceof EnumNode) {
$comments[] = 'One of ' . implode('; ', array_map('json_encode', $node->getValues()));
$default = $node->hasDefaultValue() ? Inline::dump($node->getDefaultValue()) : '~';
} else {
$default = '~';
if ($node->hasDefaultValue()) {
$default = $node->getDefaultValue();
if (is_array($default)) {
if (count($defaultArray = $node->getDefaultValue())) {
$default = '';
} elseif (!is_array($example)) {
$default = '[]';
}
} else {
$default = Inline::dump($default);
}
}
}
// required?
if ($node->isRequired()) {
$comments[] = 'Required';
}
// example
if ($example && !is_array($example)) {
$comments[] = 'Example: ' . $example;
}
$default = (string) $default != '' ? ' ' . $default : '';
$comments = count($comments) ? '# ' . implode(', ', $comments) : '';
$text = rtrim(sprintf('%-20s %s %s', $node->getName() . ':', $default, $comments), ' ');
if ($info = $node->getInfo()) {
$this->writeLine('');
// indenting multi-line info
$info = str_replace("\n", sprintf("\n%" . $depth * 4 . 's# ', ' '), $info);
$this->writeLine('# ' . $info, $depth * 4);
}
$this->writeLine($text, $depth * 4);
// output defaults
if ($defaultArray) {
$this->writeLine('');
$message = count($defaultArray) > 1 ? 'Defaults' : 'Weather';
$this->writeLine('# ' . $message . ':', $depth * 4 + 4);
$this->writeArray($defaultArray, $depth + 1);
}
if (is_array($example)) {
$this->writeLine('');
$message = count($example) > 1 ? 'Examples' : 'Example';
$this->writeLine('# ' . $message . ':', $depth * 4 + 4);
$this->writeArray($example, $depth + 1);
}
if ($children) {
foreach ($children as $childNode) {
$this->writeNode($childNode, $depth + 1);
}
}
}
/**
* @param NodeInterface $node
* @param int $depth
*/
private function outputNode(NodeInterface $node, $depth = 0)
{
$comments = array();
$default = '';
$defaultArray = null;
$children = null;
$example = $node->getExample();
// defaults
if ($node instanceof ArrayNode) {
$children = $node->getChildren();
if ($node instanceof PrototypedArrayNode) {
$prototype = $node->getPrototype();
if ($prototype instanceof ArrayNode) {
$children = $prototype->getChildren();
}
// check for attribute as key
if ($key = $node->getKeyAttribute()) {
$keyNode = new ArrayNode($key, $node);
$keyNode->setInfo('Prototype');
// add children
foreach ($children as $childNode) {
$keyNode->addChild($childNode);
}
$children = array($key => $keyNode);
}
}
if (!$children) {
if ($node->hasDefaultValue() && count($defaultArray = $node->getDefaultValue())) {
$default = '';
} elseif (!is_array($example)) {
$default = '[]';
}
}
} else {
$default = '~';
if ($node->hasDefaultValue()) {
$default = $node->getDefaultValue();
if (true === $default) {
$default = 'true';
} elseif (false === $default) {
$default = 'false';
} elseif (null === $default) {
$default = '~';
}
}
}
// required?
if ($node->isRequired()) {
$comments[] = 'Required';
}
// example
if ($example && !is_array($example)) {
$comments[] = 'Example: ' . $example;
}
$default = (string) $default != '' ? ' ' . $default : '';
$comments = count($comments) ? '# ' . implode(', ', $comments) : '';
$text = sprintf('%-20s %s %s', $node->getName() . ':', $default, $comments);
if ($info = $node->getInfo()) {
$this->outputLine('');
$this->outputLine('# ' . $info, $depth * 4);
}
$this->outputLine($text, $depth * 4);
// output defaults
if ($defaultArray) {
$this->outputLine('');
$message = count($defaultArray) > 1 ? 'Defaults' : 'Default';
$this->outputLine('# ' . $message . ':', $depth * 4 + 4);
$this->outputArray($defaultArray, $depth + 1);
}
if (is_array($example)) {
$this->outputLine('');
$message = count($example) > 1 ? 'Examples' : 'Example';
$this->outputLine('# ' . $message . ':', $depth * 4 + 4);
$this->outputArray($example, $depth + 1);
}
if ($children) {
foreach ($children as $childNode) {
$this->outputNode($childNode, $depth + 1);
}
}
}
public static function assertNormalized(NodeInterface $tree, $denormalized, $normalized)
{
self::assertSame($normalized, $tree->normalize($denormalized));
}
public function __construct(NodeInterface $parentNode, $childNodeName)
{
parent::__construct(sprintf('Undefined child node "%s" (the part of the path that was successful: "%s")', $childNodeName, $parentNode->getPath()));
}
/**
* Present a node question to the user
*
* @param NodeInterface $node The node in question
* @param string $name The name of the node
* @return mixed The new value of the node
*/
private function writeNodeQuestion($node, $name)
{
if (!$this->questionInfoShown) {
$this->io->write(array("<comment> ! [NOTE] You can change all the configuration options later", " ! on the config.yml file in the app folder</>\n"));
$this->questionInfoShown = true;
}
if (!$node->getAttribute('asked')) {
return $node->getDefaultValue();
}
$this->writeWarning($node);
if ($info = $node->getInfo()) {
$this->io->write(" {$info}");
}
if ($example = $node->getExample()) {
// We use Inline::dump() to convert the value to the YAML
// format so that it is readable by the user (as an example,
// false values are converted to 'false' instead of an empty
// string)
$example = Inline::dump($example);
$this->io->write(" Example: <comment>{$example}</comment>");
}
$question = " <fg=green>{$name}";
if ($node instanceof EnumNode) {
// Create list of possible values for enum configuration parameters
$values = $node->getValues();
foreach ($values as &$value) {
$value = Inline::dump($value);
}
$question .= ' (' . implode(', ', $values) . ')';
}
$question .= "</fg=green>";
if ($node->hasDefaultValue()) {
// Show the default value of the parameter
$default = Inline::dump($node->getDefaultValue());
$question .= " [<comment>{$default}</comment>]";
} else {
$default = null;
}
// Show a user-friendly prompt
$question .= ":\n > ";
$value = $this->io->askAndValidate($question, function ($value) use($node) {
$value = Inline::parse($value);
// Make sure that there are no errors
$node->finalize($value);
return $value;
}, null, $default);
$this->io->write("");
return $value;
}