/** * Render help text for a single command * * @param \TYPO3\CMS\Extbase\Mvc\Cli\Command $command * @return void */ protected function displayHelpForCommand(\TYPO3\CMS\Extbase\Mvc\Cli\Command $command) { $this->outputLine(); $this->outputLine($command->getShortDescription()); $this->outputLine(); $this->outputLine('COMMAND:'); $this->outputLine('%-2s%s', array(' ', $command->getCommandIdentifier())); $commandArgumentDefinitions = $command->getArgumentDefinitions(); $usage = ''; $hasOptions = FALSE; foreach ($commandArgumentDefinitions as $commandArgumentDefinition) { if (!$commandArgumentDefinition->isRequired()) { $hasOptions = TRUE; } else { $usage .= sprintf(' <%s>', strtolower(preg_replace('/([A-Z])/', ' $1', $commandArgumentDefinition->getName()))); } } $usage = $this->request->getCallingScript() . ' ' . $this->commandManager->getShortestIdentifierForCommand($command) . ($hasOptions ? ' [<options>]' : '') . $usage; $this->outputLine(); $this->outputLine('USAGE:'); $this->outputLine(' ' . $usage); $argumentDescriptions = array(); $optionDescriptions = array(); 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', array($commandArgumentDefinition->getDashedName(), $argumentDescription)); } else { $optionDescriptions[] = vsprintf(' %-20s %s', array($commandArgumentDefinition->getDashedName(), $argumentDescription)); } } } if (count($argumentDescriptions) > 0) { $this->outputLine(); $this->outputLine('ARGUMENTS:'); foreach ($argumentDescriptions as $argumentDescription) { $this->outputLine($argumentDescription); } } if (count($optionDescriptions) > 0) { $this->outputLine(); $this->outputLine('OPTIONS:'); foreach ($optionDescriptions as $optionDescription) { $this->outputLine($optionDescription); } } if ($command->getDescription() !== '') { $this->outputLine(); $this->outputLine('DESCRIPTION:'); $descriptionLines = explode(chr(10), $command->getDescription()); foreach ($descriptionLines as $descriptionLine) { $this->outputLine('%-2s%s', array(' ', $descriptionLine)); } } $relatedCommandIdentifiers = $command->getRelatedCommandIdentifiers(); if ($relatedCommandIdentifiers !== array()) { $this->outputLine(); $this->outputLine('SEE ALSO:'); foreach ($relatedCommandIdentifiers as $commandIdentifier) { $command = $this->commandManager->getCommandByIdentifier($commandIdentifier); $this->outputLine('%-2s%s (%s)', array(' ', $commandIdentifier, $command->getShortDescription())); } } $this->outputLine(); }
/** * Returns TRUE if the specified command identifier matches the identifier of the specified command. * This is the case, if the identifiers are the same or if at least the last two command parts match (case sensitive). * * @param \TYPO3\CMS\Extbase\Mvc\Cli\Command $command * @param string $commandIdentifier command identifier in the format foo:bar:baz (all lower case) * @return boolean TRUE if the specified command identifier matches this commands identifier */ protected function commandMatchesIdentifier(\TYPO3\CMS\Extbase\Mvc\Cli\Command $command, $commandIdentifier) { $commandIdentifierParts = explode(':', $command->getCommandIdentifier()); $searchedCommandIdentifierParts = explode(':', $commandIdentifier); $extensionKey = array_shift($commandIdentifierParts); if (count($searchedCommandIdentifierParts) === 3) { $searchedExtensionKey = array_shift($searchedCommandIdentifierParts); if ($searchedExtensionKey !== $extensionKey) { return FALSE; } } if (count($searchedCommandIdentifierParts) !== 2) { return FALSE; } return $searchedCommandIdentifierParts === $commandIdentifierParts; }