final class PmCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

INSTALL

UNINSTALL

LIST

Properties

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

getConfig()

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

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

No description

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

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.

static PmCommands
create(ContainerInterface $container)

No description

ConfigFactoryInterface
getConfigFactory()

No description

ModuleInstallerInterface
getModuleInstaller()

No description

ModuleHandlerInterface
getModuleHandler()

No description

ThemeHandlerInterface
getThemeHandler()

No description

ModuleExtensionList
getExtensionListModule()

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

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

string
extensionStatus($extension)

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

array
addInstallDependencies($modules)

No description

addUninstallDependencies($modules)

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

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

DrushConfig getConfig()

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

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

No description

Parameters

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

protected SymfonyStyle io()

Override Robo's IO function with our custom style.

Return Value

SymfonyStyle

protected 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

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.

static PmCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

PmCommands

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

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

describing extension status. Values: enabled|disabled.

array addInstallDependencies($modules)

No description

Parameters

$modules

Return Value

array

addUninstallDependencies($modules)

No description

Parameters

$modules