diff --git a/api/Consolidation/AnnotatedCommand/Attributes/Hook.html b/api/Consolidation/AnnotatedCommand/Attributes/Hook.html index ce1ce79c2b..b3901b5ff9 100644 --- a/api/Consolidation/AnnotatedCommand/Attributes/Hook.html +++ b/api/Consolidation/AnnotatedCommand/Attributes/Hook.html @@ -86,7 +86,7 @@

Hook

class - Hook (View source) + Hook (View source)

@@ -130,7 +130,7 @@

Details

- + __construct(string $type, string|null $target = null, string|null $selector = null) @@ -160,7 +160,7 @@

Parameters

string|null $selector -

A 'tag' that requests that a hoof operate on the current command.

+

A 'tag' that requests that a hook operate on the current command.

@@ -174,7 +174,7 @@

Parameters

- + static handle(ReflectionAttribute $attribute, CommandInfo $commandInfo) diff --git a/api/Consolidation/OutputFormatters/Options/FormatterOptions.html b/api/Consolidation/OutputFormatters/Options/FormatterOptions.html index a242e1495b..dd2c950495 100644 --- a/api/Consolidation/OutputFormatters/Options/FormatterOptions.html +++ b/api/Consolidation/OutputFormatters/Options/FormatterOptions.html @@ -86,7 +86,7 @@

FormatterOptions

class - FormatterOptions (View source) + FormatterOptions (View source)

@@ -724,7 +724,7 @@

Methods

- type + FormatterOptions
setInput(InputInterface $input) @@ -752,7 +752,7 @@

Details

- + __construct(array $configurationData = [], array $options = []) @@ -803,7 +803,7 @@

See also

- + FormatterOptions override(array $configurationData) @@ -846,7 +846,7 @@

Return Value

- + setTableStyle($style) @@ -880,7 +880,7 @@

Parameters

- + setDelimiter($delimiter) @@ -914,7 +914,7 @@

Parameters

- + setCsvEnclosure($enclosure) @@ -948,7 +948,7 @@

Parameters

- + setCsvEscapeChar($escapeChar) @@ -982,7 +982,7 @@

Parameters

- + setListDelimiter($listDelimiter) @@ -1016,7 +1016,7 @@

Parameters

- + setIncludeFieldLables($includFieldLables) @@ -1050,7 +1050,7 @@

Parameters

- + setListOrientation($listOrientation) @@ -1084,7 +1084,7 @@

Parameters

- + setRowLabels($rowLabels) @@ -1118,7 +1118,7 @@

Parameters

- + setDefaultFields($fields) @@ -1152,7 +1152,7 @@

Parameters

- + setFieldLabels($fieldLabels) @@ -1186,7 +1186,7 @@

Parameters

- + setTableEmptyMessage($emptyMessage) @@ -1220,7 +1220,7 @@

Parameters

- + setTableDefaultFields($defaultTableFields) @@ -1254,7 +1254,7 @@

Parameters

- + setDefaultStringField($defaultStringField) @@ -1288,7 +1288,7 @@

Parameters

- + setWidth($width) @@ -1322,7 +1322,7 @@

Parameters

- + setHumanReadable($isHumanReadable = true) @@ -1356,7 +1356,7 @@

Parameters

- + mixed get(string $key, array $defaults = [], mixed $default = false) @@ -1408,7 +1408,7 @@

Return Value

- + mixed fields(array $defaults = [], mixed $default = false) @@ -1458,7 +1458,7 @@

Return Value

- + fieldsContain($fieldName) @@ -1493,7 +1493,7 @@

Parameters

- + protected fieldAlias($fieldName) @@ -1527,7 +1527,7 @@

Parameters

- + XmlSchema getXmlSchema() @@ -1560,7 +1560,7 @@

Return Value

- + string getFormat(array $defaults = []) @@ -1602,7 +1602,7 @@

Return Value

- + protected mixed fetch(string $key, array $defaults = [], mixed $default = false) @@ -1654,7 +1654,7 @@

Return Value

- + protected array defaultsForKey(string $key, array $defaults, $default = false) @@ -1707,7 +1707,7 @@

Return Value

- + protected array fetchRawValues(array $defaults = []) @@ -1749,7 +1749,7 @@

Return Value

- + protected mixed parse(string $key, mixed $value) @@ -1797,7 +1797,7 @@

Return Value

- + array parsePropertyList(string $value) @@ -1839,7 +1839,7 @@

Return Value

- + protected string getOptionFormat(string $key) @@ -1882,7 +1882,7 @@

Return Value

- + FormatterOptions setConfigurationData(array $configurationData) @@ -1924,7 +1924,7 @@

Return Value

- + protected FormatterOptions setConfigurationValue(string $key, mixed $value) @@ -1971,7 +1971,7 @@

Return Value

- + FormatterOptions setConfigurationDefault(string $key, mixed $value) @@ -2019,7 +2019,7 @@

Return Value

- + array getConfigurationData() @@ -2051,7 +2051,7 @@

Return Value

- + FormatterOptions setOptions(array $options) @@ -2093,7 +2093,7 @@

Return Value

- + FormatterOptions setOption(string $key, mixed $value) @@ -2140,7 +2140,7 @@

Return Value

- + array getOptions() @@ -2172,8 +2172,8 @@

Return Value

- - type + + FormatterOptions setInput(InputInterface $input)

@@ -2201,7 +2201,7 @@

Return Value

- +
typeFormatterOptions
@@ -2215,7 +2215,7 @@

Return Value

- + array getInputOptions(array $defaults) diff --git a/api/Drush/Commands/core/DocsCommands.html b/api/Drush/Commands/core/DocsCommands.html index c4ba8d9961..4ac963ed31 100644 --- a/api/Drush/Commands/core/DocsCommands.html +++ b/api/Drush/Commands/core/DocsCommands.html @@ -3,7 +3,7 @@ - Drush\Commands\core\DocsCommands | Drush API %version% + Drush\Commands\core\DocsCommands | Drush API 13 @@ -57,7 +57,7 @@ - Drush API %version% + Drush API 13

- IO
+ IO
- ConfigAwareTrait
+ ConfiguresPrompts
+
+
+ +
+ +
+
+
@@ -331,6 +346,15 @@

Constants

+ + + +
+ DRUPAL_DEPENDENCIES + +

+

+
@@ -339,6 +363,66 @@

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + +
+

Backwards compatibility.

+
+
+ +

Return Value

+ +
+ protected + + $urifrom  +ExecTrait
+ protected ConfigInterface + + $configfrom  +ConfigAwareTrait
+ protected InputInterface + + $inputfrom  +InputAwareTrait
+ protected OutputInterface + + $outputfrom  +OutputAwareTrait
+ protected + + $iofrom  +IO
+ protected + + $objfrom  +IO
protected CommandData|null @@ -391,31 +475,254 @@

Methods

- DrushConfig + $this +
+
+ setConfig(ConfigInterface $config) + +

Set the config management object.

+ +
+
+
+ ConfigInterface
getConfig() -

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

- +

Get the config management object.

+ + +
+
+ static 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  +
+
+ configClassIdentifier($classname) + +

No description

+
+ +
+
+
+ static  +
+
+ configPostfix() + +

No description

+
+ +
+
+
+ static  +
+
+ configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

No description

+
+ +
+
+
+ mixed|null +
+
+ getConfigValue(string $key, mixed|null $default = null) + +

No description

+
+ +
+
+
+ $this +
+
+ setInput(InputInterface $input) + +

No description

+
+ +
+
+
+ InputInterface +
+
+ input() + +

No description

+
+ +
+
+
+ InputInterface +
+
+ getInput() + deprecated +

Backwards compatibility.

+ +
+
+
+ $this +
+
+ setOutput(OutputInterface $output) + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ output() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ stderr() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ getOutput() + deprecated +

Backwards compatibility

+ +
+
+
+ +
+
+ currentState() + +

No description

+
+
from  +IO
- __construct() + __construct($obj, $input, $output, $io)

No description

- +
from  +IO
+
+
+
+ +
+
+ restore() + +

No description

+
+
from  +IO
+
+
+
+ void +
+
+ configurePrompts(InputInterface $input) + +

Configure the prompt fallbacks.

+ +
+
+
+ mixed +
+
+ promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) + +

Prompt the user until the given validation callback passes.

