QueueCommands
final class QueueCommands extends DrushCommands (View source)
Traits
Constants
REQ |
|
OPT |
|
EXIT_SUCCESS |
|
EXIT_FAILURE |
|
EXIT_FAILURE_WITH_CLARITY |
|
VALIDATE_QUEUE |
|
RUN |
|
LIST |
|
DELETE |
|
Properties
protected CommandData|null | $commandData | from DrushCommands | |
protected QueueWorkerManagerInterface | $workerManager | ||
protected | $queueService | ||
static protected array | $queues | Keep track of queue definitions. |
Methods
Starts a background browser/tab for the current site or a specified URL.
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
No description
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
No description
No description
No description
Run a specific queue by name.
Returns a list of all defined queues.
Delete all items in a specific queue.
Validate that a queue exists.
No description
No description
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.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
DrushConfig
getConfig()
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
__construct(QueueWorkerManagerInterface $workerManager, QueueFactory $queueService)
No description
protected SymfonyStyle
io()
Override Robo's IO function with our custom style.
protected DrushLoggerManager|null
logger()
Returns a logger object.
protected 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.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
static QueueCommands
create(ContainerInterface $container)
No description
QueueWorkerManagerInterface
getWorkerManager()
No description
QueueFactory
getQueueService()
No description
void
run(string $name, $options = ['time-limit' => self::REQ, 'items-limit' => self::REQ, 'lease-time' => self::REQ])
Run a specific queue by name.
RowsOfFields
qList($options = ['format' => 'table'])
Returns a list of all defined queues.
void
delete($name)
Delete all items in a specific queue.
validateQueueName(CommandData $commandData)
Validate that a queue exists.
array
getQueues()
No description
QueueInterface
getQueue($name)
No description
void
queueComplete(CompletionInput $input, CompletionSuggestions $suggestions)
No description