final class WatchdogCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

SHOW

LIST

TAIL

DELETE

SHOW_ONE

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

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.

create(ContainerInterface $container)

No description

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.

PropertyList
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 $severity_min = null)

Build a WHERE snippet based on given parameters.

formatResult($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

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

No description

Parameters

Connection $connection

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 WatchdogCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

WatchdogCommands

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 $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 $severity_min

Int or String for the minimum severity to return.

Return Value

array

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

Format a watchdog database row.

Parameters

$result

Array. A database result object.

bool $extended

Boolean. Return extended message details.

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