final class DrupalCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

CRON

REQUIREMENTS

ROUTE

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(CronInterface $cron, ModuleHandlerInterface $moduleHandler, RouteProviderInterface $routeProvider)

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.

CronInterface
getCron()

No description

ModuleHandlerInterface
getModuleHandler()

No description

RouteProviderInterface
getRouteProvider()

No description

static DrupalCommands
create(ContainerInterface $container)

No description

void
cron()

Run all cron hooks in all active modules for specified site.

RowsOfFields
requirements($options = ['format' => 'table', 'severity' => -1, 'ignore' => ''])

Information about things that may be wrong in your Drupal installation.

route($options = ['name' => self::REQ, 'path' => self::REQ, 'format' => 'yaml'])

View information about all routes or one route.

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(CronInterface $cron, ModuleHandlerInterface $moduleHandler, RouteProviderInterface $routeProvider)

No description

Parameters

CronInterface $cron
ModuleHandlerInterface $moduleHandler
RouteProviderInterface $routeProvider

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.

CronInterface getCron()

No description

Return Value

CronInterface

ModuleHandlerInterface getModuleHandler()

No description

Return Value

ModuleHandlerInterface

RouteProviderInterface getRouteProvider()

No description

Return Value

RouteProviderInterface

static DrupalCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

DrupalCommands

void cron()

Run all cron hooks in all active modules for specified site.

Consider using drush maint:status && drush core:cron to avoid cache poisoning during maintenance mode.

Return Value

void

RowsOfFields requirements($options = ['format' => 'table', 'severity' => -1, 'ignore' => ''])

Information about things that may be wrong in your Drupal installation.

Parameters

$options

Return Value

RowsOfFields

route($options = ['name' => self::REQ, 'path' => self::REQ, 'format' => 'yaml'])

View information about all routes or one route.

Parameters

$options