1. class
  2. Illuminate
  3. \
  4. Queue
  5. \
  6. Console
  7. \
  8. WorkCommand

WorkCommand

class WorkCommand extends Command (View source)

Traits

InteractsWithTime
CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Properties

protected Factory internal $components

The console components factory.

 from  InteractsWithIO
protected InputInterface $input

The input interface implementation.

 from  InteractsWithIO
protected OutputStyle $output

The output interface implementation.

 from  InteractsWithIO
protected int $verbosity

The default verbosity of output commands.

 from  InteractsWithIO
protected array $verbosityMap

The mapping between human readable verbosity levels and Symfony's OutputInterface.

 from  InteractsWithIO
protected Signals|null $signals

The signal registrar instance.

 from  InteractsWithSignals
static protected array $macros

The registered string macros.

 from  Macroable
protected Application $laravel

The Laravel application instance.

 from  Command
protected string $signature

The console command name.
protected string $name

The console command name.

 from  Command
protected string $description

The console command description.
protected string $help

The console command help text.

 from  Command
protected bool $hidden

Indicates whether the command should be shown in the Artisan command list.

 from  Command
protected bool $isolated

Indicates whether only one instance of the command can run at any given time.

 from  Command
protected int $isolatedExitCode

The default exit code for isolated commands.

 from  Command
protected array $aliases

The console command name aliases.

 from  Command
protected Worker $worker

The queue worker instance.
protected Repository $cache

The cache store implementation.
protected float|null $latestStartedAt

Holds the start time of the last processed job, if any.

Methods

Command
resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

from  CallsCommands
int
call(Command|string $command, array $arguments = [])

Call another console command.

from  CallsCommands
int
callSilent(Command|string $command, array $arguments = [])

Call another console command without output.

from  CallsCommands
int
callSilently(Command|string $command, array $arguments = [])

Call another console command without output.

from  CallsCommands
int
runCommand(Command|string $command, array $arguments, OutputInterface $output)

Run the given console command.

from  CallsCommands
ArrayInput
createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

from  CallsCommands
array
context()

Get all of the context passed to the command.

from  CallsCommands
void
configurePrompts(InputInterface $input)

Configure the prompt fallbacks.

from  ConfiguresPrompts
mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Prompt the user until the given validation callback passes.

from  ConfiguresPrompts
?string
validatePrompt(mixed $value, mixed $rules)

Validate the given prompt value using the validator.

from  ConfiguresPrompts
Validator
getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

Get the validator instance that should be used to validate prompts.

from  ConfiguresPrompts
array
validationMessages()

Get the validation messages that should be used during prompt validation.

from  ConfiguresPrompts
array
validationAttributes()

Get the validation attributes that should be used during prompt validation.

from  ConfiguresPrompts
void
restorePrompts()

Restore the prompts output.

from  ConfiguresPrompts
void
specifyParameters()

Specify the arguments and options on the command.

from  HasParameters
array
getArguments()

Get the console command arguments.

from  HasParameters
array
getOptions()

Get the console command options.

from  HasParameters
bool
hasArgument(string|int $name)

Determine if the given argument is present.

from  InteractsWithIO
array|string|bool|null
argument(string|null $key = null)

Get the value of a command argument.

from  InteractsWithIO
array
arguments()

Get all of the arguments passed to the command.

from  InteractsWithIO
bool
hasOption(string $name)

Determine whether the option is defined in the command signature.

from  InteractsWithIO
string|array|bool|null
option(string|null $key = null)

Get the value of a command option.

from  InteractsWithIO
array
options()

Get all of the options passed to the command.

from  InteractsWithIO
bool
confirm(string $question, bool $default = false)

Confirm a question with the user.

from  InteractsWithIO
mixed
ask(string $question, string|null $default = null)

Prompt the user for input.