+ +
+
+
+ void +
+
+ restorePrompts() + +

Restore the prompts output.

+ +
+
+
+ bool +
+
+ runningUnitTests() + +

No description

+
+
- SymfonyStyle + DrushStyle
io() @@ -451,7 +758,7 @@

Methods

- preHook(CommandData $commandData) + preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

- printFileTopic(CommandData $commandData) + initHook($input, AnnotationData $annotationData) + +

Configure Laravel prompts package.

+ +
+
+
+ +
+
+ printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

+
+
+ +
+ processManager() + +

This method overrides the trait in order to provide a more specific return type.

+
@@ -649,18 +978,735 @@

Methods

Deploy command for Drupal.

+
+
+ void +
+
+ drupalDependencies() + +

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.

+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + +
string|null$uri

Optional URI or site path to open in browser. If omitted, or if a site path +is specified, the current site home page uri will be prepended if the site's +hostname resolves.

int$sleep
int|null$port
string|bool$browser
+ + +

Return Value

+ + + + + + +
bool

TRUE if browser was opened. FALSE if browser was disabled by the user or a +default browser could not be found.

+ + + + +
+
+ +
+
+

+ + static bool + programExists($program) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
$program
+ + +

Return Value

+ + + + + + +
bool
+ + + + +
+
+ +
+
+

+ + static string + getEditor(string|null $editor = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
string|null$editor
+ + +

Return Value

+ + + + + + +
string
+ + + + +
+
+ +
+
+

+ + $this + setConfig(ConfigInterface $config) + +

+
+ + + +
+

Set the config management object.

+
+
+

Parameters

+ + + + + + + +
ConfigInterface$config
+ + +

Return Value

+ + + + + + +
$this
+ + + + +
+
+ +
+
+

+ + ConfigInterface + getConfig() + +

+
+ + + +
+

Get the config management object.

+
+
+ +

Return Value

+ + + + + + +
ConfigInterface
+ + + + +
+
+ +
+
+

+ + 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().

+
+
+ +

Return Value

+ + + + + + +
string
+ + + + +
+
+ +
+
+

+ + static protected + configClassIdentifier($classname) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
$classname
+ + + + + +
+
+ +
+
+

+ + static protected + configPostfix() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + static + configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$key
mixed$value
ConfigInterface|null$config
+ + + + + +
+
+ +
+
+

+ + protected mixed|null + getConfigValue(string $key, mixed|null $default = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$key
mixed|null$default
+ + +

Return Value

+ + + + + + +
mixed|null
+ + + + +
+
+ +
+
+

+ + $this + setInput(InputInterface $input) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Symfony\Component\Console\Input\InputAwareInterface::setInput() +
+ + +
+
+ +
+
+

+ + protected InputInterface + input() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + protected InputInterface + getInput() + deprecated +

+
+

+ deprecated +

+ + + + +
InputInterface
+ + + + +
+ + + +
+

+ + $this + setOutput(OutputInterface $output) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
OutputInterface$output
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Robo\Contract\OutputAwareInterface::setOutput() +
+ + +
+
+ +
+
+

+ + protected OutputInterface + output() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + + + +
+
+ +
+
+

+ + protected OutputInterface + stderr() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + + + +
+
+
+
+

+ + protected OutputInterface + getOutput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility

+
+
+ +

Return Value

+ + + + + +
OutputInterface
-

Details

+ + + +
+
-
+
-

- - bool - startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false) +

+ + + currentState()

@@ -668,47 +1714,61 @@

-

Starts a background browser/tab for the current site or a specified URL.

Uses a non-blocking Process call, so Drush execution will continue.

+

No description

+ +
+
+ + + + +
+

+ +

+
+

+ + + __construct($obj, $input, $output, $io) + +

+
+ + + +
+

No description

+

Parameters

- - - + + + - - + + - - + + - - + +
string|null$uri

Optional URI or site path to open in browser. If omitted, or if a site path -is specified, the current site home page uri will be prepended if the site's -hostname resolves.

$obj
int$sleep$input
int|null$port$output
string|bool$browser$io
-

Return Value

- - - - - - -
bool

if browser was opened. FALSE if browser was disabled by the user or a -default browser could not be found.

- @@ -717,11 +1777,11 @@

Return Value

-

- - static bool - programExists($program) +

+ + + restore()

@@ -733,12 +1793,36 @@

+ + + + +
+

+ +
+
+

+ + protected void + configurePrompts(InputInterface $input) + +

+
+ + + +
+

Configure the prompt fallbacks.

+
+

Parameters

- - + +
$programInputInterface$input
@@ -748,7 +1832,7 @@

Return Value

- +
boolvoid
@@ -761,11 +1845,11 @@

Return Value

-

- - static string - getEditor(string|null $editor = null) +

+ + protected mixed + promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

@@ -773,16 +1857,25 @@

-

No description

- +

Prompt the user until the given validation callback passes.

Parameters

- - + + + + + + + + + + + +
string|null$editorClosure$prompt
bool|string$required
Closure|null$validate
@@ -792,7 +1885,7 @@

Return Value

- +
stringmixed
@@ -805,11 +1898,11 @@

Return Value

-

- - DrushConfig - getConfig() +

+ + protected void + restorePrompts()

@@ -817,8 +1910,7 @@

-

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

+

Restore the prompts output.

@@ -826,35 +1918,24 @@

Return Value

- +
DrushConfigvoid
-

See also

- - - - - - -
- https://stackoverflow.com/a/37687295. -
-

-

- - - __construct() +

+ + protected bool + runningUnitTests()

@@ -867,6 +1948,15 @@

+

Return Value

+ + + + + + +
bool
+ @@ -877,8 +1967,8 @@

- protected SymfonyStyle +DrushCommands at line 60

+ protected DrushStyle io()

@@ -895,7 +1985,7 @@

Return Value

- +
SymfonyStyleDrushStyle
@@ -910,8 +2000,8 @@

Return Value

- protected DrushLoggerManager|null +DrushCommands at line 74

+ DrushLoggerManager|null logger()

@@ -943,7 +2033,7 @@

Return Value

protected void printFile(string $file) @@ -986,9 +2076,9 @@

Return Value

- preHook(CommandData $commandData) + preHook(CommandData $commandData)

@@ -1003,7 +2093,7 @@

Parameters

- + @@ -1013,6 +2103,45 @@

Parameters

+ + + + +
+

+ + + initHook($input, AnnotationData $annotationData) + +

+
+ + + +
+

Configure Laravel prompts package.

+
+
+

Parameters

+ +
CommandDataCommandData $commandData
+ + + + + + + + + + +
$input
AnnotationData$annotationData
+ + + + +
@@ -1020,9 +2149,9 @@

Parameters

protected - printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)

@@ -1037,7 +2166,7 @@

Parameters

- + @@ -1054,7 +2183,7 @@

Parameters

protected HandlerStack getStack() @@ -1091,13 +2220,46 @@

See also

CommandDataCommandData $commandData

Full path to a file.

+
+
+ +
+
+

+ + ProcessManager + processManager() + +

+
+ + + +
+

This method overrides the trait in order to provide a more specific return type.

+
+
+ +

Return Value

+ + + + + + +
ProcessManager
+ + + +

- + void readme() @@ -1129,7 +2291,7 @@

Return Value

- + void bisect() @@ -1161,7 +2323,7 @@

Return Value

- + void config() @@ -1193,7 +2355,7 @@

Return Value

- + void hooks() @@ -1225,7 +2387,7 @@

Return Value

- + void configExport() @@ -1257,7 +2419,7 @@

Return Value

- + void outputFormatsFilters() @@ -1289,7 +2451,7 @@

Return Value

- + void siteAliases() @@ -1321,7 +2483,7 @@

Return Value

- + void script() @@ -1353,7 +2515,7 @@

Return Value

- + void bootstrap() @@ -1385,7 +2547,7 @@

Return Value

- + void cron() @@ -1417,7 +2579,7 @@

Return Value

- + void commands() @@ -1449,7 +2611,7 @@

Return Value

- + void generators() @@ -1481,7 +2643,7 @@

Return Value

- + void exampleCommand() @@ -1513,7 +2675,7 @@

Return Value

- + void migrate() @@ -1545,7 +2707,7 @@

Return Value

- + void syncHttp() @@ -1577,7 +2739,7 @@

