DocsCommands
final class DocsCommands extends DrushCommands (View source)
Topic commands.
Any commandfile may add topics. Us ethe Topic attribute to indicate the command is a topic
Traits
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
| README |
|
| BISECT |
|
| CONFIGURATION |
|
| HOOKS |
|
| CONFIG_EXPORTING |
|
| OUTPUT_FORMATS_FILTERS |
|
| ALIASES |
|
| SCRIPT |
|
| BOOTSTRAP |
|
| CRON |
|
| COMMANDS |
|
| GENERATORS |
|
| EXAMPLECOMMAND |
|
| MIGRATE |
|
| EXAMPLE_SYNC_VIA_HTTP |
|
| POLICY |
|
| DEPLOY |
|
Properties
| protected CommandData|null | $commandData | from DrushCommands |
Methods
Starts a background browser/tab for the current site or a specified URL.
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
README.md
Drush docs for Git Bisect.
Drush configuration.
Drush hooks.
Drupal config export instructions, including customizing config by environment.
Output formatters and filters: control the command output
Creating site aliases for running Drush on remote sites.
An example Drush script.
Bootstrap explanation: how Drush starts up and prepares the Drupal environment.
Crontab instructions for running your Drupal cron tasks via drush cron.
Instructions on creating your own Drush commands.
Instructions on creating your own Drush Generators.
Example Drush command file.
Defining and running migrations.
Extend sql-sync to allow transfer of the sql dump file via http.
Example policy file.
Deploy command for Drupal.
Details
bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)
Starts a background browser/tab for the current site or a specified URL.
Uses a non-blocking Process call, so Drush execution will continue.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
DrushConfig
getConfig()
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
__construct()
No description
protected SymfonyStyle
io()
Override Robo's IO function with our custom style.
protected DrushLoggerManager|null
logger()
Returns a logger object.
protected void
printFile(string $file)
Print the contents of a file.
preHook(CommandData $commandData)
Persist commandData for use in primary command callback. Used by 'topic' commands.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
void
readme()
README.md
void
bisect()
Drush docs for Git Bisect.
void
config()
Drush configuration.
void
hooks()
Drush hooks.
void
configExport()
Drupal config export instructions, including customizing config by environment.
void
outputFormatsFilters()
Output formatters and filters: control the command output
void
siteAliases()
Creating site aliases for running Drush on remote sites.
void
script()
An example Drush script.
void
bootstrap()
Bootstrap explanation: how Drush starts up and prepares the Drupal environment.
void
cron()
Crontab instructions for running your Drupal cron tasks via drush cron.
void
commands()
Instructions on creating your own Drush commands.
void
generators()
Instructions on creating your own Drush Generators.
void
exampleCommand()
Example Drush command file.
void
migrate()
Defining and running migrations.
void
syncHttp()
Extend sql-sync to allow transfer of the sql dump file via http.
void
policy()
Example policy file.
void
deploy()
Deploy command for Drupal.