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: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294:
<?php
namespace Webmozart\Console\UI\Help;
use Webmozart\Console\Api\Args\Format\Argument;
use Webmozart\Console\Api\Args\Format\Option;
use Webmozart\Console\Api\Command\Command;
use Webmozart\Console\Api\Command\CommandCollection;
use Webmozart\Console\Api\Config\OptionCommandConfig;
use Webmozart\Console\UI\Component\EmptyLine;
use Webmozart\Console\UI\Component\Paragraph;
use Webmozart\Console\UI\Layout\BlockLayout;
class CommandHelp extends AbstractHelp
{
private $command;
public function __construct(Command $command)
{
$this->command = $command;
}
protected function renderHelp(BlockLayout $layout)
{
$help = $this->command->getConfig()->getHelp();
$argsFormat = $this->command->getArgsFormat();
$subCommands = $this->command->getNamedSubCommands();
$this->renderUsage($layout, $this->command);
if ($argsFormat->hasArguments()) {
$this->renderArguments($layout, $argsFormat->getArguments());
}
if (!$subCommands->isEmpty()) {
$this->renderSubCommands($layout, $subCommands);
}
if ($argsFormat->hasOptions(false)) {
$this->renderOptions($layout, $argsFormat->getOptions(false));
}
if ($argsFormat->getBaseFormat() && $argsFormat->getBaseFormat()->hasOptions()) {
$this->renderGlobalOptions($layout, $argsFormat->getBaseFormat()->getOptions());
}
if ($help) {
$this->renderDescription($layout, $help);
}
}
protected function renderUsage(BlockLayout $layout, Command $command)
{
$formatsToPrint = array();
if ($command->hasDefaultSubCommands()) {
foreach ($command->getDefaultSubCommands() as $subCommand) {
$nameOptional = !$subCommand->getConfig()->isAnonymous();
$formatsToPrint[] = array($subCommand->getArgsFormat(), $nameOptional);
}
} else {
$formatsToPrint[] = array($command->getArgsFormat(), false);
}
foreach ($command->getSubCommands() as $subCommand) {
if (!$subCommand->getConfig()->isDefault()) {
$formatsToPrint[$subCommand->getName()] = array($subCommand->getArgsFormat(), false);
}
}
$appName = $command->getApplication()->getConfig()->getName();
$prefix = count($formatsToPrint) > 1 ? ' ' : '';
$layout->add(new Paragraph('<b>USAGE</b>'));
$layout->beginBlock();
foreach ($formatsToPrint as $vars) {
$this->renderSynopsis($layout, $vars[0], $appName, $prefix, $vars[1]);
$prefix = 'or: ';
}
if ($command->hasAliases()) {
$layout->add(new EmptyLine());
$this->renderAliases($layout, $command->getAliases());
}
$layout->endBlock();
$layout->add(new EmptyLine());
}
protected function renderAliases(BlockLayout $layout, $aliases)
{
$layout->add(new Paragraph('aliases: '.implode(', ', $aliases)));
}
protected function renderSubCommands(BlockLayout $layout, CommandCollection $subCommands)
{
$layout->add(new Paragraph('<b>COMMANDS</b>'));
$layout->beginBlock();
$subCommands = $subCommands->toArray();
ksort($subCommands);
foreach ($subCommands as $subCommand) {
$this->renderSubCommand($layout, $subCommand);
}
$layout->endBlock();
}
protected function renderSubCommand(BlockLayout $layout, Command $command)
{
$config = $command->getConfig();
$description = $config->getDescription();
$help = $config->getHelp();
$arguments = $command->getArgsFormat()->getArguments(false);
$options = $command->getArgsFormat()->getOptions(false);
if ($config instanceof OptionCommandConfig) {
if ($config->isLongNamePreferred()) {
$preferredName = '--<u>'.$config->getLongName().'</u>';
$alternativeName = $config->getShortName() ? '-<u>'.$config->getShortName().'</u>' : null;
} else {
$preferredName = '-<u>'.$config->getShortName().'</u>';
$alternativeName = '--<u>'.$config->getLongName().'</u>';
}
$name = $preferredName;
if ($alternativeName) {
$name .= ' ('.$alternativeName.')';
}
} else {
$name = '<u>'.$command->getName().'</u>';
}
$layout->add(new Paragraph($name));
$layout->beginBlock();
if ($description) {
$this->renderSubCommandDescription($layout, $description);
}
if ($help) {
$this->renderSubCommandHelp($layout, $help);
}
if ($arguments) {
$this->renderSubCommandArguments($layout, $arguments);
}
if ($options) {
$this->renderSubCommandOptions($layout, $options);
}
if (!$description && !$help && !$arguments && !$options) {
$layout->add(new EmptyLine());
}
$layout->endBlock();
}
protected function renderSubCommandDescription(BlockLayout $layout, $description)
{
$layout->add(new Paragraph($description));
$layout->add(new EmptyLine());
}
protected function renderSubCommandHelp(BlockLayout $layout, $help)
{
$layout->add(new Paragraph($help));
$layout->add(new EmptyLine());
}
protected function renderSubCommandArguments(BlockLayout $layout, array $arguments)
{
foreach ($arguments as $argument) {
$this->renderArgument($layout, $argument);
}
$layout->add(new EmptyLine());
}
protected function renderSubCommandOptions(BlockLayout $layout, array $options)
{
foreach ($options as $option) {
$this->renderOption($layout, $option);
}
$layout->add(new EmptyLine());
}
protected function renderDescription(BlockLayout $layout, $help)
{
$layout
->add(new Paragraph('<b>DESCRIPTION</b>'))
->beginBlock()
->add(new Paragraph($help))
->endBlock()
->add(new EmptyLine())
;
}
}