Return Value

- + void policy() @@ -1609,7 +2771,7 @@

Return Value

- + void deploy() @@ -1635,6 +2797,38 @@

Return Value

+
+
+ +
+
+

+ + void + drupalDependencies() + +

+
+ + + +
+

Inspecting Drupal dependencies.

+
+
+ +

Return Value

+ + + + + + +
void
+ + + +
diff --git a/api/Drush/Commands/core/DrupalDependenciesCommands.html b/api/Drush/Commands/core/DrupalDependenciesCommands.html new file mode 100644 index 0000000000..83500ca371 --- /dev/null +++ b/api/Drush/Commands/core/DrupalDependenciesCommands.html @@ -0,0 +1,2382 @@ + + + + + + Drush\Commands\core\DrupalDependenciesCommands | Drush API 13 + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+
+ +
+ +
+
+ + +
+ +
+
+ + + +

final class + DrupalDependenciesCommands extends DrushCommands (View source) +

+ + + + + +
+

Drush commands revealing Drupal dependencies.

+ +

Traits

+ + +
+
+
+ ProcessManagerAwareTrait
+
+
+
+ +
+
+ +
+
+ LoggerAwareTrait
+
+
+
+
+ IO
+
+
+ + +
+ +
+
+ +
+ +

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ REQ + +

+

+
+ OPT + +

+

+
+ EXIT_SUCCESS + +

+

+
+ EXIT_FAILURE + +

+

+
+ EXIT_FAILURE_WITH_CLARITY + +

+

+
+ WHY_MODULE + +

+

+
+ WHY_CONFIG + +

+

+
+ private + CIRCULAR_REFERENCE + +

+

+
+ + +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ protected + + $urifrom  +ExecTrait
+ protected ConfigInterface + + $configfrom  +ConfigAwareTrait
+ protected InputInterface + + $inputfrom  +InputAwareTrait
+ protected OutputInterface + + $outputfrom  +OutputAwareTrait
+ protected + + $iofrom  +IO
+ protected + + $objfrom  +IO
+ protected CommandData|null + + $commandDatafrom  +DrushCommands
+ + +

Methods

+ +
+
+
+ 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.

+ +
+
+
+ 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 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  +
+
+ configClassIdentifier($classname) + +

No description

+
+ +
+
+
+ static  +
+
+ configPostfix() + +

No description

+
+ +
+
+
+ static  +
+
+ configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

No description

+
+ +
+
+
+ mixed|null +
+
+ getConfigValue(string $key, mixed|null $default = null) + +

No description

+
+ +
+
+
+ $this +
+
+ setInput(InputInterface $input) + +

No description

+
+ +
+
+
+ InputInterface +
+
+ input() + +

No description

+
+ +
+
+
+ InputInterface +
+
+ getInput() + deprecated +

Backwards compatibility.

+ +
+
+
+ $this +
+
+ setOutput(OutputInterface $output) + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ output() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ stderr() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ getOutput() + deprecated +

Backwards compatibility

+ +
+
+
+ +
+
+ currentState() + +

No description

+
+
from  +IO
+
+
+
+ +
+
+ __construct(ModuleExtensionList $moduleExtensionList, array $installedModules) + +

No description

+
+
+
+
+
+ +
+
+ restore() + +

No description

+
+
from  +IO
+
+
+
+ void +
+
+ configurePrompts(InputInterface $input) + +

Configure the prompt fallbacks.

+ +
+
+
+ mixed +
+
+ promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) + +

Prompt the user until the given validation callback passes.

+ +
+
+
+ void +
+
+ restorePrompts() + +

Restore the prompts output.

+ +
+
+
+ bool +
+
+ runningUnitTests() + +

No description

+
+ +
+
+
+ DrushStyle +
+
+ io() + +

Override Robo's IO function with our custom style.

+ +
+
+
+ DrushLoggerManager|null +
+
+ logger() + +

Returns a logger object.

+ +
+
+
+ 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.

+ +
+
+
+ +
+
+ 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.

+ +
+
+ +
+ processManager() + +

This method overrides the trait in order to provide a more specific return type.

+ +
+
+ +
+ create(ContainerInterface $container) + +

No description

+
+
+
+
+
+ UnstructuredData|null +
+
+ dependentsOfModule(string $module, array $options = ['type' => InputOption::VALUE_REQUIRED, 'only-installed' => true, 'format' => '']) + +

No description

+
+
+
+
+
+ void +
+
+ validateDependentsOfModule(CommandData $commandData) + +

No description

+
+
+
+
+
+ UnstructuredData|null +
+
+ dependentsOfConfig(string $config, array $options = ['format' => '']) + +

No description

+
+
+
+
+
+ void +
+
+ validateDependentsOfConfig(CommandData $commandData) + +

No description

+
+
+
+
+
+ void +
+
+ buildTree(string $dependency, array $path = []) + +

Builds the nested dependency tree.

+
+
+
+ +
+ buildDependents(array $dependenciesPerDependent) + +

Build the reverse the relation: dependent -> dependencies.

+
+
+
+
+ void +
+
+ scanConfigs(bool $scanModuleDependencies = true) + +

Scans all config entities and store their module and config 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.

+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + +
string|null$uri

Optional URI or site path to open in browser. If omitted, or if a site path +is specified, the current site home page uri will be prepended if the site's +hostname resolves.

int$sleep
int|null$port
string|bool$browser
+ + +

Return Value

+ + + + + + +
bool

TRUE if browser was opened. FALSE if browser was disabled by the user or a +default browser could not be found.

+ + + + +
+
+ +
+
+

+ + static bool + programExists($program) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
$program
+ + +

Return Value

+ + + + + + +
bool
+ + + + +
+
+ +
+
+

