think\console\Command::getProcessedHelp PHP Method

getProcessedHelp() public method

描述信息
public getProcessedHelp ( ) : string
return string
    public function getProcessedHelp()
    {
        $name = $this->name;
        $placeholders = ['%command.name%', '%command.full_name%'];
        $replacements = [$name, $_SERVER['PHP_SELF'] . ' ' . $name];
        return str_replace($placeholders, $replacements, $this->getHelp());
    }

Usage Example

Exemplo n.º 1
0
 /**
  * 描述指令
  * @param Command $command
  * @param array   $options
  * @return string|mixed
  */
 protected function describeCommand(Command $command, array $options = [])
 {
     $command->getSynopsis(true);
     $command->getSynopsis(false);
     $command->mergeConsoleDefinition(false);
     $this->writeText('<comment>Usage:</comment>', $options);
     foreach (array_merge([$command->getSynopsis(true)], $command->getAliases(), $command->getUsages()) as $usage) {
         $this->writeText("\n");
         $this->writeText('  ' . $usage, $options);
     }
     $this->writeText("\n");
     $definition = $command->getNativeDefinition();
     if ($definition->getOptions() || $definition->getArguments()) {
         $this->writeText("\n");
         $this->describeInputDefinition($definition, $options);
         $this->writeText("\n");
     }
     if ($help = $command->getProcessedHelp()) {
         $this->writeText("\n");
         $this->writeText('<comment>Help:</comment>', $options);
         $this->writeText("\n");
         $this->writeText(' ' . str_replace("\n", "\n ", $help), $options);
         $this->writeText("\n");
     }
 }