final class WatchdogCommands 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

SHOW

LIST

TAIL

DELETE

SHOW_ONE

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(Connection $connection)

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.

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

Show watchdog messages.

RowsOfFields|null
watchdogList($substring = '', $options = ['format' => 'table', 'count' => 10, 'extended' => false])

Interactively filter the watchdog message listing.

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

Tail watchdog messages.

void
interactList($input, $output)

No description

void
delete($substring = '', $options = ['severity' => self::REQ, 'type' => self::REQ])

Delete watchdog log records.

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

Show one log record by ID.

array
where(string|null $type = null, $severity = null, string|null $filter = null, string $criteria = 'AND', int|string|null $severity_min = null)

Build a WHERE snippet based on given parameters.

formatResult(stdClass $result, bool $extended = false)

Format a watchdog database row.

static array
messageTypes()

Helper function to obtain the message types based on drupal version.

void
watchdogComplete(CompletionInput $input, CompletionSuggestions $suggestions)

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(Connection $connection)

No description

Parameters

Connection $connection

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

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

Show watchdog messages.

Parameters

$substring
$options

Return Value

RowsOfFields|null

RowsOfFields|null watchdogList($substring = '', $options = ['format' => 'table', 'count' => 10, 'extended' => false])

Interactively filter the watchdog message listing.

Parameters

$substring
$options

Return Value

RowsOfFields|null

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

Tail watchdog messages.

Parameters

OutputInterface $output
$substring
$options

Return Value

void

void interactList($input, $output)

No description

Parameters

$input
$output

Return Value

void

void delete($substring = '', $options = ['severity' => self::REQ, 'type' => self::REQ])

Delete watchdog log records.

Parameters

$substring
$options

Return Value

void

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

Show one log record by ID.

Parameters

$id
$options

Return Value

PropertyList

protected array where(string|null $type = null, $severity = null, string|null $filter = null, string $criteria = 'AND', int|string|null $severity_min = null)

Build a WHERE snippet based on given parameters.

Example: ('where' => string, 'args' => [])

Parameters

string|null $type

String. Valid watchdog type.

$severity

Int or String for a valid watchdog severity message.

string|null $filter

String. Value to filter watchdog messages by.

string $criteria

('AND', 'OR'). Criteria for the WHERE snippet.

int|string|null $severity_min

Int or String for the minimum severity to return.

Return Value

array

protected stdClass formatResult(stdClass $result, bool $extended = false)

Format a watchdog database row.

Parameters

stdClass $result

A database result object.

bool $extended

Return extended message details.

Return Value

stdClass

The result object with some attributes themed.

static array messageTypes()

Helper function to obtain the message types based on drupal version.

Return Value

array

Array of watchdog message types.

void watchdogComplete(CompletionInput $input, CompletionSuggestions $suggestions)

No description

Parameters

CompletionInput $input
CompletionSuggestions $suggestions

Return Value

void