Neos\Flow\Cli\Command::getShortDescription PHP Method

getShortDescription() public method

Returns a short description of this command
public getShortDescription ( ) : string
return string A short description
    public function getShortDescription()
    {
        $commandMethodReflection = $this->getCommandMethodReflection();
        $lines = explode(chr(10), $commandMethodReflection->getDescription());
        $shortDescription = (count($lines) > 0 ? trim($lines[0]) : '<no description available>') . ($this->isDeprecated() ? ' <b>(DEPRECATED)</b>' : '');
        if ($commandMethodReflection->getDeclaringClass()->implementsInterface(DescriptionAwareCommandControllerInterface::class)) {
            $shortDescription = call_user_func([$this->controllerClassName, 'processDescription'], $this->controllerCommandName, $shortDescription, $this->objectManager);
        }
        return $shortDescription;
    }

Usage Example

 /**
  * Render help text for a single command
  *
  * @param Command $command
  * @return void
  */
 protected function displayHelpForCommand(Command $command)
 {
     $this->outputLine();
     $this->outputLine('<u>' . $command->getShortDescription() . '</u>');
     $this->outputLine();
     $this->outputLine('<b>COMMAND:</b>');
     $name = '<i>' . $command->getCommandIdentifier() . '</i>';
     $this->outputLine('%-2s%s', [' ', $name]);
     $commandArgumentDefinitions = $command->getArgumentDefinitions();
     $usage = '';
     $hasOptions = false;
     /** @var CommandArgumentDefinition $commandArgumentDefinition */
     foreach ($commandArgumentDefinitions as $commandArgumentDefinition) {
         if (!$commandArgumentDefinition->isRequired()) {
             $hasOptions = true;
         } else {
             $usage .= sprintf(' <%s>', strtolower(preg_replace('/([A-Z])/', ' $1', $commandArgumentDefinition->getName())));
         }
     }
     $usage = $this->commandManager->getShortestIdentifierForCommand($command) . ($hasOptions ? ' [<options>]' : '') . $usage;
     $this->outputLine();
     $this->outputLine('<b>USAGE:</b>');
     $this->outputLine('  %s %s', [$this->getFlowInvocationString(), $usage]);
     $argumentDescriptions = [];
     $optionDescriptions = [];
     if ($command->hasArguments()) {
         foreach ($commandArgumentDefinitions as $commandArgumentDefinition) {
             $argumentDescription = $commandArgumentDefinition->getDescription();
             $argumentDescription = wordwrap($argumentDescription, $this->output->getMaximumLineLength() - 23, PHP_EOL . str_repeat(' ', 23), true);
             if ($commandArgumentDefinition->isRequired()) {
                 $argumentDescriptions[] = vsprintf('  %-20s %s', [$commandArgumentDefinition->getDashedName(), $argumentDescription]);
             } else {
                 $optionDescriptions[] = vsprintf('  %-20s %s', [$commandArgumentDefinition->getDashedName(), $argumentDescription]);
             }
         }
     }
     if (count($argumentDescriptions) > 0) {
         $this->outputLine();
         $this->outputLine('<b>ARGUMENTS:</b>');
         foreach ($argumentDescriptions as $argumentDescription) {
             $this->outputLine($argumentDescription);
         }
     }
     if (count($optionDescriptions) > 0) {
         $this->outputLine();
         $this->outputLine('<b>OPTIONS:</b>');
         foreach ($optionDescriptions as $optionDescription) {
             $this->outputLine($optionDescription);
         }
     }
     if ($command->getDescription() !== '') {
         $this->outputLine();
         $this->outputLine('<b>DESCRIPTION:</b>');
         $descriptionLines = explode(chr(10), $command->getDescription());
         foreach ($descriptionLines as $descriptionLine) {
             $this->outputLine('%-2s%s', [' ', $descriptionLine]);
         }
     }
     $relatedCommandIdentifiers = $command->getRelatedCommandIdentifiers();
     if ($relatedCommandIdentifiers !== []) {
         $this->outputLine();
         $this->outputLine('<b>SEE ALSO:</b>');
         foreach ($relatedCommandIdentifiers as $commandIdentifier) {
             try {
                 $command = $this->commandManager->getCommandByIdentifier($commandIdentifier);
                 $this->outputLine('%-2s%s (%s)', [' ', $commandIdentifier, $command->getShortDescription()]);
             } catch (CommandException $exception) {
                 $this->outputLine('%-2s%s (%s)', [' ', $commandIdentifier, '<i>Command not available</i>']);
             }
         }
     }
     $this->outputLine();
 }