+ + static string + getEditor(string|null $editor = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
string|null$editor
+ + +

Return Value

+ + + + + + +
string
+ + + + +
+
+ +
+
+

+ + $this + setConfig(ConfigInterface $config) + +

+
+ + + +
+

Set the config management object.

+
+
+

Parameters

+ + + + + + + +
ConfigInterface$config
+ + +

Return Value

+ + + + + + +
$this
+ + + + +
+
+ +
+
+

+ + ConfigInterface + getConfig() + +

+
+ + + +
+

Get the config management object.

+
+
+ +

Return Value

+ + + + + + +
ConfigInterface
+ + + + +
+
+ +
+
+

+ + 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().

+
+
+ +

Return Value

+ + + + + + +
string
+ + + + +
+
+ +
+
+

+ + static protected + configClassIdentifier($classname) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
$classname
+ + + + + +
+
+ +
+
+

+ + static protected + configPostfix() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + static + configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$key
mixed$value
ConfigInterface|null$config
+ + + + + +
+
+ +
+
+

+ + protected mixed|null + getConfigValue(string $key, mixed|null $default = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$key
mixed|null$default
+ + +

Return Value

+ + + + + + +
mixed|null
+ + + + +
+
+ +
+
+

+ + $this + setInput(InputInterface $input) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Symfony\Component\Console\Input\InputAwareInterface::setInput() +
+ + +
+
+ +
+
+

+ + protected InputInterface + input() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + protected InputInterface + getInput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility.

+
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + $this + setOutput(OutputInterface $output) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
OutputInterface$output
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Robo\Contract\OutputAwareInterface::setOutput() +
+ + +
+
+ +
+
+

+ + protected OutputInterface + output() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + + + +
+
+ +
+
+

+ + protected OutputInterface + stderr() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + + + +
+
+ +
+
+

+ + protected OutputInterface + getOutput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility

+
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + + + +
+
+ +
+
+

+ + + currentState() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + + __construct(ModuleExtensionList $moduleExtensionList, array $installedModules) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
ModuleExtensionList$moduleExtensionList
array$installedModules
+ + + + + +
+
+ +
+
+

+ + + restore() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + protected void + configurePrompts(InputInterface $input) + +

+
+ + + +
+

Configure the prompt fallbacks.

+
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected mixed + promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) + +

+
+ + + +
+

Prompt the user until the given validation callback passes.

+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
Closure$prompt
bool|string$required
Closure|null$validate
+ + +

Return Value

+ + + + + + +
mixed
+ + + + +
+
+ +
+
+

+ + protected void + restorePrompts() + +

+
+ + + +
+

Restore the prompts output.

+
+
+ +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected bool + runningUnitTests() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
bool
+ + + + +
+
+ +
+
+

+ + protected DrushStyle + io() + +

+
+ + + +
+

Override Robo's IO function with our custom style.

+
+
+ +

Return Value

+ + + + + + +
DrushStyle
+ + + + +
+
+ +
+
+

+ + DrushLoggerManager|null + logger() + +

+
+ + + +
+

Returns a logger object.

+
+
+ +

Return Value

+ + + + + + +
DrushLoggerManager|null
+ + + + +
+
+ +
+
+

+ + protected void + printFile(string $file) + +

+
+ + + +
+

Print the contents of a file.

+
+
+

Parameters

+ + + + + + + +
string$file

Full path to a file.

+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + + preHook(CommandData $commandData) + +

+
+ + + +
+

Persist commandData for use in primary command callback. Used by 'topic' commands.

+
+
+

Parameters

+ + + + + + + +
CommandData$commandData
+ + + + + +
+
+ +
+
+

+ + + initHook($input, AnnotationData $annotationData) + +

+
+ + + +
+

Configure Laravel prompts package.

+
+
+

Parameters

+ + + + + + + + + + + + +
$input
AnnotationData$annotationData
+ + + + + +
+
+ +
+
+

+ + 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.

+
+
+ +

Return Value

+ + + + + + +
HandlerStack
+ + + +

See also

+ + + + + + +
+ https://stackoverflow.com/questions/32681165/how-do-you-log-all-api-calls-using-guzzle-6. +
+ + +
+
+ +
+
+

+ + ProcessManager + processManager() + +

+
+ + + +
+

This method overrides the trait in order to provide a more specific return type.

+
+
+ +

Return Value

+ + + + + + +
ProcessManager
+ + + + +
+
+ +
+
+

+ + static DrupalDependenciesCommands + create(ContainerInterface $container) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
ContainerInterface$container
+ + +

Return Value

+ + + + + + +
DrupalDependenciesCommands
+ + + + +
+
+ +
+
+

+ + UnstructuredData|null + dependentsOfModule(string $module, array $options = ['type' => InputOption::VALUE_REQUIRED, 'only-installed' => true, 'format' => '']) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$module
array$options
+ + +

Return Value

+ + + + + + +
UnstructuredData|null
+ + + + +
+
+ +
+
+

+ + void + validateDependentsOfModule(CommandData $commandData) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
CommandData$commandData
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + UnstructuredData|null + dependentsOfConfig(string $config, array $options = ['format' => '']) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$config
array$options
+ + +

Return Value

+ + + + + + +
UnstructuredData|null
+ + + + +
+
+ +
+
+

+ + void + validateDependentsOfConfig(CommandData $commandData) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
CommandData$commandData
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected void + buildTree(string $dependency, array $path = []) + +

+
+ + + +
+

Builds the nested dependency tree.

+
+
+

Parameters

+ + + + + + + + + + + + +
string$dependency
array$path
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected DrupalDependenciesCommands + buildDependents(array $dependenciesPerDependent) + +

+
+ + + +
+

Build the reverse the relation: dependent -> dependencies.

+
+
+

Parameters

+ + + + + + + +
array$dependenciesPerDependent
+ + +

Return Value

+ + + + + + +
DrupalDependenciesCommands
+ + + + +
+
+ +
+
+

+ + protected void + scanConfigs(bool $scanModuleDependencies = true) + +

+
+ + + +
+

Scans all config entities and store their module and config dependencies.

+
+
+

Parameters

+ + + + + + + +
bool$scanModuleDependencies
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+ + +
+
+ + + diff --git a/api/Drush/Commands/core/EntityCommands.html b/api/Drush/Commands/core/EntityCommands.html index 0d87f4dba5..12338a55f5 100644 --- a/api/Drush/Commands/core/EntityCommands.html +++ b/api/Drush/Commands/core/EntityCommands.html @@ -86,7 +86,7 @@

EntityCommands

final class - EntityCommands extends DrushCommands implements StdinAwareInterface (View source) + EntityCommands extends DrushCommands implements StdinAwareInterface (View source)

@@ -643,7 +643,7 @@

Methods

initHook($input, AnnotationData $annotationData) -

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

@@ -740,7 +740,7 @@

Methods

void
- loadSave(string $entity_type, $ids = null, array $options = ['bundle' => self::REQ, 'exclude' => self::REQ, 'chunks' => 50, 'publish' => false, 'unpublish' => false, 'state' => self::REQ]) + loadSave(string $entity_type, $ids = null, array $options = ['bundle' => self::REQ, 'exclude' => self::REQ, 'chunks' => 50, 'publish' => false, 'unpublish' => false, 'state' => self::REQ, 'limit' => null])

Re-save entities, and publish/unpublish is specified.

@@ -775,7 +775,7 @@

Details

bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false) @@ -836,7 +836,7 @@

Return Value

static bool programExists($program) @@ -880,7 +880,7 @@

Return Value

static string getEditor(string|null $editor = null) @@ -924,7 +924,7 @@

Return Value

$this setConfig(ConfigInterface $config) @@ -967,7 +967,7 @@

Return Value

ConfigInterface getConfig() @@ -1000,7 +1000,7 @@

Return Value

static protected string configPrefix() @@ -1036,7 +1036,7 @@

Return Value

static protected configClassIdentifier($classname) @@ -1071,7 +1071,7 @@

Parameters

static protected configPostfix() @@ -1096,7 +1096,7 @@

static configure(string $key, mixed $value, ConfigInterface|null $config = null) @@ -1141,7 +1141,7 @@

Parameters

protected mixed|null getConfigValue(string $key, mixed|null $default = null) @@ -1190,7 +1190,7 @@

Return Value

$this setInput(InputInterface $input) @@ -1245,7 +1245,7 @@

See also

protected InputInterface input() @@ -1279,7 +1279,7 @@

Return Value

protected InputInterface getInput() deprecated @@ -1319,7 +1319,7 @@

Return Value

$this setOutput(OutputInterface $output) @@ -1374,7 +1374,7 @@

See also

protected OutputInterface output() @@ -1408,7 +1408,7 @@

Return Value

protected OutputInterface stderr() @@ -1442,7 +1442,7 @@

Return Value

protected OutputInterface getOutput() deprecated @@ -1482,7 +1482,7 @@

Return Value

currentState() @@ -1506,7 +1506,7 @@

- + __construct(EntityTypeManagerInterface $entityTypeManager, TimeInterface $time, AccountInterface $currentUser) @@ -1551,7 +1551,7 @@

Parameters

restore() @@ -1576,7 +1576,7 @@

protected void configurePrompts(InputInterface $input) @@ -1619,7 +1619,7 @@

Return Value

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) @@ -1672,7 +1672,7 @@

Return Value

protected void restorePrompts() @@ -1705,7 +1705,7 @@

Return Value

protected bool runningUnitTests() @@ -1739,7 +1739,7 @@

Return Value

protected DrushStyle io() @@ -1772,7 +1772,7 @@

Return Value

DrushLoggerManager|null logger() @@ -1805,7 +1805,7 @@

Return Value

protected void printFile(string $file) @@ -1848,7 +1848,7 @@

Return Value

preHook(CommandData $commandData) @@ -1882,7 +1882,7 @@

Parameters

initHook($input, AnnotationData $annotationData) @@ -1892,7 +1892,7 @@

-

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

Parameters

@@ -1921,7 +1921,7 @@

Parameters

protected printFileTopic(CommandData $commandData) @@ -1955,7 +1955,7 @@

Parameters

protected HandlerStack getStack() @@ -1999,7 +1999,7 @@

See also

ProcessManager processManager() @@ -2032,7 +2032,7 @@

Return Value

static AutowireTrait create(ContainerInterface $container) @@ -2075,7 +2075,7 @@

Return Value

setStdinHandler(StdinHandler $stdin) @@ -2110,7 +2110,7 @@

Parameters

stdin() @@ -2134,7 +2134,7 @@

- + void delete(string $entity_type, $ids = null, array $options = ['bundle' => self::REQ, 'exclude' => self::REQ, 'chunks' => 50, 'limit' => null]) @@ -2186,7 +2186,7 @@

Return Value

- + void doDelete(string $entity_type, array $ids) @@ -2250,9 +2250,9 @@

