classOptions

packages/requirements/src/Console/Options.php:15

final class Options

The command and the option values given on the command line.

Properties§

public string $command

source §

public array<string, string|bool> $values

source §

Methods§

public function __construct(public string $command, public array<string, string|bool> $values)

source §

Parameters

`$command`	`string`	The command name
`$values`	`array<string, string\|bool>`	Option values by option name

public static function fromInput(string $command, InputInterface $input): self

source §

Reads the global options and the options of a command.

Parameters

`$command`	`string`	The command name
`$input`	`InputInterface`	The parsed command line

Returns

self The options

Test cases 3

Called from 1

static-call Requirements\Console\CommandHandler::__invoke() packages/requirements/src/Console/CommandHandler.php:40

Calls 6

function-call array_column line 36
static-call Options::definitions() line 36
method-call InputInterface::getOption() line 37
function-call is_string line 38
function-call is_bool line 38
new self line 42

public static function definitions(string $command): list<array{string, bool, string}>

source §

Declares the options of a command.

Parameters

$command string The command name

Returns

list<array{string, bool, string}> The name, whether it is a flag, and the description of each option

Test cases 4

Called from 2

public function text(string $name, string|null $default = null): string|null

source §

Returns a value option.

Parameters

`$name`	`string`	The option name
`$default`	`string\|null`	The value when the option is not given

Returns

string|null The value

Test cases 1

OptionsTest::testTextReturnsTheValueOrTheDefault calls

Called from 5

Calls 1

function-call is_string line 93

public function flag(string $name): bool

source §

Tells whether a flag is set.

Parameters

$name string The option name

Returns

bool True when the flag was given

Test cases 1

OptionsTest::testFlagTellsWhetherTheFlagIsSet calls

Called from 11

public function percentage(string $name): float|null

source §

Returns a percentage option.

Parameters

$name string The option name

Returns

float|null The percentage, or null when the option is not given

Throws

InvalidInputException When the value is not a number from 0 to 100

Test cases 2

Called from 1

method-call Requirements\Console\Executor::execute() packages/requirements/src/Console/Executor.php:53

Calls 4

method-call Options::text() line 119
function-call is_numeric line 123
new InvalidInputException line 124
static-call Fields::percentage() line 126

public function matches(Item $item): bool

source §

Tells whether an item passes the spec filters.

Parameters

$item Item The item

Returns

bool True when the item has every given ID, category, status, kind, origin, source and label, and no source under --without-source

Test cases 2

Called from 1

method-call Requirements\Console\SpecificationReport::generate() packages/requirements/src/Console/SpecificationReport.php:28

Calls 3

method-call Options::text() line 139
function-call in_array line 144
method-call Options::flag() line 144

Test cases 40§

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

Dedicated tests 10

Other tests reaching this symbol 30

Relations§

Static calls 2

Method calls 14

Type declarations 4