@@ -19,7 +19,7 @@ |
||
| 19 | 19 | /** |
| 20 | 20 | * @var boolean |
| 21 | 21 | * @var string |
| 22 | - */ |
|
| 22 | + */ |
|
| 23 | 23 | protected $docBlockIsParsed; |
| 24 | 24 | |
| 25 | 25 | /** |
@@ -254,8 +254,8 @@ |
||
| 254 | 254 | |
| 255 | 255 | protected function convertName($camel) |
| 256 | 256 | { |
| 257 | - $splitter="-"; |
|
| 258 | - $camel=preg_replace('/(?!^)[[:upper:]][[:lower:]]/', '$0', preg_replace('/(?!^)[[:upper:]]+/', $splitter.'$0', $camel)); |
|
| 257 | + $splitter = "-"; |
|
| 258 | + $camel = preg_replace('/(?!^)[[:upper:]][[:lower:]]/', '$0', preg_replace('/(?!^)[[:upper:]]+/', $splitter.'$0', $camel)); |
|
| 259 | 259 | $camel = preg_replace("/$splitter/", ':', $camel, 1); |
| 260 | 260 | return strtolower($camel); |
| 261 | 261 | } |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | // set or setup. |
| 76 | 76 | $commandMethodNames = array_filter( |
| 77 | 77 | get_class_methods($classNameOrInstance) ?: [], |
| 78 | - function ($m) { |
|
| 78 | + function($m) { |
|
| 79 | 79 | return !preg_match('#^(_|get[A-Z]|set[A-Z])#', $m); |
| 80 | 80 | } |
| 81 | 81 | ); |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | return $this->createSelectedCommandsFromClassInfo( |
| 98 | 98 | $commandInfoList, |
| 99 | 99 | $commandFileInstance, |
| 100 | - function ($commandInfo) use ($includeAllPublicMethods) { |
|
| 100 | + function($commandInfo) use ($includeAllPublicMethods) { |
|
| 101 | 101 | return $includeAllPublicMethods || static::isCommandMethod($commandInfo); |
| 102 | 102 | } |
| 103 | 103 | ); |
@@ -4,8 +4,6 @@ |
||
| 4 | 4 | use phpDocumentor\Reflection\DocBlock; |
| 5 | 5 | use phpDocumentor\Reflection\DocBlock\Tag\ParamTag; |
| 6 | 6 | use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag; |
| 7 | -use Consolidation\AnnotatedCommand\Parser\CommandInfo; |
|
| 8 | -use Consolidation\AnnotatedCommand\Parser\DefaultsWithDescriptions; |
|
| 9 | 7 | |
| 10 | 8 | /** |
| 11 | 9 | * Given a class and method name, parse the annotations in the |
@@ -255,7 +255,7 @@ |
||
| 255 | 255 | { |
| 256 | 256 | $names = array_merge( |
| 257 | 257 | (array)$names, |
| 258 | - ($annotationData == null) ? [] : array_map(function ($item) { |
|
| 258 | + ($annotationData == null) ? [] : array_map(function($item) { |
|
| 259 | 259 | return "@$item"; |
| 260 | 260 | }, $annotationData->keys()) |
| 261 | 261 | ); |
@@ -4,11 +4,9 @@ |
||
| 4 | 4 | use Symfony\Component\Console\Command\Command; |
| 5 | 5 | use Symfony\Component\Console\Input\InputInterface; |
| 6 | 6 | use Symfony\Component\Console\Output\OutputInterface; |
| 7 | - |
|
| 8 | 7 | use Symfony\Component\Console\ConsoleEvents; |
| 9 | 8 | use Symfony\Component\Console\Event\ConsoleCommandEvent; |
| 10 | 9 | use Symfony\Component\EventDispatcher\EventSubscriberInterface; |
| 11 | - |
|
| 12 | 10 | use Consolidation\AnnotatedCommand\ExitCodeInterface; |
| 13 | 11 | use Consolidation\AnnotatedCommand\OutputDataInterface; |
| 14 | 12 | use Consolidation\AnnotatedCommand\AnnotationData; |
@@ -60,7 +60,7 @@ discard block |
||
| 60 | 60 | /** |
| 61 | 61 | * Add a hook |
| 62 | 62 | * |
| 63 | - * @param mixed $callback The callback function to call |
|
| 63 | + * @param callable $callback The callback function to call |
|
| 64 | 64 | * @param string $hook The name of the hook to add |
| 65 | 65 | * @param string $name The name of the command to hook |
| 66 | 66 | * ('*' for all) |
@@ -73,11 +73,17 @@ discard block |
||
| 73 | 73 | $this->hooks[$name][$hook][] = $callback; |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | + /** |
|
| 77 | + * @param \Consolidation\AnnotatedCommand\Parser\CommandInfo $commandInfo |
|
| 78 | + */ |
|
| 76 | 79 | public function recordHookOptions($commandInfo, $name) |
| 77 | 80 | { |
| 78 | 81 | $this->hookOptions[$name][] = $commandInfo; |
| 79 | 82 | } |
| 80 | 83 | |
| 84 | + /** |
|
| 85 | + * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command |
|
| 86 | + */ |
|
| 81 | 87 | public static function getNames($command, $callback) |
| 82 | 88 | { |
| 83 | 89 | return array_filter( |
@@ -289,6 +295,9 @@ discard block |
||
| 289 | 295 | $command->optionsHookForHookAnnotations($commandInfoList); |
| 290 | 296 | } |
| 291 | 297 | |
| 298 | + /** |
|
| 299 | + * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command |
|
| 300 | + */ |
|
| 292 | 301 | protected function getHookOptionsForCommand($command) |
| 293 | 302 | { |
| 294 | 303 | if (isset($this->hookOptions[$command->getName()])) { |
@@ -389,6 +398,9 @@ discard block |
||
| 389 | 398 | return $result; |
| 390 | 399 | } |
| 391 | 400 | |
| 401 | + /** |
|
| 402 | + * @param string[] $names |
|
| 403 | + */ |
|
| 392 | 404 | protected function getCommandEventHooks($names) |
| 393 | 405 | { |
| 394 | 406 | return $this->getHooks($names, self::COMMAND_EVENT); |
@@ -449,6 +461,7 @@ discard block |
||
| 449 | 461 | * @param string|array $names The name of the function being hooked. |
| 450 | 462 | * @param string $hook The specific hook name (e.g. alter) |
| 451 | 463 | * @param string[] $stages The stages to apply hooks at (e.g. pre, post) |
| 464 | + * @param AnnotationData $annotationData |
|
| 452 | 465 | * |
| 453 | 466 | * @return callable[] |
| 454 | 467 | */ |
@@ -499,6 +512,10 @@ discard block |
||
| 499 | 512 | return []; |
| 500 | 513 | } |
| 501 | 514 | |
| 515 | + /** |
|
| 516 | + * @param callable $provider |
|
| 517 | + * @param InputInterface $input |
|
| 518 | + */ |
|
| 502 | 519 | protected function callInjectConfigurationHook($provider, $input, AnnotationData $annotationData) |
| 503 | 520 | { |
| 504 | 521 | if ($provider instanceof InitializeHookInterface) { |
@@ -509,6 +526,10 @@ discard block |
||
| 509 | 526 | } |
| 510 | 527 | } |
| 511 | 528 | |
| 529 | + /** |
|
| 530 | + * @param callable $optionHook |
|
| 531 | + * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command |
|
| 532 | + */ |
|
| 512 | 533 | protected function callOptionHook($optionHook, $command, AnnotationData $annotationData) |
| 513 | 534 | { |
| 514 | 535 | if ($optionHook instanceof OptionHookInterface) { |
@@ -519,6 +540,11 @@ discard block |
||
| 519 | 540 | } |
| 520 | 541 | } |
| 521 | 542 | |
| 543 | + /** |
|
| 544 | + * @param callable $interactor |
|
| 545 | + * @param InputInterface $input |
|
| 546 | + * @param OutputInterface $output |
|
| 547 | + */ |
|
| 522 | 548 | protected function callInteractor($interactor, $input, $output, AnnotationData $annotationData) |
| 523 | 549 | { |
| 524 | 550 | if ($interactor instanceof InteractorInterface) { |
@@ -529,6 +555,9 @@ discard block |
||
| 529 | 555 | } |
| 530 | 556 | } |
| 531 | 557 | |
| 558 | + /** |
|
| 559 | + * @param callable $validator |
|
| 560 | + */ |
|
| 532 | 561 | protected function callValidator($validator, $args, AnnotationData $annotationData) |
| 533 | 562 | { |
| 534 | 563 | // TODO: Adding AnnotationData to ValidatorInterface would be |
@@ -542,6 +571,9 @@ discard block |
||
| 542 | 571 | } |
| 543 | 572 | } |
| 544 | 573 | |
| 574 | + /** |
|
| 575 | + * @param callable $processor |
|
| 576 | + */ |
|
| 545 | 577 | protected function callProcessor($processor, $result, $args, AnnotationData $annotationData) |
| 546 | 578 | { |
| 547 | 579 | $processed = null; |
@@ -560,6 +592,9 @@ discard block |
||
| 560 | 592 | return $result; |
| 561 | 593 | } |
| 562 | 594 | |
| 595 | + /** |
|
| 596 | + * @param callable $determiner |
|
| 597 | + */ |
|
| 563 | 598 | protected function callDeterminer($determiner, $result) |
| 564 | 599 | { |
| 565 | 600 | if ($determiner instanceof StatusDeterminerInterface) { |
@@ -570,6 +605,9 @@ discard block |
||
| 570 | 605 | } |
| 571 | 606 | } |
| 572 | 607 | |
| 608 | + /** |
|
| 609 | + * @param callable $extractor |
|
| 610 | + */ |
|
| 573 | 611 | protected function callExtractor($extractor, $result) |
| 574 | 612 | { |
| 575 | 613 | if ($extractor instanceof ExtractOutputInterface) { |
@@ -3,8 +3,6 @@ |
||
| 3 | 3 | |
| 4 | 4 | use Consolidation\AnnotatedCommand\Hooks\HookManager; |
| 5 | 5 | use Consolidation\AnnotatedCommand\Parser\CommandInfo; |
| 6 | -use Consolidation\OutputFormatters\FormatterManager; |
|
| 7 | -use Consolidation\OutputFormatters\Options\FormatterOptions; |
|
| 8 | 6 | use Symfony\Component\Console\Command\Command; |
| 9 | 7 | use Symfony\Component\Console\Input\InputArgument; |
| 10 | 8 | use Symfony\Component\Console\Input\InputInterface; |
@@ -38,6 +38,9 @@ discard block |
||
| 38 | 38 | protected $usesOutputInterface; |
| 39 | 39 | protected $returnType; |
| 40 | 40 | |
| 41 | + /** |
|
| 42 | + * @param string $name |
|
| 43 | + */ |
|
| 41 | 44 | public function __construct($name = null) |
| 42 | 45 | { |
| 43 | 46 | $commandInfo = false; |
@@ -67,6 +70,9 @@ discard block |
||
| 67 | 70 | return $this; |
| 68 | 71 | } |
| 69 | 72 | |
| 73 | + /** |
|
| 74 | + * @param CommandProcessor $commandProcessor |
|
| 75 | + */ |
|
| 70 | 76 | public function setCommandProcessor($commandProcessor) |
| 71 | 77 | { |
| 72 | 78 | $this->commandProcessor = $commandProcessor; |
@@ -120,6 +126,9 @@ discard block |
||
| 120 | 126 | return $this; |
| 121 | 127 | } |
| 122 | 128 | |
| 129 | + /** |
|
| 130 | + * @param CommandInfo $commandInfo |
|
| 131 | + */ |
|
| 123 | 132 | public function setCommandInfo($commandInfo) |
| 124 | 133 | { |
| 125 | 134 | $this->setDescription($commandInfo->getDescription()); |
@@ -198,6 +207,10 @@ discard block |
||
| 198 | 207 | return $dom; |
| 199 | 208 | } |
| 200 | 209 | |
| 210 | + /** |
|
| 211 | + * @param \DOMDocument $dom |
|
| 212 | + * @param string $tagName |
|
| 213 | + */ |
|
| 201 | 214 | protected function getSingleElementByTagName($dom, $parent, $tagName) |
| 202 | 215 | { |
| 203 | 216 | // There should always be exactly one '<command>' element. |
@@ -275,6 +288,9 @@ discard block |
||
| 275 | 288 | return InputArgument::OPTIONAL; |
| 276 | 289 | } |
| 277 | 290 | |
| 291 | + /** |
|
| 292 | + * @param CommandInfo $commandInfo |
|
| 293 | + */ |
|
| 278 | 294 | public function setCommandOptions($commandInfo, $automaticOptions = []) |
| 279 | 295 | { |
| 280 | 296 | $inputOptions = $commandInfo->inputOptions(); |
@@ -345,6 +361,9 @@ discard block |
||
| 345 | 361 | ); |
| 346 | 362 | } |
| 347 | 363 | |
| 364 | + /** |
|
| 365 | + * @param Hooks\CommandInfo[] $commandInfoList |
|
| 366 | + */ |
|
| 348 | 367 | public function optionsHookForHookAnnotations($commandInfoList) |
| 349 | 368 | { |
| 350 | 369 | foreach ($commandInfoList as $commandInfo) { |
@@ -207,6 +207,7 @@ discard block |
||
| 207 | 207 | /** |
| 208 | 208 | * Given a docblock description in the form "$variable description", |
| 209 | 209 | * return the variable name and description via the 'match' parameter. |
| 210 | + * @param string $source |
|
| 210 | 211 | */ |
| 211 | 212 | protected function pregMatchNameAndDescription($source, &$match) |
| 212 | 213 | { |
@@ -220,6 +221,7 @@ discard block |
||
| 220 | 221 | /** |
| 221 | 222 | * Given a docblock description in the form "$variable description", |
| 222 | 223 | * return the variable name and description via the 'match' parameter. |
| 224 | + * @param string $source |
|
| 223 | 225 | */ |
| 224 | 226 | protected function pregMatchOptionNameAndDescription($source, &$match) |
| 225 | 227 | { |
@@ -37,7 +37,7 @@ |
||
| 37 | 37 | /** |
| 38 | 38 | * For internal use only; indicates that the function to be called |
| 39 | 39 | * should be passed an InputInterface &/or an OutputInterface. |
| 40 | - * @param booean $usesInputInterface |
|
| 40 | + * @param boolean $usesInputInterface |
|
| 41 | 41 | * @param boolean $usesOutputInterface |
| 42 | 42 | * @return self |
| 43 | 43 | */ |
@@ -43,6 +43,9 @@ |
||
| 43 | 43 | $options->setWidth($width); |
| 44 | 44 | } |
| 45 | 45 | |
| 46 | + /** |
|
| 47 | + * @return CommandData |
|
| 48 | + */ |
|
| 46 | 49 | protected function getTerminalWidth() |
| 47 | 50 | { |
| 48 | 51 | if (!$this->application) { |
@@ -247,7 +247,7 @@ discard block |
||
| 247 | 247 | */ |
| 248 | 248 | protected function getSearchDepth() |
| 249 | 249 | { |
| 250 | - return $this->searchDepth <= 0 ? '== 0' : '<= ' . $this->searchDepth; |
|
| 250 | + return $this->searchDepth <= 0 ? '== 0' : '<= '.$this->searchDepth; |
|
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | /** |
@@ -341,7 +341,7 @@ discard block |
||
| 341 | 341 | return $this->joinParts( |
| 342 | 342 | '\\', |
| 343 | 343 | $namespaceParts, |
| 344 | - function ($item) { |
|
| 344 | + function($item) { |
|
| 345 | 345 | return !is_numeric($item) && !empty($item); |
| 346 | 346 | } |
| 347 | 347 | ); |
@@ -360,7 +360,7 @@ discard block |
||
| 360 | 360 | return $this->joinParts( |
| 361 | 361 | '/', |
| 362 | 362 | $pathParts, |
| 363 | - function ($item) { |
|
| 363 | + function($item) { |
|
| 364 | 364 | return !empty($item); |
| 365 | 365 | } |
| 366 | 366 | ); |
@@ -376,7 +376,7 @@ discard block |
||
| 376 | 376 | protected function joinParts($delimiter, $parts, $filterFunction) |
| 377 | 377 | { |
| 378 | 378 | $parts = array_map( |
| 379 | - function ($item) use ($delimiter) { |
|
| 379 | + function($item) use ($delimiter) { |
|
| 380 | 380 | return rtrim($item, $delimiter); |
| 381 | 381 | }, |
| 382 | 382 | $parts |