Exceptions

- + void - loadSave(string $entity_type, $ids = null, array $options = ['bundle' => self::REQ, 'exclude' => self::REQ, 'chunks' => 50, 'publish' => false, 'unpublish' => false, 'state' => self::REQ]) + loadSave(string $entity_type, $ids = null, array $options = ['bundle' => self::REQ, 'exclude' => self::REQ, 'chunks' => 50, 'publish' => false, 'unpublish' => false, 'state' => self::REQ, 'limit' => null])

@@ -2302,7 +2302,7 @@

Return Value

- + void doSave(string $entity_type, array $ids, string|null $action, string|null $state) @@ -2376,7 +2376,7 @@

Exceptions

- + protected QueryInterface getQuery(string $entity_type, string|null $ids, array $options) diff --git a/api/Drush/Commands/core/UserCommands.html b/api/Drush/Commands/core/UserCommands.html index 63d8e54ba8..1bb09c0cd6 100644 --- a/api/Drush/Commands/core/UserCommands.html +++ b/api/Drush/Commands/core/UserCommands.html @@ -3,7 +3,7 @@ - Drush\Commands\core\UserCommands | Drush API %version% + Drush\Commands\core\UserCommands | Drush API 13 @@ -57,7 +57,7 @@ - Drush API %version% + Drush API 13

- IO
+ IO
@@ -135,7 +135,17 @@

Traits

- ConfigAwareTrait
+ ConfigAwareTrait
+
+

+
+ +
+
+ @@ -291,6 +301,56 @@

Properties

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 @@ -345,15 +405,204 @@

Methods

- DrushConfig + $this +
+
+ setConfig(ConfigInterface $config) + +

Set the config management object.

+ +
+
+
+ ConfigInterface
getConfig() -

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

- +

Get the config management object.

+ + +
+
+ static 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  +
+
+ configClassIdentifier($classname) + +

No description

+
+ +
+
+
+ static  +
+
+ configPostfix() + +

No description

+
+ +
+
+
+ static  +
+
+ configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

No description

+
+ +
+
+
+ mixed|null +
+
+ getConfigValue(string $key, mixed|null $default = null) + +

No description

+
+ +
+
+
+ $this +
+
+ setInput(InputInterface $input) + +

No description

+
+ +
+
+
+ InputInterface +
+
+ input() + +

No description

+
+ +
+
+
+ InputInterface +
+
+ getInput() + deprecated +

Backwards compatibility.

+ +
+
+
+ $this +
+
+ setOutput(OutputInterface $output) + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ output() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ stderr() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ getOutput() + deprecated +

Backwards compatibility

+ +
+
+
+ +
+
+ currentState() + +

No description

+
+
from  +IO
+
+
+
+ +
+
+ __construct(DateFormatterInterface $dateFormatter) + +

No description

+
+
+
+
+
+ +
+
+ restore() + +

No description

+
+
from  +IO
@@ -399,17 +648,6 @@

Methods

-
-
-
- -
-
- __construct(DateFormatterInterface $dateFormatter) - -

No description

-
-
@@ -449,7 +687,7 @@

Methods

- preHook(CommandData $commandData) + preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

- initHook($input, AnnotationData $annotationData) + initHook($input, AnnotationData $annotationData) -

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

@@ -471,7 +709,7 @@

Methods

- printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

information(string $names = '', $options = ['format' => 'table', 'uid' => self::REQ, 'mail' => self::REQ]) @@ -525,7 +763,7 @@

Methods

- renderRolesCell($key, $cellData, FormatterOptions $options) + renderRolesCell($key, $cellData, FormatterOptions $options)

No description

@@ -586,7 +824,7 @@

Methods

void
- createValidate(CommandData $commandData) + createValidate(CommandData $commandData)

Assure that provided username is available.

@@ -651,7 +889,7 @@

Details

bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false) @@ -712,7 +950,7 @@

Return Value

static bool programExists($program) @@ -756,7 +994,7 @@

Return Value

static string getEditor(string|null $editor = null) @@ -798,11 +1036,11 @@

Return Value

-

- - DrushConfig - getConfig() +

+ + $this + setConfig(ConfigInterface $config)

@@ -810,44 +1048,42 @@

-

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

+

Set the config management object.

+

Parameters

+ + + + + + + +
ConfigInterface$config
+

Return Value

- +
DrushConfig$this
-

See also

- - - - - - -
- https://stackoverflow.com/a/37687295. -
-

-

- - protected void - configurePrompts(InputInterface $input) +

+ + ConfigInterface + getConfig()

@@ -855,25 +1091,15 @@

-

Configure the prompt fallbacks.

+

Get the config management object.

-

Parameters

- - - - - - - -
InputInterface$input
-

Return Value

- +
voidConfigInterface
@@ -886,11 +1112,11 @@

Return Value

-

- - protected mixed - promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) +

+ + static protected string + configPrefix()

@@ -898,35 +1124,18 @@

-

Prompt the user until the given validation callback passes.

+

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().

-

Parameters

- - - - - - - - - - - - - - - - - -
Closure$prompt
bool|string$required
Closure|null$validate
-

Return Value

- +
mixedstring
@@ -939,11 +1148,11 @@

Return Value

-

- - protected void - restorePrompts() +

+ + static protected + configClassIdentifier($classname)

@@ -951,32 +1160,371 @@

-

Restore the prompts output.

+

No description

+
- -

Return Value

+

Parameters

- - - - -
void
- - - - + + + $classname + + + + + + + + +
+

+ +

+
+

+ + static protected + configPostfix() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + static + configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$key
mixed$value
ConfigInterface|null$config
+ + + + + +
+
+ +
+
+

+ + protected mixed|null + getConfigValue(string $key, mixed|null $default = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$key
mixed|null$default
+ + +

Return Value

+ + + + + + +
mixed|null
+ + + + +
+
+ +
+
+

+ + $this + setInput(InputInterface $input) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Symfony\Component\Console\Input\InputAwareInterface::setInput() +
+ + +
+
+ +
+
+

+ + protected InputInterface + input() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + protected InputInterface + getInput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility.

+
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + $this + setOutput(OutputInterface $output) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
OutputInterface$output
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Robo\Contract\OutputAwareInterface::setOutput() +
+ + +
+
+ +
+
+

+ + protected OutputInterface + output() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + + +
-

- - protected bool - runningUnitTests() +

+ + protected OutputInterface + stderr()

@@ -993,7 +1541,47 @@

Return Value

- + + + +
boolOutputInterface
+ + + + +
+

+ +

+
+

+ + protected OutputInterface + getOutput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility

+
+
+ +

Return Value

+ + + +
OutputInterface
@@ -1001,13 +1589,38 @@

Return Value

+
+
+ +
+
+

+ + + currentState() + +

+
+ + + +
+

No description

+ +
+
+ + + +

- + __construct(DateFormatterInterface $dateFormatter) @@ -1035,6 +1648,194 @@

Parameters

+
+

+ +

+
+

+ + + restore() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + protected void + configurePrompts(InputInterface $input) + +

+
+ + + +
+

Configure the prompt fallbacks.

+
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected mixed + promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) + +

+
+ + + +
+

Prompt the user until the given validation callback passes.

+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
Closure$prompt
bool|string$required
Closure|null$validate
+ + +

Return Value

+ + + + + + +
mixed
+ + + + +
+
+ +
+
+

+ + protected void + restorePrompts() + +

+
+ + + +
+

Restore the prompts output.

+
+
+ +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected bool + runningUnitTests() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
bool
+ + + +
@@ -1042,7 +1843,7 @@

Parameters

protected DrushStyle io() @@ -1075,7 +1876,7 @@

Return Value

DrushLoggerManager|null logger() @@ -1108,7 +1909,7 @@

Return Value

protected void printFile(string $file) @@ -1151,9 +1952,9 @@

Return Value

- preHook(CommandData $commandData) + preHook(CommandData $commandData)

@@ -1168,7 +1969,7 @@

Parameters

- + @@ -1185,9 +1986,9 @@

Parameters

- initHook($input, AnnotationData $annotationData) + initHook($input, AnnotationData $annotationData)
@@ -1195,7 +1996,7 @@

-

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

Parameters

@@ -1207,7 +2008,7 @@

Parameters

