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 |
|
| DRUPAL_DEPENDENCIES |
|
Properties
| protected | $uri | from ExecTrait | |
| protected ConfigInterface | $config | from ConfigAwareTrait | |
| protected InputInterface | $input | from InputAwareTrait | |
| protected OutputInterface | $output | from OutputAwareTrait | |
| protected | $io | from IO | |
| protected | $obj | from IO | |
| protected CommandData|null | $commandData | from DrushCommands |
Methods
Starts a background browser/tab for the current site or a specified URL.
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
No description
No description
Prompt the user until the given validation callback passes.
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.
This method overrides the trait in order to provide a more specific return type.
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.
Inspecting Drupal dependencies.
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
$this
setConfig(ConfigInterface $config)
Set the config management object.
ConfigInterface
getConfig()
Get the config management object.
static protected string
configPrefix()
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
static protected
configClassIdentifier($classname)
No description
static protected
configPostfix()
No description
static
configure(string $key, mixed $value, ConfigInterface|null $config = null)
No description
protected mixed|null
getConfigValue(string $key, mixed|null $default = null)
No description
$this
setInput(InputInterface $input)
No description
protected InputInterface
input()
No description
protected InputInterface
getInput()
deprecated
deprecated
Backwards compatibility.
$this
setOutput(OutputInterface $output)
No description
protected OutputInterface
output()
No description
protected OutputInterface
stderr()
No description
protected OutputInterface
getOutput()
deprecated
deprecated
Backwards compatibility
in
IO at line 24
currentState()
No description
in
IO at line 32
__construct($obj, $input, $output, $io)
No description
in
IO at line 40
restore()
No description
protected void
configurePrompts(InputInterface $input)
Configure the prompt fallbacks.
protected mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Prompt the user until the given validation callback passes.
protected void
restorePrompts()
Restore the prompts output.
protected bool
runningUnitTests()
No description
protected DrushStyle
io()
Override Robo's IO function with our custom style.
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.
initHook($input, AnnotationData $annotationData)
Configure Laravel prompts package.
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.
ProcessManager
processManager()
This method overrides the trait in order to provide a more specific return type.
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.
void
drupalDependencies()
Inspecting Drupal dependencies.