class ListCommands 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.

string
helpList($options = ['format' => 'listcli', 'raw' => false, 'filter' => self::REQ])

List available commands.

buildDom($namespaced, $application)

No description

static 
renderListCLI(Application $application, array $namespaced, OutputInterface $output, string $preamble)

No description

static 
getTerminalWidth()

No description

renderListRaw(array $namespaced)

No description

static Command[]
categorize(Command[] $all, string $separator = ':')

No description

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.

string helpList($options = ['format' => 'listcli', 'raw' => false, 'filter' => self::REQ])

List available commands.

Parameters

$options

Return Value

string

DOMDocument buildDom($namespaced, $application)

Parameters

$namespaced
$application

Return Value

DOMDocument

static renderListCLI(Application $application, array $namespaced, OutputInterface $output, string $preamble)

Parameters

Application $application
array $namespaced
OutputInterface $output
string $preamble

static getTerminalWidth()

renderListRaw(array $namespaced)

Parameters

array $namespaced

static Command[] categorize(Command[] $all, string $separator = ':')

Parameters

Command[] $all
string $separator

Return Value

Command[]