- + @@ -1224,9 +2025,9 @@

Parameters

protected - printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)
@@ -1241,7 +2042,7 @@

Parameters

CommandDataCommandData $commandData
AnnotationDataAnnotationData $annotationData
- + @@ -1258,7 +2059,7 @@

Parameters

protected HandlerStack getStack() @@ -1302,7 +2103,7 @@

See also

ProcessManager processManager() @@ -1335,7 +2136,7 @@

Return Value

static AutowireTrait create(ContainerInterface $container) @@ -1377,8 +2178,8 @@

Return Value

- - RowsOfFields + + RowsOfFields information(string $names = '', $options = ['format' => 'table', 'uid' => self::REQ, 'mail' => self::REQ])

@@ -1410,7 +2211,7 @@

Return Value

CommandDataCommandData $commandData

Full path to a file.

- +
RowsOfFieldsRowsOfFields
@@ -1424,9 +2225,9 @@

Return Value

- + - renderRolesCell($key, $cellData, FormatterOptions $options) + renderRolesCell($key, $cellData, FormatterOptions $options)

@@ -1452,7 +2253,7 @@

Parameters

- FormatterOptions + FormatterOptions $options @@ -1468,7 +2269,7 @@

Parameters

- + void block(string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ]) @@ -1515,7 +2316,7 @@

Return Value

- + void unblock(string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ]) @@ -1562,7 +2363,7 @@

Return Value

- + void addRole(string $role, string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ]) @@ -1614,7 +2415,7 @@

Return Value

- + void removeRole(string $role, string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ]) @@ -1666,7 +2467,7 @@

Return Value

- + CommandError createUser(string $name, $options = ['format' => 'table', 'password' => self::REQ, 'mail' => self::REQ]) @@ -1713,9 +2514,9 @@

Return Value

- + void - createValidate(CommandData $commandData) + createValidate(CommandData $commandData)

@@ -1730,7 +2531,7 @@

Parameters

- + @@ -1755,7 +2556,7 @@

Return Value

- + void cancel(string $names = '', $options = ['delete-content' => false, 'reassign-content' => false, 'uid' => self::REQ, 'mail' => self::REQ]) @@ -1806,7 +2607,7 @@

Return Value

- + void password(string $name, string $password) @@ -1853,7 +2654,7 @@

Return Value

- + array infoArray($account) @@ -1895,7 +2696,7 @@

Return Value

- + protected array getAccounts(string $names = '', array $options = []) @@ -1951,7 +2752,7 @@

Exceptions

- + void roleComplete(CompletionInput $input, CompletionSuggestions $suggestions) diff --git a/api/Drush/Commands/core/WatchdogCommands.html b/api/Drush/Commands/core/WatchdogCommands.html index 3a7ffa7527..316a1dd6b0 100644 --- a/api/Drush/Commands/core/WatchdogCommands.html +++ b/api/Drush/Commands/core/WatchdogCommands.html @@ -3,7 +3,7 @@ - Drush\Commands\core\WatchdogCommands | Drush API %version% + Drush\Commands\core\WatchdogCommands | Drush API 13 @@ -57,7 +57,7 @@ - Drush API %version% + Drush API 13

- IO
+ IO
@@ -135,7 +135,17 @@

Traits

- ConfigAwareTrait
+ ConfigAwareTrait
+
+ +
+ +
+
+ @@ -246,6 +256,56 @@

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandDataCommandData $commandData
from  ExecTrait
+ protected ConfigInterface + + $configfrom  +ConfigAwareTrait
+ protected InputInterface + + $inputfrom  +InputAwareTrait
+ protected OutputInterface + + $outputfrom  +OutputAwareTrait
+ protected + + $iofrom  +IO
+ protected + + $objfrom  +IO
@@ -300,15 +360,204 @@

Methods

- DrushConfig + $this +
+
+ setConfig(ConfigInterface $config) + +

Set the config management object.

+ +
+
+
+ ConfigInterface
getConfig() -

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

- +

Get the config management object.

+ + +
+
+ static 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  +
+
+ configClassIdentifier($classname) + +

No description

+
+ +
+
+
+ static  +
+
+ configPostfix() + +

No description

+
+ +
+
+
+ static  +
+
+ configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

No description

+
+ +
+
+
+ mixed|null +
+
+ getConfigValue(string $key, mixed|null $default = null) + +

No description

+
+ +
+
+
+ $this +
+
+ setInput(InputInterface $input) + +

No description

+
+ +
+
+
+ InputInterface +
+
+ input() + +

No description

+
+ +
+
+
+ InputInterface +
+
+ getInput() + deprecated +

Backwards compatibility.

+ +
+
+
+ $this +
+
+ setOutput(OutputInterface $output) + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ output() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ stderr() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ getOutput() + deprecated +

Backwards compatibility

+ +
+
+
+ +
+
+ currentState() + +

No description

+
+
from  +IO
+
+
+
+ +
+
+ __construct(Connection $connection) + +

No description

+
+
+
+
+
+ +
+
+ restore() + +

No description

+
+
from  +IO
@@ -354,17 +603,6 @@

Methods

-
-
-
- -
-
- __construct(Connection $connection) - -

No description

-
-
@@ -404,7 +642,7 @@

Methods

- preHook(CommandData $commandData) + preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

- initHook($input, AnnotationData $annotationData) + initHook($input, AnnotationData $annotationData) -

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

@@ -426,7 +664,7 @@

Methods

- printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

showOne($id, $options = ['format' => 'yaml']) @@ -576,7 +814,7 @@

Details

bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false) @@ -637,7 +875,7 @@

Return Value

static bool programExists($program) @@ -681,7 +919,7 @@

Return Value

static string getEditor(string|null $editor = null) @@ -723,11 +961,11 @@

Return Value

-

- - DrushConfig - getConfig() +

+ + $this + setConfig(ConfigInterface $config)

@@ -735,44 +973,42 @@

-

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

+

Set the config management object.

+

Parameters

+ + + + + + + +
ConfigInterface$config
+

Return Value

- +
DrushConfig$this
-

See also

- - - - - - -
- https://stackoverflow.com/a/37687295. -
-

-

- - protected void - configurePrompts(InputInterface $input) +

+ + ConfigInterface + getConfig()

@@ -780,25 +1016,15 @@

-

Configure the prompt fallbacks.

+

Get the config management object.

-

Parameters

- - - - - - - -
InputInterface$input
-

Return Value

- +
voidConfigInterface
@@ -811,11 +1037,11 @@

Return Value

-

- - protected mixed - promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) +

+ + static protected string + configPrefix()

@@ -823,35 +1049,18 @@

-

Prompt the user until the given validation callback passes.

+

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().

-

Parameters

- - - - - - - - - - - - - - - - - -
Closure$prompt
bool|string$required
Closure|null$validate
-

Return Value

- +
mixedstring
@@ -864,11 +1073,11 @@

Return Value

-

- - protected void - restorePrompts() +

+ + static protected + configClassIdentifier($classname)

@@ -876,32 +1085,371 @@

-

Restore the prompts output.

+

No description

+
- -

Return Value

+

Parameters

- - - - -
void
- - - +

$classname
+ + + + + +
+
+ +
+
+

+ + static protected + configPostfix() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + static + configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$key
mixed$value
ConfigInterface|null$config
+ + + + + +
+
+ +
+
+

+ + protected mixed|null + getConfigValue(string $key, mixed|null $default = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$key
mixed|null$default
+ + +

Return Value

+ + + + + + +
mixed|null
+ + + + +
+
+ +
+
+

+ + $this + setInput(InputInterface $input) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Symfony\Component\Console\Input\InputAwareInterface::setInput() +
+ + +
+
+ +
+
+

+ + protected InputInterface + input() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + protected InputInterface + getInput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility.

+
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + $this + setOutput(OutputInterface $output) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
OutputInterface$output
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Robo\Contract\OutputAwareInterface::setOutput() +
+ + +
+
+ +
+
+

+ + protected OutputInterface + output() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
OutputInterface
+ + +
-

- - protected bool - runningUnitTests() +

+ + protected OutputInterface + stderr()

@@ -918,7 +1466,47 @@

Return Value

- + + + +
boolOutputInterface
+ + + + +
+

+ +
+
+

+ + protected OutputInterface + getOutput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility

+
+
+ +

Return Value

+ + + +
OutputInterface
@@ -926,13 +1514,38 @@

Return Value

+
+
+ +
+
+

+ + + currentState() + +

+
+ + + +
+

No description

+ +
+
+ + + +

- + __construct(Connection $connection) @@ -960,6 +1573,194 @@

Parameters

+
+ + + +
+

+ + + restore() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + protected void + configurePrompts(InputInterface $input) + +

+
+ + + +
+

Configure the prompt fallbacks.

+
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected mixed + promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) + +

