class CliCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

Properties

protected CommandData $commandData from  DrushCommands

Methods

getConfig()

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

__construct()

No description

io()

Override Robo's IO function with our custom style.

LoggerInterface
logger()

Returns a logger object.

printFile(string $file)

Print the contents of a file.

preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

HandlerStack
getStack()

Get a Guzzle handler stack that uses the Drush logger.

docs()

Drush's PHP Shell.

cli(array $options = ['version-history' => false, 'cwd' => self::REQ])

No description

array
getDrushCommands()

Returns a filtered list of Drush commands used for CLI commands.

getCasters()

No description

historyPath(array $options)

No description

array
getPhpKeywords()

Returns a list of PHP keywords.

Details

DrushConfig getConfig()

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

__construct()

protected io()

Override Robo's IO function with our custom style.

protected LoggerInterface logger()

Returns a logger object.

Return Value

LoggerInterface

protected printFile(string $file)

Print the contents of a file.

Parameters

string $file Full path to a file.

preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

Parameters

CommandData $commandData

protected printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

Parameters

CommandData $commandData Full path to a file.

protected HandlerStack getStack()

Get a Guzzle handler stack that uses the Drush logger.

docs()

Drush's PHP Shell.

cli(array $options = ['version-history' => false, 'cwd' => self::REQ])

Parameters

array $options

protected array getDrushCommands()

Returns a filtered list of Drush commands used for CLI commands.

Return Value

array

protected getCasters()

protected historyPath(array $options)

Parameters

array $options

protected array getPhpKeywords()

Returns a list of PHP keywords.

This will act as a blocklist for command and alias names.

Return Value

array