/**
* @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);
}
}
}
/**
* @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);
}
}
}
/**
* 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;
}