class DocsCommands extends DrushCommands (View source)

Topic commands.

Any commandfile may add topics. Set 'topic' => TRUE to indicate the command is a topic (REQUIRED) Begin the topic name with the name of the commandfile (just like any other command).

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.

readme()

README.md

bisect()

Drush's support for Git Bisect.

bashrc()

Bashrc customization examples for Drush.

config()

Drush configuration example.

hooks()

Drush hooks.

configExport()

Drupal config export instructions, including customizing config by environment.

outputFormatsFilters()

Output formatters and filters: control the command output

siteAliases()

Creating site aliases for running Drush on remote sites.

script()

An example Drush script.

bootstrap()

Bootstrap explanation: how Drush starts up and prepares the Drupal environment.

cron()

Crontab instructions for running your Drupal cron tasks via drush cron.

commands()

Instructions on creating your own Drush commands.

generators()

Instructions on creating your own Drush Generators.

exampleCommand()

Example Drush command file.

syncHttp()

Extend sql-sync to allow transfer of the sql dump file via http.

policy()

Example policy file.

deploy()

Deploy command for Drupal.

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.

readme()

README.md

bisect()

Drush's support for Git Bisect.

bashrc()

Bashrc customization examples for Drush.

config()

Drush configuration example.

hooks()

Drush hooks.

configExport()

Drupal config export instructions, including customizing config by environment.

outputFormatsFilters()

Output formatters and filters: control the command output

siteAliases()

Creating site aliases for running Drush on remote sites.

script()

An example Drush script.

bootstrap()

Bootstrap explanation: how Drush starts up and prepares the Drupal environment.

cron()

Crontab instructions for running your Drupal cron tasks via drush cron.

commands()

Instructions on creating your own Drush commands.

generators()

Instructions on creating your own Drush Generators.

exampleCommand()

Example Drush command file.

syncHttp()

Extend sql-sync to allow transfer of the sql dump file via http.

policy()

Example policy file.

deploy()

Deploy command for Drupal.