classCommandLineParser

packages/sql-catalog/src/Cli/CommandLineParser.php:18

final class CommandLineParser

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Reads the arguments the command was invoked with.

Methods§

public function parse(list<string> $arguments): CommandLine

source §

The command line the arguments describe.

Parameters

$arguments list<string> The arguments, without the command name

Returns

CommandLine

Throws

InvalidCommandLineException When an argument is not one the command takes

InvalidConfigurationException When the catalog configuration is invalid

Test cases 15

Called from 1

method-call SqlCatalog\Cli\CatalogCommand::run() packages/sql-catalog/src/Cli/CatalogCommand.php:56

Calls 8

function-call count line 62
function-call str_starts_with line 65
method-call CommandLineParser::readOption() line 69
method-call CommandLineParser::configuration() line 72
method-call CommandLineParser::last() line 72
new Configuration line 72
method-call CommandLineParser::build() line 77
function-call array_replace line 77

public function configuration(?string $path): Configuration

source §

Loads an explicit catalog file or the working directory's .catalog.yaml.

Parameters

$path ?string

Returns

Configuration

Throws

InvalidConfigurationException When the selected file cannot be loaded

Test cases 1

CommandLineParserTest::testConfigurationIsOptionalAndExplicitFilesMustExist calls

Called from 1

method-call SqlCatalog\Cli\CommandLineParser::parse() packages/sql-catalog/src/Cli/CommandLineParser.php:72

Calls 3

static-call Configuration::load() line 88
function-call is_file line 91
new Configuration line 91

public function readOption(
    string $argument,
    list<string> $arguments,
    int $index,
    array<string, list<string>> &$values,
    array<string, bool> &$flags,
): int

source §

Reads one option, consuming the argument after it when the option takes a value.

Parameters

`$argument`	`string`
`$arguments`	`list<string>`
`$index`	`int`
`$values`	`array<string, list<string>>`
`$flags`	`array<string, bool>`

Returns

int

Throws

InvalidCommandLineException When the option is unknown or its value is missing

Test cases 1

CommandLineParserTest::testReadOptionConsumesTheArgumentThatFollows calls

Called from 1

method-call SqlCatalog\Cli\CommandLineParser::parse() packages/sql-catalog/src/Cli/CommandLineParser.php:69

Calls 9

function-call ltrim line 104
function-call str_contains line 106
function-call explode line 107
class-const CommandLineParser::FLAG_OPTIONS() line 110
class-const CommandLineParser::VALUE_OPTIONS() line 115
new InvalidCommandLineException line 117
function-call sprintf line 117
function-call str_starts_with line 121
function-call trim line 125

public function build(
    array<string, list<string>> $values,
    array<string, bool> $flags,
    list<string> $paths,
    Configuration $configuration = new \SqlCatalog\Facade\Configuration(),
): CommandLine

source §

The command line built from the options that were read.

Parameters

`$values`	`array<string, list<string>>`
`$flags`	`array<string, bool>`
`$paths`	`list<string>`
`$configuration`	`Configuration`

Returns

CommandLine

Throws

InvalidCommandLineException When an option was given a value it does not take

Test cases 3

Called from 1

method-call SqlCatalog\Cli\CommandLineParser::parse() packages/sql-catalog/src/Cli/CommandLineParser.php:77

Calls 7

new Configuration line 139
method-call CommandLineParser::last() line 141
function-call in_array line 143
new InvalidCommandLineException line 144
new CommandLine line 147
method-call CommandLineParser::filter() line 152
method-call CommandLineParser::severity() line 155

public function filter(array<string, list<string>> $values): CatalogFilter

source §

The filter the filtering options describe.

Parameters

$values array<string, list<string>>

Returns

CatalogFilter

Throws

InvalidCommandLineException When a kind or severity is not one the command knows

Test cases 1

CommandLineParserTest::testFilterIsEmptyWithoutFilteringOptions calls

Called from 1

method-call SqlCatalog\Cli\CommandLineParser::build() packages/sql-catalog/src/Cli/CommandLineParser.php:152

Calls 3

new CatalogFilter line 173
method-call CommandLineParser::kinds() line 177
method-call CommandLineParser::severity() line 180

public function kinds(list<string> $written): list<StatementKind>

source §

The statement kinds the written names stand for.

Parameters

$written list<string>

Returns

list<StatementKind>

Throws

InvalidCommandLineException When a name is not a statement kind

Test cases 2

Called from 1

method-call SqlCatalog\Cli\CommandLineParser::filter() packages/sql-catalog/src/Cli/CommandLineParser.php:177

Calls 7

static-call StatementKind::tryFrom() line 195
function-call strtolower line 195
new InvalidCommandLineException line 197
function-call sprintf line 197
function-call implode line 200
function-call array_column line 200
static-call StatementKind::cases() line 200

public function severity(array<string, list<string>> $values, string $option): ?Severity

source §

The severity an option was given, or null when it was not given.

Parameters

`$values`	`array<string, list<string>>`
`$option`	`string`

Returns

?Severity

Throws

InvalidCommandLineException When the name is not a severity

Test cases 2

Called from 2

Calls 8

method-call CommandLineParser::last() line 217
static-call Severity::tryFrom() line 221
function-call strtolower line 221
new InvalidCommandLineException line 223
function-call sprintf line 223
function-call implode line 226
function-call array_column line 226
static-call Severity::cases() line 226

public function last(array<string, list<string>> $values, string $option): ?string

source §

The last value an option was given, or null when it was not given.

Parameters

`$values`	`array<string, list<string>>`
`$option`	`string`

Returns

?string

Test cases 1

CommandLineParserTest::testLastTakesTheValueGivenLast calls

Called from 7

Calls 1

function-call count line 242

Private surface 2§

Implementation details, listed for orientation only.

private const VALUE_OPTIONS = ['config' => 'config', 'c' => 'config', 'output' => 'output', 'o' => 'output', …

private const FLAG_OPTIONS = ['help' => 'help', 'h' => 'help', 'list-extensions' => 'list-extensions', 'list…

Test cases 27§

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

Dedicated tests 26

Other tests reaching this symbol 1

CatalogCommandTest calls

Relations§

Instantiated in 1

new SqlCatalog\Cli\CatalogCommand::__construct() packages/sql-catalog/src/Cli/CatalogCommand.php:44

Method calls 1

method-call SqlCatalog\Cli\CatalogCommand::run() packages/sql-catalog/src/Cli/CatalogCommand.php:56

Type declarations 1

type SqlCatalog\Cli\CatalogCommand packages/sql-catalog/src/Cli/CatalogCommand.php:32