public function Command::getSynopsis in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 vendor/symfony/console/Command/Command.php \Symfony\Component\Console\Command\Command::getSynopsis()

Returns the synopsis for the command.

Parameters

bool $short Whether to show the short version of the synopsis (with options folded) or not:

Return value

string The synopsis

1 call to Command::getSynopsis()

Command::run in vendor/symfony/console/Command/Command.php

Runs the command.

File

vendor/symfony/console/Command/Command.php, line 557

Class

Command

Base class for all commands.

Namespace

Symfony\Component\Console\Command

Code

public function getSynopsis($short = false) {
  $key = $short ? 'short' : 'long';
  if (!isset($this->synopsis[$key])) {
    $this->synopsis[$key] = trim(sprintf('%s %s', $this->name, $this->definition
      ->getSynopsis($short)));
  }
  return $this->synopsis[$key];
}