final class Overview

Shows the application overview when no command, or only help, is requested.

The overview needs no project, so it works without a configuration file.

Methods§

public function requested(Application $console, ArgvInput $input): bool

Tells whether the command line asks for the overview.

Parameters

$consoleApplicationThe application with its global options
$inputArgvInputThe command line; it is not modified

Returns

bool True without a command or with the help command, unless --version is given
Test cases 2
Called from 1
Calls 2
  • method-call Application::getDefinition() line 32
  • function-call in_array line 33
public function show(
    Application $console,
    OutputInterface $output,
    list<string> $arguments,
): void

Writes the overview, honoring --ansi, --no-ansi and --quiet.

Parameters

$consoleApplicationThe application to describe
$outputOutputInterfaceReceives the overview
$argumentslist<string>The command-line arguments
Test cases 3
Called from 1
Calls 6
  • function-call in_array line 49
  • method-call OutputInterface::setDecorated() line 50
  • method-call OutputInterface::setVerbosity() line 56
  • class-const OutputInterface::VERBOSITY_QUIET() line 56
  • method-call DescriptorHelper::describe() line 58
  • new DescriptorHelper line 58

Test cases 7§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 5
Other tests reaching this symbol 2

Relations§

Instantiated in 1
Method calls 2