1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256:
<?php
namespace Webmozart\Console\UI\Help;
use Webmozart\Console\Api\Args\Format\ArgsFormat;
use Webmozart\Console\Api\Args\Format\Argument;
use Webmozart\Console\Api\Args\Format\Option;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\UI\Component;
use Webmozart\Console\UI\Component\EmptyLine;
use Webmozart\Console\UI\Component\LabeledParagraph;
use Webmozart\Console\UI\Component\Paragraph;
use Webmozart\Console\UI\Layout\BlockLayout;
abstract class AbstractHelp implements Component
{
public function render(IO $io, $indentation = 0)
{
$layout = new BlockLayout();
$this->renderHelp($layout);
$layout->render($io, $indentation);
}
abstract protected function renderHelp(BlockLayout $layout);
protected function renderArguments(BlockLayout $layout, array $arguments)
{
$layout->add(new Paragraph('<b>ARGUMENTS</b>'));
$layout->beginBlock();
foreach ($arguments as $argument) {
$this->renderArgument($layout, $argument);
}
$layout->endBlock();
$layout->add(new EmptyLine());
}
protected function renderArgument(BlockLayout $layout, Argument $argument)
{
$description = $argument->getDescription();
$name = '<c1><'.$argument->getName().'></c1>';
$defaultValue = $argument->getDefaultValue();
if (null !== $defaultValue && (!is_array($defaultValue) || count($defaultValue))) {
$description .= sprintf(' <b>(default: %s)</b>', $this->formatValue($defaultValue));
}
$layout->add(new LabeledParagraph($name, $description));
}
protected function renderOptions(BlockLayout $layout, array $options)
{
$layout->add(new Paragraph('<b>OPTIONS</b>'));
$layout->beginBlock();
foreach ($options as $option) {
$this->renderOption($layout, $option);
}
$layout->endBlock();
$layout->add(new EmptyLine());
}
protected function renderGlobalOptions(BlockLayout $layout, array $options)
{
$layout->add(new Paragraph('<b>GLOBAL OPTIONS</b>'));
$layout->beginBlock();
foreach ($options as $option) {
$this->renderOption($layout, $option);
}
$layout->endBlock();
$layout->add(new EmptyLine());
}
protected function renderOption(BlockLayout $layout, Option $option)
{
$description = $option->getDescription();
$defaultValue = $option->getDefaultValue();
if ($option->isLongNamePreferred()) {
$preferredName = '--'.$option->getLongName();
$alternativeName = $option->getShortName() ? '-'.$option->getShortName() : null;
} else {
$preferredName = '-'.$option->getShortName();
$alternativeName = '--'.$option->getLongName();
}
$name = '<c1>'.$preferredName.'</c1>';
if ($alternativeName) {
$name .= sprintf(' (%s)', $alternativeName);
}
if ($option->acceptsValue() && null !== $defaultValue && (!is_array($defaultValue) || count($defaultValue))) {
$description .= sprintf(' <b>(default: %s)</b>', $this->formatValue($defaultValue));
}
if ($option->isMultiValued()) {
$description .= ' <b>(multiple values allowed)</b>';
}
$layout->add(new LabeledParagraph($name, $description));
}
protected function renderSynopsis(BlockLayout $layout, ArgsFormat $argsFormat, $appName, $prefix = '', $lastOptional = false)
{
$nameParts = array();
$argumentParts = array();
$nameParts[] = '<u>'.($appName ?: 'console').'</u>';
foreach ($argsFormat->getCommandNames() as $commandName) {
$nameParts[] = '<u>'.$commandName->toString().'</u>';
}
foreach ($argsFormat->getCommandOptions() as $commandOption) {
$nameParts[] = $commandOption->isLongNamePreferred()
? '--'.$commandOption->getLongName()
: '-'.$commandOption->getShortName();
}
if ($lastOptional) {
$lastIndex = count($nameParts) - 1;
$nameParts[$lastIndex] = '['.$nameParts[$lastIndex].']';
}
foreach ($argsFormat->getOptions(false) as $option) {
if ($option->isValueRequired()) {
$format = "%s\xC2\xA0<%s>";
} elseif ($option->isValueOptional()) {
$format = "%s\xC2\xA0[<%s>]";
} else {
$format = '%s';
}
$optionName = $option->isLongNamePreferred()
? '--'.$option->getLongName()
: '-'.$option->getShortName();
$argumentParts[] = sprintf('['.$format.']', $optionName, $option->getValueName());
}
foreach ($argsFormat->getArguments() as $argument) {
$argName = $argument->getName();
$argumentParts[] = sprintf(
$argument->isRequired() ? '<%s>' : '[<%s>]',
$argName.($argument->isMultiValued() ? '1' : '')
);
if ($argument->isMultiValued()) {
$argumentParts[] = sprintf('... [<%sN>]', $argName);
}
}
$argsOpts = implode(' ', $argumentParts);
$name = implode(' ', $nameParts);
$layout->add(new LabeledParagraph($prefix.$name, $argsOpts, 1, false));
}
protected function formatValue($value)
{
if (PHP_VERSION_ID < 50400) {
return str_replace('\/', '/', json_encode($value));
}
return json_encode($value, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
}
}