+
+ + + +
+

Prompt the user until the given validation callback passes.

+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
Closure$prompt
bool|string$required
Closure|null$validate
+ + +

Return Value

+ + + + + + +
mixed
+ + + + +
+
+ +
+
+

+ + protected void + restorePrompts() + +

+
+ + + +
+

Restore the prompts output.

+
+
+ +

Return Value

+ + + + + + +
void
+ + + + +
+
+ +
+
+

+ + protected bool + runningUnitTests() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
bool
+ + + +
@@ -967,7 +1768,7 @@

Parameters

protected DrushStyle io() @@ -1000,7 +1801,7 @@

Return Value

DrushLoggerManager|null logger() @@ -1033,7 +1834,7 @@

Return Value

protected void printFile(string $file) @@ -1076,9 +1877,9 @@

Return Value

- preHook(CommandData $commandData) + preHook(CommandData $commandData)
@@ -1093,7 +1894,7 @@

Parameters

- + @@ -1110,9 +1911,9 @@

Parameters

- initHook($input, AnnotationData $annotationData) + initHook($input, AnnotationData $annotationData)
@@ -1120,7 +1921,7 @@

-

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

Parameters

@@ -1132,7 +1933,7 @@

Parameters

- + @@ -1149,9 +1950,9 @@

Parameters

protected - printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)
@@ -1166,7 +1967,7 @@

Parameters

CommandDataCommandData $commandData
AnnotationDataAnnotationData $annotationData
- + @@ -1183,7 +1984,7 @@

Parameters

protected HandlerStack getStack() @@ -1227,7 +2028,7 @@

See also

ProcessManager processManager() @@ -1260,7 +2061,7 @@

Return Value

static AutowireTrait create(ContainerInterface $container) @@ -1302,7 +2103,7 @@

Return Value

- + RowsOfFields|null show($substring = '', $options = ['format' => 'table', 'count' => 10, 'severity' => self::REQ, 'severity-min' => self::REQ, 'type' => self::REQ, 'extended' => false]) @@ -1349,7 +2150,7 @@

Return Value

- + RowsOfFields|null watchdogList($substring = '', $options = ['format' => 'table', 'count' => 10, 'extended' => false]) @@ -1396,7 +2197,7 @@

Return Value

- + void tail(OutputInterface $output, $substring = '', $options = ['severity' => self::REQ, 'severity-min' => self::REQ, 'type' => self::REQ, 'extended' => false]) @@ -1448,7 +2249,7 @@

Return Value

- + void interactList($input, $output) @@ -1496,7 +2297,7 @@

Return Value

- + void delete($substring = '', $options = ['severity' => self::REQ, 'type' => self::REQ]) @@ -1543,8 +2344,8 @@

Return Value

- - PropertyList + + PropertyList showOne($id, $options = ['format' => 'yaml'])

@@ -1576,7 +2377,7 @@

Return Value

CommandDataCommandData $commandData

Full path to a file.

- +
PropertyListPropertyList
@@ -1590,7 +2391,7 @@

Return Value

- + protected array where(string|null $type = null, $severity = null, string|null $filter = null, string $criteria = 'AND', int|string|null $severity_min = null) @@ -1652,7 +2453,7 @@

Return Value

- + protected stdClass formatResult(stdClass $result, bool $extended = false) @@ -1699,7 +2500,7 @@

Return Value

- + static array messageTypes() @@ -1731,7 +2532,7 @@

Return Value

- + void watchdogComplete(CompletionInput $input, CompletionSuggestions $suggestions) diff --git a/api/Drush/Commands/generate/ApplicationFactory.html b/api/Drush/Commands/generate/ApplicationFactory.html index 712fd9d96f..7eedfad9d7 100644 --- a/api/Drush/Commands/generate/ApplicationFactory.html +++ b/api/Drush/Commands/generate/ApplicationFactory.html @@ -3,7 +3,7 @@ - Drush\Commands\generate\ApplicationFactory | Drush API %version% + Drush\Commands\generate\ApplicationFactory | Drush API 13 @@ -57,7 +57,7 @@ - Drush API %version% + Drush API 13

@@ -228,6 +238,56 @@

Properties

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 @@ -282,15 +342,204 @@

Methods

- DrushConfig + $this +
+
+ setConfig(ConfigInterface $config) + +

Set the config management object.

+ +
+
+
+ ConfigInterface
getConfig() -

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

- +

Get the config management object.

+ + +
+
+ static 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  +
+
+ configClassIdentifier($classname) + +

No description

+
+ +
+
+
+ static  +
+
+ configPostfix() + +

No description

+
+ +
+
+
+ static  +
+
+ configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

No description

+
+ +
+
+
+ mixed|null +
+
+ getConfigValue(string $key, mixed|null $default = null) + +

No description

+
+ +
+
+
+ $this +
+
+ setInput(InputInterface $input) + +

No description

+
+ +
+
+
+ InputInterface +
+
+ input() + +

No description

+
+ +
+
+
+ InputInterface +
+
+ getInput() + deprecated +

Backwards compatibility.

+ +
+
+
+ $this +
+
+ setOutput(OutputInterface $output) + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ output() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ stderr() + +

No description

+
+ +
+
+
+ OutputInterface +
+
+ getOutput() + deprecated +

Backwards compatibility

+ +
+
+
+ +
+
+ currentState() + +

No description

+
+
from  +IO
+
+
+
+ +
+
+ __construct(ConfigFactoryInterface $configFactory, ModuleInstallerInterface $moduleInstaller, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, ModuleExtensionList $extensionListModule, PermissionHandlerInterface $permissionHandler) + +

No description

+
+
+
+
+
+ +
+
+ restore() + +

No description

+
+
from  +IO
@@ -336,17 +585,6 @@

Methods

-
-
-
- -
-
- __construct(ConfigFactoryInterface $configFactory, ModuleInstallerInterface $moduleInstaller, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, ModuleExtensionList $extensionListModule) - -

No description

-
-
@@ -386,7 +624,7 @@

Methods

- preHook(CommandData $commandData) + preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

- initHook($input, AnnotationData $annotationData) + initHook($input, AnnotationData $annotationData) -

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

@@ -408,7 +646,7 @@

Methods

- printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

+
void
@@ -517,7 +766,7 @@

Methods

void
- validateEnableModules(CommandData $commandData) + validateEnableModules(CommandData $commandData)

Run requirements checks on the module installation.

@@ -537,7 +786,7 @@

Methods

void
- validateUninstall(CommandData $commandData) + validateUninstall(CommandData $commandData)

No description

@@ -545,7 +794,7 @@

Methods

- RowsOfFields + RowsOfFields
pmList($options = ['format' => 'table', 'type' => 'module,theme', 'status' => 'enabled,disabled', 'package' => self::REQ, 'core' => false, 'no-core' => false]) @@ -585,6 +834,17 @@

Methods

+
+
+ array +
+
+ getModuleLinks(Extension $module) + +

No description

+
+
+
@@ -594,7 +854,7 @@

Details

bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false) @@ -653,11 +913,549 @@

Return Value

-

- - static bool - programExists($program) +

+ + static bool + programExists($program) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
$program
+ + +

Return Value

+ + + + + + +
bool
+ + + + +
+
+ +

+
+

