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

Methods

getConfig()

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

__construct()

No description

LoggerInterface
logger()

Returns a logger object.

io()

Override Robo's IO function with our custom style.

printFile(string $file)

Print the contents of a file.

readme()

README.md

bisect()

Drush's support for Git Bisect.

bashrc()

Bashrc customization examples for Drush.

config()

Configuration overview with examples from example.drush.yml.

configExport()

Drupal config export instructions, including customizing config by environment.

outputFormatsFilters()

Output formatters and filters: how to control the output produced by Drush commands

siteAliases()

Creating site aliases for running Drush on remote sites.

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.

Details

DrushConfig getConfig()

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

__construct()

protected LoggerInterface logger()

Returns a logger object.

Return Value

LoggerInterface

protected io()

Override Robo's IO function with our custom style.

protected printFile(string $file)

Print the contents of a file.

Parameters

string $file Full path to a file.

readme()

README.md

bisect()

Drush's support for Git Bisect.

bashrc()

Bashrc customization examples for Drush.

config()

Configuration overview with examples from example.drush.yml.

configExport()

Drupal config export instructions, including customizing config by environment.

outputFormatsFilters()

Output formatters and filters: how to control the output produced by Drush commands

siteAliases()

Creating site aliases for running Drush on remote sites.

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.