classCatalogCommand

packages/sql-catalog/src/Cli/CatalogCommand.php:26

final class CatalogCommand

Public API: explicitly declared with @visibility public.

The sql-catalog command.

Cataloguing a directory and reading the result from standard outputdoctest

$command = new \SqlCatalog\Cli\CatalogCommand();
    $result = $command->run(['--help']);
    $result->exitCode->value // => 0
    str_contains($result->output, 'sql-catalog') // => true

Methods§

public function __construct(
    Analyzer|null $analyzer = null,
    ReporterRegistry|null $reporters = null,
)

source §

Parameters

`$analyzer`	`Analyzer\|null`	The analyzer to run, or null for one with the built-in extensions
`$reporters`	`ReporterRegistry\|null`	The reporters to render with, or null for the built-in ones

Calls 4

new Analyzer line 42
static-call Builtins::reporters() line 43
new CommandLineParser line 44
new ArtifactWriter line 45

public function run(list<string> $arguments): CommandResult

source §

Runs the command with the given arguments.

Parameters

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

Returns

CommandResult

Test cases 8

Calls 5

method-call CatalogCommand::execute() line 56
method-call CommandLineParser::parse() line 56
static-call CommandResult::failure() line 58
class-const ExitCode::InvalidCommandLine() line 58
class-const ExitCode::SourceUnreadable() line 60

public function execute(CommandLine $command): CommandResult

source §

Runs the command for an already parsed command line.

Parameters

$command CommandLine

Returns

CommandResult

Throws

InvalidConfigurationException When the requested configuration cannot be loaded

InvalidCommandLineException When no path was given to analyze

SourceScanException When a path cannot be read

UnknownExtensionException When an extension is not registered

UnknownReporterException When the reporter is not registered

WriteFailureException When the report cannot be written

Test cases 2

Called from 1

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

Calls 5

method-call CatalogCommand::answerQuery() line 76
new InvalidCommandLineException line 81
method-call CatalogCommand::configuredAnalyzer() line 84
new AnalysisOptions line 87
method-call CatalogCommand::report() line 92

public function configuredAnalyzer(Configuration $configuration): Analyzer

source §

Loads the requested configuration, reporting failures as configuration errors.

Parameters

$configuration Configuration

Returns

Analyzer

Throws

InvalidConfigurationException When loading or applying the configuration fails

Test cases 1

CatalogCommandTest::testConfiguredAnalyzerOverridesModelsWithoutLeakingThem calls

Called from 1

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

Calls 3

method-call Analyzer::withConfiguration() line 103
new InvalidConfigurationException line 105
function-call sprintf line 105

public function answerQuery(CommandLine $command): ?CommandResult

source §

The answer to a command line that asks for information, or null when it does not.

Parameters

$command CommandLine

Returns

?CommandResult

Test cases 1

CatalogCommandTest::testAnswerQueryListsTheExtensionsAndTheReporters calls

Called from 1

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

Calls 6

new UsageText line 114
method-call Analyzer::extensions() line 114
static-call CommandResult::ok() line 116
method-call UsageText::help() line 116
method-call UsageText::extensions() line 119
method-call UsageText::reporters() line 122

public function report(CommandLine $command, Catalog $catalog): CommandResult

source §

Renders the catalog where the command line asked for it.

Parameters

`$command`	`CommandLine`
`$catalog`	`Catalog`

Returns

CommandResult

Throws

UnknownReporterException When the reporter is not registered

WriteFailureException When the report cannot be written

Test cases 1

CatalogCommandTest::testReportWritesIntoTheDirectoryItIsGiven calls

Called from 1

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

Calls 5

method-call ReporterRegistry::get() line 133
method-call CatalogCommand::status() line 134
new CommandResult line 137
function-call implode line 137
method-call ArtifactWriter::write() line 140

public function status(CommandLine $command, Catalog $catalog): ExitCode

source §

What to tell the shell about the statements that were found.

Parameters

`$command`	`CommandLine`
`$catalog`	`Catalog`

Returns

ExitCode

Test cases 1

CatalogCommandTest::testStatusReportsFindingsOnlyWhenAskedTo calls

Called from 1

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

Calls 2

class-const ExitCode::Success() line 151
class-const ExitCode::FindingsReported() line 155

Private surface 4§

Implementation details, listed for orientation only.

private Analyzer $analyzer

private ReporterRegistry $reporters

private CommandLineParser $parser

private ArtifactWriter $writer

Test cases 14§

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

Dedicated tests 14