from  InteractsWithIO
mixed
anticipate(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

from  InteractsWithIO
mixed
askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

from  InteractsWithIO
mixed
secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

from  InteractsWithIO
string|array
choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Give the user a single choice from an array of answers.

from  InteractsWithIO
void
table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

from  InteractsWithIO
mixed|void
withProgressBar(iterable|int $totalSteps, Closure $callback)

Execute a given callback while advancing a progress bar.

from  InteractsWithIO
void
info(string $string, int|string|null $verbosity = null)

Write a string as information output.

from  InteractsWithIO
void
line(string $string, string|null $style = null, int|string|null $verbosity = null)

Write a string as standard output.

from  InteractsWithIO
void
comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

from  InteractsWithIO
void
question(string $string, int|string|null $verbosity = null)

Write a string as question output.

from  InteractsWithIO
void
error(string $string, int|string|null $verbosity = null)

Write a string as error output.

from  InteractsWithIO
void
warn(string $string, int|string|null $verbosity = null)

Write a string as warning output.

from  InteractsWithIO
void
alert(string $string, int|string|null $verbosity = null)

Write a string in an alert box.

from  InteractsWithIO
$this
newLine(int $count = 1)

Write a blank line.

from  InteractsWithIO
void
setInput(InputInterface $input)

Set the input interface implementation.

from  InteractsWithIO
void
setOutput(OutputStyle $output)

Set the output interface implementation.

from  InteractsWithIO
void
setVerbosity(string|int $level)

Set the verbosity level.

from  InteractsWithIO
int
parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

from  InteractsWithIO
OutputStyle
getOutput()

Get the output implementation.

from  InteractsWithIO
Factory
outputComponents()

Get the output component factory implementation.

from  InteractsWithIO
trap($signals, $callback)

No description

from  InteractsWithSignals
void
untrap()

Untrap signal handlers set within the command's handler.

from  InteractsWithSignals
void
interact(InputInterface $input, OutputInterface $output)

Interact with the user before validating the input.

from  PromptsForMissingInput
void
promptForMissingArguments(InputInterface $input, OutputInterface $output)

Prompt the user for any missing arguments.

from  PromptsForMissingInput
array
promptForMissingArgumentsUsing()

Prompt for missing input arguments using the returned questions.

from  PromptsForMissingInput
void
afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Perform actions after the user was prompted for missing arguments.

from  PromptsForMissingInput
bool
didReceiveOptions(InputInterface $input)

Whether the input contains any options that differ from the default values.

from  PromptsForMissingInput
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(Worker $worker, Repository $cache)

Create a new queue work command.

void
configureUsingFluentDefinition()

Configure the console command using a fluent definition.

from  Command
void
configureIsolation()

Configure the console command for isolation.

from  Command
int
run(InputInterface $input, OutputInterface $output)

Run the console command.

from  Command
int
execute(InputInterface $input, OutputInterface $output)

Execute the console command.

from  Command
CommandMutex
commandIsolationMutex()

Get a command isolation mutex instance for the command.

from  Command
void
fail(Throwable|string|null $exception = null)

Fail the command manually.

from  Command
bool
isHidden()

{@inheritdoc}

from  Command
Command
setHidden(bool $hidden = true)

{@inheritdoc}

from  Command
Application
getLaravel()

Get the Laravel application instance.

from  Command
void
setLaravel(Container $laravel)

Set the Laravel application instance.

from  Command
int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
int|null
handle()

Execute the console command.

int|null
runWorker(string $connection, string $queue)

Run the worker instance.

WorkerOptions
gatherWorkerOptions()

Gather all of the queue worker options as a single object.

void
listenForEvents()

Listen for the queue events in order to update the console output.

void
writeOutput(Job $job, string $status, Throwable|null $exception = null)

Write the status output for the queue worker for JSON or TTY.

void
writeOutputForCli(Job $job, string $status)

Write the status output for the queue worker.

void
writeOutputAsJson(Job $job, string $status, Throwable|null $exception = null)

Write the status output for the queue worker in JSON format.

Carbon
now()

Get the current date / time.

void
logFailedJob(JobFailed $event)

Store a failed job event.

string
getQueue(string $connection)

Get the queue name for the worker.

bool
downForMaintenance()

Determine if the worker should run in maintenance mode.

bool
outputUsingJson()

Determine if the worker should output using JSON.

static void
flushState()

Reset static variables.

Details

in CallsCommands at line 18
abstract protected Command resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

Parameters

Command|string $command

Return Value

Command

in CallsCommands at line 27
int call(Command|string $command, array $arguments = [])

Call another console command.

Parameters

Command|string $command
array $arguments

Return Value

int

in CallsCommands at line 39
int callSilent(Command|string $command, array $arguments = [])

Call another console command without output.

Parameters

Command|string $command
array $arguments

Return Value

int

in CallsCommands at line 51
int callSilently(Command|string $command, array $arguments = [])

Call another console command without output.

Parameters

Command|string $command
array $arguments

Return Value

int

in CallsCommands at line 64
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

Run the given console command.

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

in CallsCommands at line 83
protected ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

Parameters

array $arguments

Return Value

ArrayInput

in CallsCommands at line 97
protected array context()

Get all of the context passed to the command.

Return Value

array

in ConfiguresPrompts at line 28
protected void configurePrompts(InputInterface $input)

Configure the prompt fallbacks.

Parameters

InputInterface $input

Return Value

void

in ConfiguresPrompts at line 123
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

in ConfiguresPrompts at line 161
protected ?string validatePrompt(mixed $value, mixed $rules)

Validate the given prompt value using the validator.

Parameters

mixed $value
mixed $rules

Return Value

?string

in ConfiguresPrompts at line 194
protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

Get the validator instance that should be used to validate prompts.

Parameters

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

Return Value

Validator

in ConfiguresPrompts at line 209
protected array validationMessages()

Get the validation messages that should be used during prompt validation.

Return Value

array

in ConfiguresPrompts at line 219
protected array validationAttributes()

Get the validation attributes that should be used during prompt validation.

Return Value

array

in ConfiguresPrompts at line 229
protected void restorePrompts()

Restore the prompts output.

Return Value

void

in HasParameters at line 15
protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

in HasParameters at line 42
protected array getArguments()

Get the console command arguments.

Return Value

array

in HasParameters at line 52
protected array getOptions()

Get the console command options.

Return Value

array

in InteractsWithIO at line 67
bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

in InteractsWithIO at line 78
array|string|bool|null argument(string|null $key = null)

Get the value of a command argument.

Parameters

string|null $key

Return Value

array|string|bool|null

in InteractsWithIO at line 92
array arguments()

Get all of the arguments passed to the command.

Return Value

array

in InteractsWithIO at line 103
bool hasOption(string $name)

Determine whether the option is defined in the command signature.

Parameters

string $name

Return Value

bool

in InteractsWithIO at line 114
string|array|bool|null option(string|null $key = null)

Get the value of a command option.

Parameters

string|null $key

Return Value

string|array|bool|null

in InteractsWithIO at line 128
array options()

Get all of the options passed to the command.

Return Value

array

in InteractsWithIO at line 140
bool confirm(string $question, bool $default = false)

Confirm a question with the user.

Parameters

string $question
bool $default

Return Value

bool

in InteractsWithIO at line 152
mixed ask(string $question, string|null $default = null)

Prompt the user for input.

Parameters

string $question
string|null $default

Return Value

mixed

in InteractsWithIO at line 165
mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

in InteractsWithIO at line 178
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

in InteractsWithIO at line 196
mixed secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

Parameters

string $question
bool $fallback

Return Value

mixed

in InteractsWithIO at line 215
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Give the user a single choice from an array of answers.

Parameters

string $question
array $choices
string|int|null $default
mixed|null $attempts
bool $multiple

Return Value

string|array

in InteractsWithIO at line 233
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
TableStyle|string $tableStyle
array $columnStyles

Return Value

void

in InteractsWithIO at line 257
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Execute a given callback while advancing a progress bar.

Parameters

iterable|int $totalSteps
Closure $callback

Return Value

mixed|void

in InteractsWithIO at line 289
void info(string $string, int|string|null $verbosity = null)

Write a string as information output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 302
void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Write a string as standard output.

Parameters

string $string
string|null $style
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 316
void comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 328
void question(string $string, int|string|null $verbosity = null)

Write a string as question output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 340
void error(string $string, int|string|null $verbosity = null)

Write a string as error output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 352
void warn(string $string, int|string|null $verbosity = null)

Write a string as warning output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 370
void alert(string $string, int|string|null $verbosity = null)

Write a string in an alert box.

Parameters

string $string
int|string|null $verbosity

Return Value

void

in InteractsWithIO at line 387
$this newLine(int $count = 1)

Write a blank line.

Parameters

int $count

Return Value

$this

in InteractsWithIO at line 400
void setInput(InputInterface $input)

Set the input interface implementation.

Parameters

InputInterface $input

Return Value

void

in InteractsWithIO at line 411
void setOutput(OutputStyle $output)

Set the output interface implementation.

Parameters

OutputStyle $output

Return Value

void

in InteractsWithIO at line 422
protected void setVerbosity(string|int $level)

Set the verbosity level.

Parameters

string|int $level

Return Value

void

in InteractsWithIO at line 433
protected int parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

Parameters

string|int|null $level

Return Value

int

in InteractsWithIO at line 449
OutputStyle getOutput()

Get the output implementation.

Return Value

OutputStyle

in InteractsWithIO at line 459
Factory outputComponents()

Get the output component factory implementation.

Return Value

Factory

in InteractsWithSignals at line 26
trap($signals, $callback)

No description

Parameters

$signals
$callback

in InteractsWithSignals at line 45
void untrap()

internal  
 

Untrap signal handlers set within the command's handler.

Return Value

void

in PromptsForMissingInput at line 24
protected void interact(InputInterface $input, OutputInterface $output)

Interact with the user before validating the input.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

in PromptsForMissingInput at line 40
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Prompt the user for any missing arguments.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

in PromptsForMissingInput at line 80
protected array promptForMissingArgumentsUsing()

Prompt for missing input arguments using the returned questions.

Return Value

array

in PromptsForMissingInput at line 92
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Perform actions after the user was prompted for missing arguments.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

in PromptsForMissingInput at line 103
protected bool didReceiveOptions(InputInterface $input)

Whether the input contains any options that differ from the default values.

Parameters

InputInterface $input

Return Value

bool

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 93
__construct(Worker $worker, Repository $cache)

Create a new queue work command.

Parameters

Worker $worker
Repository $cache

in Command at line 132
protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

in Command at line 150
protected void configureIsolation()

Configure the console command for isolation.

Return Value

void

in Command at line 168
int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

in Command at line 194
protected int execute(InputInterface $input, OutputInterface $output)

Execute the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

in Command at line 228
protected CommandMutex commandIsolationMutex()

Get a command isolation mutex instance for the command.

Return Value

CommandMutex

in Command at line 270
void fail(Throwable|string|null $exception = null)

Fail the command manually.

Parameters

Throwable|string|null $exception

Return Value

void

Exceptions

Throwable

in Command at line 288
bool isHidden()

{@inheritdoc}

Return Value

bool

in Command at line 297
Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

in Command at line 310
Application getLaravel()

Get the Laravel application instance.

Return Value

Application

in Command at line 321
void setLaravel(Container $laravel)

Set the Laravel application instance.

Parameters

Container $laravel

Return Value

void

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

at line 106
int|null handle()

Execute the console command.

Return Value

int|null

at line 143
protected int|null runWorker(string $connection, string $queue)

Run the worker instance.

Parameters

string $connection
string $queue

Return Value

int|null

at line 158
protected WorkerOptions gatherWorkerOptions()

Gather all of the queue worker options as a single object.

Return Value

WorkerOptions

at line 180
protected void listenForEvents()

Listen for the queue events in order to update the console output.

Return Value

void

at line 215
protected void writeOutput(Job $job, string $status, Throwable|null $exception = null)

Write the status output for the queue worker for JSON or TTY.

Parameters

Job $job
string $status
Throwable|null $exception

Return Value

void

at line 229
protected void writeOutputForCli(Job $job, string $status)

Write the status output for the queue worker.

Parameters

Job $job
string $status

Return Value

void

at line 276
protected void writeOutputAsJson(Job $job, string $status, Throwable|null $exception = null)

Write the status output for the queue worker in JSON format.

Parameters

Job $job
string $status
Throwable|null $exception

Return Value

void

at line 312
protected Carbon now()

Get the current date / time.

Return Value

Carbon

at line 330
protected void logFailedJob(JobFailed $event)

Store a failed job event.

Parameters

JobFailed $event

Return Value

void

at line 346
protected string getQueue(string $connection)

Get the queue name for the worker.

Parameters

string $connection

Return Value

string

at line 358
protected bool downForMaintenance()

Determine if the worker should run in maintenance mode.

Return Value

bool

at line 368
protected bool outputUsingJson()

Determine if the worker should output using JSON.

Return Value

bool

at line 382
static void flushState()

Reset static variables.

Return Value

void