classCommandLine

packages/sql-catalog/src/Cli/CommandLine.php:16

final class CommandLine

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

What the command was asked to do.

Properties§

public list<string> $paths = []

source §

public string|null $output = null

source §

public string $reporter = 'text'

source §

public list<string> $extensions = ['pdo', 'mysqli']

source §

public CatalogFilter $filter = new \SqlCatalog\Core\Filter\CatalogFilter()

source §

public list<string> $excluded = []

source §

public string $root = '.'

source §

public Severity|null $failOn = null

source §

public bool $help = false

source §

public bool $listExtensions = false

source §

public bool $listReporters = false

source §

public string|null $config = null

source §

public Configuration $configuration = new \SqlCatalog\Facade\Configuration()

source §

public string|null $dialect = null

source §

Methods§

public function __construct(
    public list<string> $paths = [],
    public string|null $output = null,
    public string $reporter = 'text',
    public list<string> $extensions = ['pdo', 'mysqli'],
    public CatalogFilter $filter = new \SqlCatalog\Core\Filter\CatalogFilter(),
    public list<string> $excluded = [],
    public string $root = '.',
    public Severity|null $failOn = null,
    public bool $help = false,
    public bool $listExtensions = false,
    public bool $listReporters = false,
    public string|null $config = null,
    public Configuration $configuration = new \SqlCatalog\Facade\Configuration(),
    public string|null $dialect = null,
)

source §

Parameters

`$paths`	`list<string>`	The files and directories to analyze
`$output`	`string\|null`	The directory to write the report into, or null for standard output
`$reporter`	`string`	The reporter to render with
`$extensions`	`list<string>`	The extensions whose database calls are recognised
`$filter`	`CatalogFilter`	Which of the statements found to keep
`$excluded`	`list<string>`	Patterns of source files to skip
`$root`	`string`	The directory reported paths are relative to
`$failOn`	`Severity\|null`	The severity that makes the run report a failure
`$help`	`bool`	Whether the command was asked for its help
`$listExtensions`	`bool`	Whether the command was asked to list its extensions
`$listReporters`	`bool`	Whether the command was asked to list its reporters
`$config`	`string\|null`	The catalog YAML file selected for this run
`$configuration`	`Configuration`
`$dialect`	`string\|null`	The SQL grammar used by framework builders