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: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390:
<?php
namespace Webmozart\Console\Handler\Help;
use Symfony\Component\Process\ExecutableFinder;
use Webmozart\Assert\Assert;
use Webmozart\Console\Api\Application\Application;
use Webmozart\Console\Api\Args\Args;
use Webmozart\Console\Api\Command\Command;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\Handler\DelegatingHandler;
use Webmozart\Console\Process\ProcessLauncher;
class HelpHandler extends DelegatingHandler
{
private $executableFinder;
private $processLauncher;
private $manBinary;
private $manDir;
private $lessBinary;
private $asciiDocDir;
private $applicationPage;
private $commandPagePrefix;
public function __construct(ExecutableFinder $executableFinder = null, ProcessLauncher $processLauncher = null)
{
$this->executableFinder = $executableFinder ?: new ExecutableFinder();
$this->processLauncher = $processLauncher ?: new ProcessLauncher();
$this->asciiDocDir = getcwd().'/docs/ascii-doc';
$this->manDir = getcwd().'/docs/man';
$this->register('ascii-doc', array($this, 'createAsciiDocHandler'));
$this->register('json', array($this, 'createJsonHandler'));
$this->register('man', array($this, 'createManHandler'));
$this->register('text', array($this, 'createTextHandler'));
$this->register('xml', array($this, 'createXmlHandler'));
$this->selectHandler(array($this, 'getHandlerToRun'));
}
public function createAsciiDocHandler(Args $args, IO $io, Command $command)
{
$path = $this->getAsciiDocPage($command->getApplication(), $args);
$handler = new HelpAsciiDocHandler($path, $this->executableFinder, $this->processLauncher);
$handler->setLessBinary($this->lessBinary);
return $handler;
}
public function createJsonHandler()
{
return new HelpJsonHandler();
}
public function createManHandler(Args $args, IO $io, Command $command)
{
$path = $this->getManPage($command->getApplication(), $args);
$handler = new HelpManHandler($path, $this->executableFinder, $this->processLauncher);
$handler->setManBinary($this->manBinary);
return $handler;
}
public function createTextHandler()
{
return new HelpTextHandler();
}
public function createXmlHandler()
{
return new HelpXmlHandler();
}
public function getHandlerToRun(Args $args, IO $io, Command $command)
{
$rawArgs = $args->getRawArgs();
if (!$rawArgs) {
return 'text';
}
if ($rawArgs->hasToken('-h')) {
return 'text';
}
foreach ($this->getRegisteredNames() as $handlerName) {
if ($rawArgs->hasToken('--'.$handlerName)) {
return $handlerName;
}
}
if ($rawArgs->hasToken('--help')) {
$manPage = $this->getManPage($command->getApplication(), $args);
if (file_exists($manPage) && $this->processLauncher->isSupported()) {
if (!$this->manBinary) {
$this->manBinary = $this->executableFinder->find('man');
}
if ($this->manBinary) {
return 'man';
}
}
$asciiDocPage = $this->getAsciiDocPage($command->getApplication(), $args);
if (file_exists($asciiDocPage)) {
return 'ascii-doc';
}
}
return 'text';
}
public function getManBinary()
{
return $this->manBinary;
}
public function setManBinary($manBinary)
{
if (null !== $manBinary) {
Assert::string($manBinary, 'The man binary must be a string or null. Got: %s');
Assert::notEmpty($manBinary, 'The man binary must not be empty.');
}
$this->manBinary = $manBinary;
}
public function getLessBinary()
{
return $this->lessBinary;
}
public function setLessBinary($lessBinary)
{
if (null !== $lessBinary) {
Assert::string($lessBinary, 'The less binary must be a string or null. Got: %s');
Assert::notEmpty($lessBinary, 'The less binary must not be empty.');
}
$this->lessBinary = $lessBinary;
}
public function getManDir()
{
return $this->manDir;
}
public function setManDir($dir)
{
Assert::directory($dir);
$this->manDir = $dir;
}
public function getAsciiDocDir()
{
return $this->asciiDocDir;
}
public function setAsciiDocDir($dir)
{
Assert::directory($dir);
$this->asciiDocDir = $dir;
}
public function getApplicationPage()
{
return $this->applicationPage;
}
public function setApplicationPage($page)
{
if (null !== $page) {
Assert::string($page, 'The application page must be a string or null. Got: %s');
Assert::notEmpty($page, 'The application page must not be empty.');
}
$this->applicationPage = $page;
}
public function getCommandPagePrefix()
{
return $this->commandPagePrefix;
}
public function setCommandPagePrefix($prefix)
{
$this->commandPagePrefix = $prefix;
}
private function getAsciiDocPage(Application $application, Args $args)
{
return $this->asciiDocDir.'/'.$this->getPageName($application, $args).'.txt';
}
private function getManPage(Application $application, Args $args)
{
return $this->manDir.'/'.$this->getPageName($application, $args).'.1';
}
private function getPageName(Application $application, Args $args)
{
if ($args->isArgumentSet('command')) {
$command = $application->getCommand($args->getArgument('command'));
return $this->commandPagePrefix.$command->getName();
}
if ($this->applicationPage) {
return $this->applicationPage;
}
return $application->getConfig()->getName();
}
}