+ + static string + getEditor(string|null $editor = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
string|null$editor
+ + +

Return Value

+ + + + + + +
string
+ + + + +
+
+ +
+
+

+ + $this + setConfig(ConfigInterface $config) + +

+
+ + + +
+

Set the config management object.

+
+
+

Parameters

+ + + + + + + +
ConfigInterface$config
+ + +

Return Value

+ + + + + + +
$this
+ + + + +
+
+ +
+
+

+ + ConfigInterface + getConfig() + +

+
+ + + +
+

Get the config management object.

+
+
+ +

Return Value

+ + + + + + +
ConfigInterface
+ + + + +
+
+ +
+
+

+ + 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().

+
+
+ +

Return Value

+ + + + + + +
string
+ + + + +
+
+ +
+
+

+ + static protected + configClassIdentifier($classname) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
$classname
+ + + + + +
+
+ +
+
+

+ + static protected + configPostfix() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + static + configure(string $key, mixed $value, ConfigInterface|null $config = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$key
mixed$value
ConfigInterface|null$config
+ + + + + +
+
+ +
+
+

+ + protected mixed|null + getConfigValue(string $key, mixed|null $default = null) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + + + + + + +
string$key
mixed|null$default
+ + +

Return Value

+ + + + + + +
mixed|null
+ + + + +
+
+ +
+
+

+ + $this + setInput(InputInterface $input) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
InputInterface$input
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Symfony\Component\Console\Input\InputAwareInterface::setInput() +
+ + +
+
+ +
+
+

+ + protected InputInterface + input() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + protected InputInterface + getInput() + deprecated +

+
+

+ deprecated + + + + +

+ + + +
+

Backwards compatibility.

+
+
+ +

Return Value

+ + + + + + +
InputInterface
+ + + + +
+
+ +
+
+

+ + $this + setOutput(OutputInterface $output) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
OutputInterface$output
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ \Robo\Contract\OutputAwareInterface::setOutput() +
+ + +
+
+ +
+
+

+ + protected OutputInterface + output()

@@ -669,22 +1467,12 @@

-

Parameters

- - - - - - - -
$program
-

Return Value

- +
boolOutputInterface
@@ -697,11 +1485,11 @@

Return Value

-

- - static string - getEditor(string|null $editor = null) +

+ + protected OutputInterface + stderr()

@@ -713,22 +1501,12 @@

-

Parameters

- - - - - - - -
string|null$editor
-

Return Value

- +
stringOutputInterface
@@ -741,20 +1519,26 @@

Return Value

-

- - DrushConfig - getConfig() - +

+ + protected OutputInterface + getOutput() + deprecated

+

+ deprecated + + + + +

-

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

+

Backwards compatibility

@@ -762,25 +1546,123 @@

Return Value

- +
DrushConfigOutputInterface
-

See also

+ +
+
+ +
+
+

+ + + currentState() + +

+
+ + + +
+

No description

+ +
+
+ + + + +
+
+ +
+
+

+ + + __construct(ConfigFactoryInterface $configFactory, ModuleInstallerInterface $moduleInstaller, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, ModuleExtensionList $extensionListModule, PermissionHandlerInterface $permissionHandler) + +

+
+ + + +
+

No description

+ +
+
+

Parameters

- + + + + + + + + + + + + + + + + + + + + + + + + + + +
- https://stackoverflow.com/a/37687295. - ConfigFactoryInterface$configFactory
ModuleInstallerInterface$moduleInstaller
ModuleHandlerInterface$moduleHandler
ThemeHandlerInterface$themeHandler
ModuleExtensionList$extensionListModule
PermissionHandlerInterface$permissionHandler
+ + + +
+
+ +
+
+

+ + + restore() + +

+
+ + + +
+

No description

+ +
+
+ + + +
@@ -788,7 +1670,7 @@

See also

protected void configurePrompts(InputInterface $input) @@ -831,7 +1713,7 @@

Return Value

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) @@ -884,7 +1766,7 @@

Return Value

protected void restorePrompts() @@ -917,7 +1799,7 @@

Return Value

protected bool runningUnitTests() @@ -944,60 +1826,6 @@

Return Value

-
-

- -
-
-

- - - __construct(ConfigFactoryInterface $configFactory, ModuleInstallerInterface $moduleInstaller, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, ModuleExtensionList $extensionListModule) - -

-
- - - -
-

No description

- -
-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
ConfigFactoryInterface$configFactory
ModuleInstallerInterface$moduleInstaller
ModuleHandlerInterface$moduleHandler
ThemeHandlerInterface$themeHandler
ModuleExtensionList$extensionListModule
- - - - -
@@ -1005,7 +1833,7 @@

Parameters

protected DrushStyle io() @@ -1038,7 +1866,7 @@

Return Value

DrushLoggerManager|null logger() @@ -1071,7 +1899,7 @@

Return Value

protected void printFile(string $file) @@ -1114,9 +1942,9 @@

Return Value

- preHook(CommandData $commandData) + preHook(CommandData $commandData)
@@ -1131,7 +1959,7 @@

Parameters

- + @@ -1148,9 +1976,9 @@

Parameters

- initHook($input, AnnotationData $annotationData) + initHook($input, AnnotationData $annotationData)
@@ -1158,7 +1986,7 @@

-

Persist commandData for use in primary command callback. Used by 'topic' commands.

+

Configure Laravel prompts package.

Parameters

@@ -1170,7 +1998,7 @@

Parameters

- + @@ -1187,9 +2015,9 @@

Parameters

protected - printFileTopic(CommandData $commandData) + printFileTopic(CommandData $commandData)
@@ -1204,7 +2032,7 @@

Parameters

CommandDataCommandData $commandData
AnnotationDataAnnotationData $annotationData
- + @@ -1221,7 +2049,7 @@

Parameters

protected HandlerStack getStack() @@ -1265,7 +2093,7 @@

See also

ProcessManager processManager() @@ -1298,7 +2126,7 @@

Return Value

static AutowireTrait create(ContainerInterface $container) @@ -1340,7 +2168,7 @@

Return Value

- + ConfigFactoryInterface getConfigFactory() @@ -1373,7 +2201,7 @@

Return Value

- + ModuleInstallerInterface getModuleInstaller() @@ -1406,7 +2234,7 @@

Return Value

- + ModuleHandlerInterface getModuleHandler() @@ -1439,7 +2267,7 @@

Return Value

- + ThemeHandlerInterface getThemeHandler() @@ -1472,7 +2300,7 @@

Return Value

- + ModuleExtensionList getExtensionListModule() @@ -1499,13 +2327,46 @@

Return Value

+
+ + + +
+

+ + PermissionHandlerInterface + getPermissionHandler() + +

+
+ + + +
+

No description

+ +
+
+ +

Return Value

+ +
CommandDataCommandData $commandData

Full path to a file.

+ + + + +
PermissionHandlerInterface
+ + + +

- + void install(array $modules) @@ -1547,9 +2408,9 @@

Return Value

- + void - validateEnableModules(CommandData $commandData) + validateEnableModules(CommandData $commandData)

@@ -1564,7 +2425,7 @@

Parameters

- + @@ -1600,7 +2461,7 @@

See also

- + void uninstall(array $modules) @@ -1642,9 +2503,9 @@

Return Value

- + void - validateUninstall(CommandData $commandData) + validateUninstall(CommandData $commandData)

@@ -1660,7 +2521,7 @@

Parameters

CommandDataCommandData $commandData
- + @@ -1685,8 +2546,8 @@

Return Value

- - RowsOfFields + + RowsOfFields pmList($options = ['format' => 'table', 'type' => 'module,theme', 'status' => 'enabled,disabled', 'package' => self::REQ, 'core' => false, 'no-core' => false])

@@ -1713,7 +2574,7 @@

Return Value

CommandDataCommandData $commandData
- +
RowsOfFieldsRowsOfFields
@@ -1727,7 +2588,7 @@

Return Value

- + string extensionStatus($extension) @@ -1769,7 +2630,7 @@

Return Value

- + array addInstallDependencies($modules) @@ -1812,7 +2673,7 @@

Return Value

- + addUninstallDependencies($modules) @@ -1840,6 +2701,49 @@

Parameters

+
+
+ + +
+ +
+ + + +
+

No description

+ +
+
+

Parameters

+ + + + + + + +
Extension$module
+ + +

Return Value

+ + + + + + +
array
+ + + +
diff --git a/api/Drush/Runtime/ServiceManager.html b/api/Drush/Runtime/ServiceManager.html index e52eaca37d..98c689502b 100644 --- a/api/Drush/Runtime/ServiceManager.html +++ b/api/Drush/Runtime/ServiceManager.html @@ -3,7 +3,7 @@ - Drush\Runtime\ServiceManager | Drush API %version% + Drush\Runtime\ServiceManager | Drush API 13 @@ -57,7 +57,7 @@ - Drush API %version% + Drush API 13