WorkCommand
class WorkCommand extends Command
Properties
| protected Application | $laravel | The Laravel application instance. |
from Command |
| protected InputInterface | $input | The input interface implementation. |
from Command |
| protected OutputStyle | $output | The output interface implementation. |
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. |
|
| $hidden | Indicates whether the command should be shown in the Artisan command list. |
from Command | |
| protected int | $verbosity | The default verbosity of output commands. |
from Command |
| protected array | $verbosityMap | The mapping between human readable verbosity levels and Symfony's OutputInterface. |
from Command |
| protected Worker | $worker | The queue worker instance. |
Methods
Configure the console command using a fluent definition.
Execute the console command.
Call another console command silently.
Confirm a question with the user.
Prompt the user for input with auto completion.
Prompt the user for input with auto completion.
Prompt the user for input but hide the answer from the console.
Give the user a single choice from an array of answers.
Format input to textual table.
Write a string as information output.
Write a string as standard output.
Write a string as comment output.
Write a string as question output.
Write a string as error output.
Write a string as warning output.
Get the verbosity level in terms of Symfony's OutputInterface level.
Execute the console command.
Run the worker instance.
Gather all of the queue worker options as a single object.
Listen for the queue events in order to update the console output.
Get the queue name for the worker.
Determine if the worker should run in maintenance mode.
Details
at line 53
void
__construct(Worker $worker)
Create a new queue work command.
in
Command at line 120
protected void
configureUsingFluentDefinition()
Configure the console command using a fluent definition.
in
Command at line 143
protected void
specifyParameters()
Specify the arguments and options on the command.
in
Command at line 164
int
run(InputInterface $input, OutputInterface $output)
Run the console command.
in
Command at line 178
protected mixed
execute(InputInterface $input, OutputInterface $output)
Execute the console command.
in
Command at line 192
int
call(string $command, array $arguments = [])
Call another console command.
in
Command at line 208
int
callSilent(string $command, array $arguments = [])
Call another console command silently.
in
Command at line 223
bool
hasArgument(string|int $name)
Determine if the given argument is present.
in
Command at line 234
string|array
argument(string|null $key = null)
Get the value of a command argument.
in
Command at line 248
array
arguments()
Get all of the arguments passed to the command.
in
Command at line 259
bool
hasOption(string $name)
Determine if the given option is present.
in
Command at line 270
string|array
option(string $key = null)
Get the value of a command option.
in
Command at line 284
array
options()
Get all of the options passed to the command.
in
Command at line 296
bool
confirm(string $question, bool $default = false)
Confirm a question with the user.
in
Command at line 308
string
ask(string $question, string $default = null)
Prompt the user for input.
in
Command at line 321
string
anticipate(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
in
Command at line 334
string
askWithCompletion(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
in
Command at line 350
string
secret(string $question, bool $fallback = true)
Prompt the user for input but hide the answer from the console.
in
Command at line 369
string
choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)
Give the user a single choice from an array of answers.
in
Command at line 386
void
table(array $headers, Arrayable|array $rows, string $style = 'default')
Format input to textual table.
in
Command at line 404
void
info(string $string, null|int|string $verbosity = null)
Write a string as information output.
in
Command at line 417
void
line(string $string, string $style = null, null|int|string $verbosity = null)
Write a string as standard output.
in
Command at line 431
void
comment(string $string, null|int|string $verbosity = null)
Write a string as comment output.
in
Command at line 443
void
question(string $string, null|int|string $verbosity = null)
Write a string as question output.
in
Command at line 455
void
error(string $string, null|int|string $verbosity = null)
Write a string as error output.
in
Command at line 467
void
warn(string $string, null|int|string $verbosity = null)
Write a string as warning output.
in
Command at line 484
void
alert(string $string)
Write a string in an alert box.
in
Command at line 499
protected void
setVerbosity(string|int $level)
Set the verbosity level.
in
Command at line 510
protected int
parseVerbosity(string|int $level = null)
Get the verbosity level in terms of Symfony's OutputInterface level.
in
Command at line 526
protected array
getArguments()
Get the console command arguments.
in
Command at line 536
protected array
getOptions()
Get the console command options.
in
Command at line 546
OutputInterface
getOutput()
Get the output implementation.
in
Command at line 556
Application
getLaravel()
Get the Laravel application instance.
at line 65
void
fire()
Execute the console command.
at line 96
protected array
runWorker(string $connection, string $queue)
Run the worker instance.
at line 110
protected WorkerOptions
gatherWorkerOptions()
Gather all of the queue worker options as a single object.
at line 124
protected void
listenForEvents()
Listen for the queue events in order to update the console output.
at line 148
protected void
writeOutput(Job $job, string $status)
Write the status output for the queue worker.
at line 168
protected void
writeStatus(Job $job, string $status, string $type)
Format the status output for the queue worker.
at line 183
protected void
logFailedJob(JobFailed $event)
Store a failed job event.
at line 197
protected string
getQueue(string $connection)
Get the queue name for the worker.
at line 209
protected bool
downForMaintenance()
Determine if the worker should run in maintenance mode.