final class CacheCommands extends DrushCommands implements CustomEventAwareInterface, StdinAwareInterface (View source)

Traits

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

CustomEventAwareTrait
StdinAwareTrait
ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

GET

TAGS

CLEAR

SET

EVENT_CLEAR

Properties

protected $uri from  ExecTrait
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.

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

__construct(CacheTagsInvalidatorInterface $invalidator, Registry $themeRegistry, RouteBuilderInterface $routerBuilder, JsCollectionOptimizerLazy $jsOptimizer, $cssOptimizer, CachedDiscoveryClearerInterface $pluginCacheClearer, BootstrapManager $bootstrapManager, AssetQueryStringInterface $assetQueryString)

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)

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.

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.

PropertyList
get($cid, $bin = 'default', $options = ['format' => 'json'])

Fetch a cached object and display it.

void
tags(string $tags)

Invalidate by cache tags.

clear(string $type, array $args, $options = ['cache-clear' => true])

Clear a specific cache, or all Drupal caches.

void
interact($input, $output)

No description

set($cid, $data, $bin = 'default', $expire = null, $tags = null, $options = ['input-format' => 'string', 'cache-get' => false])

Cache an object expressed in JSON or var_export() format.

setPrepareData($data, $options)

No description

void
validate(CommandData $commandData)

No description

array
getTypes($include_bootstrapped_types = false)

Types of caches available for clearing. Contrib commands can hook in their own.

void
clearDrush()

Clear caches internal to Drush core.

void
clearBins($args = ['default'])

Clear one or more cache bins.

void
clearThemeRegistry()

No description

void
clearRouter()

No description

void
clearCssJs()

No description

void
clearContainer()

No description

void
clearRender()

Clears the render cache entries.

void
clearPlugin()

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

DrushConfig getConfig()

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

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

__construct(CacheTagsInvalidatorInterface $invalidator, Registry $themeRegistry, RouteBuilderInterface $routerBuilder, JsCollectionOptimizerLazy $jsOptimizer, $cssOptimizer, CachedDiscoveryClearerInterface $pluginCacheClearer, BootstrapManager $bootstrapManager, AssetQueryStringInterface $assetQueryString)

No description

Parameters

CacheTagsInvalidatorInterface $invalidator
Registry $themeRegistry
RouteBuilderInterface $routerBuilder
JsCollectionOptimizerLazy $jsOptimizer
$cssOptimizer
CachedDiscoveryClearerInterface $pluginCacheClearer
BootstrapManager $bootstrapManager
AssetQueryStringInterface $assetQueryString

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)

Persist commandData for use in primary command callback. Used by 'topic' commands.

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

PropertyList get($cid, $bin = 'default', $options = ['format' => 'json'])

Fetch a cached object and display it.

Parameters

$cid
$bin
$options

Return Value

PropertyList

void tags(string $tags)

Invalidate by cache tags.

Parameters

string $tags

Return Value

void

clear(string $type, array $args, $options = ['cache-clear' => true])

Clear a specific cache, or all Drupal caches.

Parameters

string $type
array $args
$options

void interact($input, $output)

No description

Parameters

$input
$output

Return Value

void

set($cid, $data, $bin = 'default', $expire = null, $tags = null, $options = ['input-format' => 'string', 'cache-get' => false])

Cache an object expressed in JSON or var_export() format.

Parameters

$cid
$data
$bin
$expire
$tags
$options

protected setPrepareData($data, $options)

No description

Parameters

$data
$options

void validate(CommandData $commandData)

No description

Parameters

CommandData $commandData

Return Value

void

array getTypes($include_bootstrapped_types = false)

Types of caches available for clearing. Contrib commands can hook in their own.

Parameters

$include_bootstrapped_types

Return Value

array

void clearDrush()

Clear caches internal to Drush core.

Return Value

void

void clearBins($args = ['default'])

Clear one or more cache bins.

Parameters

$args

Return Value

void

void clearThemeRegistry()

No description

Return Value

void

void clearRouter()

No description

Return Value

void

void clearCssJs()

No description

Return Value

void

void clearContainer()

No description

Return Value

void

void clearRender()

Clears the render cache entries.

Return Value

void

void clearPlugin()

No description

Return Value

void