final class ViewsCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

DEV

EXECUTE

LIST

ENABLE

DISABLE

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, ModuleHandlerInterface $moduleHandler, EntityTypeManagerInterface $entityTypeManager, RendererInterface $renderer)

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

No description

ConfigFactoryInterface
getConfigFactory()

No description

ModuleHandlerInterface
getModuleHandler()

No description

EntityTypeManagerInterface
getEntityTypeManager()

No description

RendererInterface
getRenderer()

No description

void
dev()

Set several Views settings to more developer-oriented values.

RowsOfFields|null
vlist($options = ['name' => self::REQ, 'tags' => self::REQ, 'status' => self::REQ, 'format' => 'table'])

Get a list of all views in the system.

string|null
execute(string $view_name, $display = null, $view_args = null, $options = ['count' => 0, 'show-admin-links' => false])

Execute a view and show a count of the results, or the rendered HTML.

RowsOfFields|null
analyze()

Get a list of all Views and analyze warnings.

void
enable(string $views)

Enable the specified views.

void
disable(string $views)

Disable the specified views.

void
cacheClear($types, $include_bootstrapped_types)

Adds a cache clear option for views.

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, ModuleHandlerInterface $moduleHandler, EntityTypeManagerInterface $entityTypeManager, RendererInterface $renderer)

No description

Parameters

ConfigFactoryInterface $configFactory
ModuleHandlerInterface $moduleHandler
EntityTypeManagerInterface $entityTypeManager
RendererInterface $renderer

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

No description

Parameters

ContainerInterface $container

Return Value

ViewsCommands

ConfigFactoryInterface getConfigFactory()

No description

Return Value

ConfigFactoryInterface

ModuleHandlerInterface getModuleHandler()

No description

Return Value

ModuleHandlerInterface

EntityTypeManagerInterface getEntityTypeManager()

No description

Return Value

EntityTypeManagerInterface

RendererInterface getRenderer()

No description

Return Value

RendererInterface

void dev()

Set several Views settings to more developer-oriented values.

Return Value

void

RowsOfFields|null vlist($options = ['name' => self::REQ, 'tags' => self::REQ, 'status' => self::REQ, 'format' => 'table'])

Get a list of all views in the system.

Parameters

$options

Return Value

RowsOfFields|null

string|null execute(string $view_name, $display = null, $view_args = null, $options = ['count' => 0, 'show-admin-links' => false])

Execute a view and show a count of the results, or the rendered HTML.

Parameters

string $view_name
$display
$view_args
$options

Return Value

string|null

RowsOfFields|null analyze()

Get a list of all Views and analyze warnings.

Return Value

RowsOfFields|null

void enable(string $views)

Enable the specified views.

Parameters

string $views

Return Value

void

void disable(string $views)

Disable the specified views.

Parameters

string $views

Return Value

void

void cacheClear($types, $include_bootstrapped_types)

Adds a cache clear option for views.

Parameters

$types
$include_bootstrapped_types

Return Value

void