final class PmCommands extends DrushCommands (View source)

Traits

A copy of \Drupal\Core\DependencyInjection\AutowireTrait with first params' type hint changed.

ProcessManagerAwareTrait
LoggerAwareTrait
IO

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

INSTALL

UNINSTALL

LIST

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

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(ConfigFactoryInterface $configFactory, ModuleInstallerInterface $moduleInstaller, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, ModuleExtensionList $extensionListModule, PermissionHandlerInterface $permissionHandler)

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.

static AutowireTrait
create(ContainerInterface $container)

Instantiates a new instance of the implementing class using autowiring.

ConfigFactoryInterface
getConfigFactory()

No description

ModuleInstallerInterface
getModuleInstaller()

No description

ModuleHandlerInterface
getModuleHandler()

No description

ThemeHandlerInterface
getThemeHandler()

No description

ModuleExtensionList
getExtensionListModule()

No description

PermissionHandlerInterface
getPermissionHandler()

No description

void
install(array $modules)

Enable one or more modules.

void
validateEnableModules(CommandData $commandData)

Run requirements checks on the module installation.

void
uninstall(array $modules)

Uninstall one or more modules and their dependent modules.

void
validateUninstall(CommandData $commandData)

No description

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

Show a list of available extensions (modules and themes).

string
extensionStatus($extension)

Calculate an extension status based on current status and schema version.

array
addInstallDependencies($modules)

No description

addUninstallDependencies($modules)

No description

array
getModuleLinks(Extension $module)

No description

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(ConfigFactoryInterface $configFactory, ModuleInstallerInterface $moduleInstaller, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, ModuleExtensionList $extensionListModule, PermissionHandlerInterface $permissionHandler)

No description

Parameters

ConfigFactoryInterface $configFactory
ModuleInstallerInterface $moduleInstaller
ModuleHandlerInterface $moduleHandler
ThemeHandlerInterface $themeHandler
ModuleExtensionList $extensionListModule
PermissionHandlerInterface $permissionHandler

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.

ProcessManager processManager()

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

Return Value

ProcessManager

static AutowireTrait create(ContainerInterface $container)

Instantiates a new instance of the implementing class using autowiring.

Parameters

ContainerInterface $container

The service container this instance should use.

Return Value

AutowireTrait

ConfigFactoryInterface getConfigFactory()

No description

Return Value

ConfigFactoryInterface

ModuleInstallerInterface getModuleInstaller()

No description

Return Value

ModuleInstallerInterface

ModuleHandlerInterface getModuleHandler()

No description

Return Value

ModuleHandlerInterface

ThemeHandlerInterface getThemeHandler()

No description

Return Value

ThemeHandlerInterface

ModuleExtensionList getExtensionListModule()

No description

Return Value

ModuleExtensionList

PermissionHandlerInterface getPermissionHandler()

No description

Return Value

PermissionHandlerInterface

void install(array $modules)

Enable one or more modules.

Parameters

array $modules

Return Value

void

void validateEnableModules(CommandData $commandData)

Run requirements checks on the module installation.

Parameters

CommandData $commandData

Return Value

void

See also

drupal_check_module()

void uninstall(array $modules)

Uninstall one or more modules and their dependent modules.

Parameters

array $modules

Return Value

void

void validateUninstall(CommandData $commandData)

No description

Parameters

CommandData $commandData

Return Value

void

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

Show a list of available extensions (modules and themes).

Parameters

$options

Return Value

RowsOfFields

string extensionStatus($extension)

Calculate an extension status based on current status and schema version.

Parameters

$extension

Object of a single extension info.

Return Value

string

Status. Values: enabled|disabled.

array addInstallDependencies($modules)

No description

Parameters

$modules

Return Value

array

addUninstallDependencies($modules)

No description

Parameters

$modules

No description

Parameters

Extension $module

Return Value

array