class ApplicationDescription in Zircon Profile 8.0

@author Jean-François Simon <[e-mail]>

@internal

Hierarchy

• class \Symfony\Component\Console\Descriptor\ApplicationDescription

File

vendor/symfony/console/Descriptor/ApplicationDescription.php, line 22

Namespace

Symfony\Component\Console\Descriptor

class ApplicationDescription {
  const GLOBAL_NAMESPACE = '_global';

  /**
   * @var Application
   */
  private $application;

  /**
   * @var null|string
   */
  private $namespace;

  /**
   * @var array
   */
  private $namespaces;

  /**
   * @var Command[]
   */
  private $commands;

  /**
   * @var Command[]
   */
  private $aliases;

  /**
   * Constructor.
   *
   * @param Application $application
   * @param string|null $namespace
   */
  public function __construct(Application $application, $namespace = null) {
    $this->application = $application;
    $this->namespace = $namespace;
  }

  /**
   * @return array
   */
  public function getNamespaces() {
    if (null === $this->namespaces) {
      $this
        ->inspectApplication();
    }
    return $this->namespaces;
  }

  /**
   * @return Command[]
   */
  public function getCommands() {
    if (null === $this->commands) {
      $this
        ->inspectApplication();
    }
    return $this->commands;
  }

  /**
   * @param string $name
   *
   * @return Command
   *
   * @throws \InvalidArgumentException
   */
  public function getCommand($name) {
    if (!isset($this->commands[$name]) && !isset($this->aliases[$name])) {
      throw new \InvalidArgumentException(sprintf('Command %s does not exist.', $name));
    }
    return isset($this->commands[$name]) ? $this->commands[$name] : $this->aliases[$name];
  }
  private function inspectApplication() {
    $this->commands = array();
    $this->namespaces = array();
    $all = $this->application
      ->all($this->namespace ? $this->application
      ->findNamespace($this->namespace) : null);
    foreach ($this
      ->sortCommands($all) as $namespace => $commands) {
      $names = array();

      /** @var Command $command */
      foreach ($commands as $name => $command) {
        if (!$command
          ->getName()) {
          continue;
        }
        if ($command
          ->getName() === $name) {
          $this->commands[$name] = $command;
        }
        else {
          $this->aliases[$name] = $command;
        }
        $names[] = $name;
      }
      $this->namespaces[$namespace] = array(
        'id' => $namespace,
        'commands' => $names,
      );
    }
  }

  /**
   * @param array $commands
   *
   * @return array
   */
  private function sortCommands(array $commands) {
    $namespacedCommands = array();
    $globalCommands = array();
    foreach ($commands as $name => $command) {
      $key = $this->application
        ->extractNamespace($name, 1);
      if (!$key) {
        $globalCommands['_global'][$name] = $command;
      }
      else {
        $namespacedCommands[$key][$name] = $command;
      }
    }
    ksort($namespacedCommands);
    $namespacedCommands = array_merge($globalCommands, $namespacedCommands);
    foreach ($namespacedCommands as &$commandsSet) {
      ksort($commandsSet);
    }

    // unset reference to keep scope clear
    unset($commandsSet);
    return $namespacedCommands;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApplicationDescription::$aliases	private	property
ApplicationDescription::$application	private	property
ApplicationDescription::$commands	private	property
ApplicationDescription::$namespace	private	property
ApplicationDescription::$namespaces	private	property
ApplicationDescription::getCommand	public	function
ApplicationDescription::getCommands	public	function
ApplicationDescription::getNamespaces	public	function
ApplicationDescription::GLOBAL_NAMESPACE		constant
ApplicationDescription::inspectApplication	private	function
ApplicationDescription::sortCommands	private	function
ApplicationDescription::__construct	public	function	Constructor.