class ListFailedCommand extends Command

Traits

Properties

protected Factory|null $components

The console components factory.

from  InteractsWithIO
protected InputInterface|null $input from  InteractsWithIO
protected OutputStyle|null $output 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 SignalRegistry|null $signalRegistry from  InteractsWithSignals
static protected array $macros

The registered string macros.

from  Macroable
protected string|null $signature

The console command signature.

protected string|null $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 string[] $aliases

The console command name aliases.

from  Command
protected bool $coroutine

Whether to execute in a coroutine environment.

from  Command
protected Dispatcher|null $eventDispatcher

The event dispatcher instance.

from  Command
protected int $hookFlags

The hook flags for the coroutine.

from  Command
protected int $exitCode

The exit code of the command.

from  Command
protected Application|null $hypervel

The Hypervel application instance.

from  Command
protected array $headers

The table headers for the command.

Methods

Command
resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

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

Call another console command.

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

Call another console command without output.

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

Call another console command without output.

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

Run the given console command.

ArrayInput
createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

array
context()

Get all the context passed to the command.

void
configurePrompts(InputInterface $input)

Configure the prompt fallbacks.

PResult
promptUntilValid(PResult $prompt, bool|string $required, null|PResult): mixed $validate)

Prompt the user until the given validation callback passes.

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

Validate the given prompt value using the validator.

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

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

array
validationMessages()

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

array
validationAttributes()

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

void
addDisableDispatcherOption()

Add the disable event dispatcher option to the command.

void
disableDispatcher(InputInterface $input)

Disable or enable the event dispatcher based on the input option.

void
specifyParameters()

Specify the arguments and options on the command.

array
getArguments()

Get the console command arguments.

array
getOptions()

Get the console command options.

mixed
input(string|null $key = null, mixed $default = null)

Retrieve the command's input as a CommandInput instance or retrieve an input item.

bool
hasArgument(int|string $name)

Determine if the given argument is present.

mixed
argument(string|null $key = null)

Get the value of a command argument.

array
arguments()

Get all of the arguments passed to the command.

bool
hasOption(string $name)

Determine if the given option is present.

mixed
option(string|null $key = null)

Get the value of a command option.

array
options()

Get all of the options passed to the command.

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

Confirm a question with the user.

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

Prompt the user for input.

mixed
anticipate(string $question, iterable|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

mixed
askWithCompletion(string $question, iterable|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

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

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

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

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

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

Format input to textual table.

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

Execute a given callback while advancing a progress bar.

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

Write a string as information output.

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

Write a string as standard output.

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

Write a string as comment output.

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

Write a string as question output.

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

Write a string as error output.

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

Write a string as warning output.

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

Write a string in an alert box.

newLine(int $count = 1)

Write a blank line.

void
setInput(InputInterface $input)

Set the input interface implementation.

void
setOutput(OutputStyle $output)

Set the output interface implementation.

getOutput()

Get the output implementation.

Factory|null
outputComponents()

Get the output component factory implementation.

void
setVerbosity(int|string $level)

Set the verbosity level.

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

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

void
trap(array|int $signo, callable $callback)

Define a callback to be run when the given signal(s) occurs.

void
untrap(array|int|null $signo = null)

Unregister signal handlers for one, many, or all signals.

void
interact(InputInterface $input, OutputInterface $output)

Interact with the user before validating the input.

void
promptForMissingArguments(InputInterface $input, OutputInterface $output)

Prompt the user for any missing arguments.

array
promptForMissingArgumentsUsing()

Prompt for missing input arguments using the returned questions.

void
afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Perform actions after the user was prompted for missing arguments.

bool
didReceiveOptions(InputInterface $input)

Determine whether the input contains any options that differ from the default values.

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

Register a custom macro.

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

Mix another object into the class.

static bool
hasMacro(string $name)

Check if macro is registered.

static void
flushMacros()

Flush the existing macros.

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

Dynamically handle calls to the class.

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

__construct(string|null $name = null)

No description

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

Run the console command.

from  Command
void
configureIsolation()

Configure the console command for isolation.

from  Command
void
configureFromAttributes()

Configure the command from class attributes.

from  Command
void
configureUsageFromAttribute()

Configure usage examples for the command from class attributes.

from  Command
void
configureUsingFluentDefinition()

Configure the console command using a fluent definition.

from  Command
void
configure()

No description

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

No description

from  Command
commandIsolationMutex()

Get a command isolation mutex instance for the command.

from  Command
void
replaceOutput()

No description

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

Fail the command manually.

from  Command
bool
isHidden()

Determine if the command is hidden.

from  Command
setHidden(bool $hidden = true)

Set whether the command is hidden.

from  Command
getHypervel()

Get the Hypervel application instance.

from  Command
void
setHypervel(Application $hypervel)

Set the Hypervel application instance.

from  Command
array
setUpTraits(InputInterface $input, OutputInterface $output)

Set up the traits used by the command.

from  Command
static void
flushState()

Flush all static state.

from  Command
void
handle()

Execute the console command.

array
getFailedJobs()

Compile the failed jobs into a displayable format.

array
parseFailedJob(array $failed)

Parse the failed job row.

string|null
matchJobName(array $payload)

Match the job name from the payload.

void
displayFailedJobs(array $jobs)

Display the failed jobs in the console.

void
displayFailedJobsAsJson(array $jobs)

Display the failed jobs as JSON.

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 23
int call(Command|string $command, array $arguments = [])

Call another console command.

Parameters

Command|string $command
array $arguments

Return Value

int

in CallsCommands at line 31
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 39
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 47
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 64
protected ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

Parameters

array $arguments

Return Value

ArrayInput

in CallsCommands at line 78
protected array context()

Get all the context passed to the command.

Return Value

array

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

Configure the prompt fallbacks.

Parameters

InputInterface $input

Return Value

void

in ConfiguresPrompts at line 149
protected PResult promptUntilValid(PResult $prompt, bool|string $required, null|PResult): mixed $validate)

Prompt the user until the given validation callback passes.

Parameters

PResult $prompt
bool|string $required
null|PResult): mixed $validate

Return Value

PResult

in ConfiguresPrompts at line 185
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 220
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 235
protected array validationMessages()

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

Return Value

array

in ConfiguresPrompts at line 245
protected array validationAttributes()

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

Return Value

array

void addDisableDispatcherOption()

Add the disable event dispatcher option to the command.

Return Value

void

void disableDispatcher(InputInterface $input)

Disable or enable the event dispatcher based on the input option.

Parameters

InputInterface $input

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 40
protected array getArguments()

Get the console command arguments.

Return Value

array

in HasParameters at line 48
protected array getOptions()

Get the console command options.

Return Value

array

in InteractsWithIO at line 53
mixed input(string|null $key = null, mixed $default = null)

Retrieve the command's input as a CommandInput instance or retrieve an input item.

Parameters

string|null $key
mixed $default

Return Value

mixed

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

Determine if the given argument is present.

Parameters

int|string $name

Return Value

bool

in InteractsWithIO at line 71
mixed argument(string|null $key = null)

Get the value of a command argument.

Parameters

string|null $key

Return Value

mixed

in InteractsWithIO at line 83
array arguments()

Get all of the arguments passed to the command.

Return Value

array

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

Determine if the given option is present.

Parameters

string $name

Return Value

bool

in InteractsWithIO at line 99
mixed option(string|null $key = null)

Get the value of a command option.

Parameters

string|null $key

Return Value

mixed

in InteractsWithIO at line 111
array options()

Get all of the options passed to the command.

Return Value

array

in InteractsWithIO at line 119
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 127
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 135
mixed anticipate(string $question, iterable|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

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

Return Value

mixed

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

Prompt the user for input with auto completion.

Parameters

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

Return Value

mixed

in InteractsWithIO at line 157
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 169
array|string choice(string $question, array $choices, int|string|null $default = null, int|null $attempts = null, bool $multiple = false)

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

Parameters

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

Return Value

array|string

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

Format input to textual table.

Parameters

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

Return Value

void

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

Execute a given callback while advancing a progress bar.

Parameters

iterable|int $totalSteps
Closure $callback

Return Value

mixed

in InteractsWithIO at line 231
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 239
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 249
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 257
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 265
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 273
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 287
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 301
InteractsWithIO newLine(int $count = 1)

Write a blank line.

Parameters

int $count

Return Value

InteractsWithIO

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

Set the input interface implementation.

Parameters

InputInterface $input

Return Value

void

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

Set the output interface implementation.

Parameters

OutputStyle $output

Return Value

void

in InteractsWithIO at line 327
OutputStyle|null getOutput()

Get the output implementation.

Return Value

OutputStyle|null

in InteractsWithIO at line 335
Factory|null outputComponents()

Get the output component factory implementation.

Return Value

Factory|null

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

Set the verbosity level.

Parameters

int|string $level

Return Value

void

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

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

Parameters

int|string|null $level

Return Value

int

void trap(array|int $signo, callable $callback)

Define a callback to be run when the given signal(s) occurs.

Parameters

array|int $signo
callable $callback

Return Value

void

void untrap(array|int|null $signo = null)

Unregister signal handlers for one, many, or all signals.

Parameters

array|int|null $signo

Return Value

void

protected void interact(InputInterface $input, OutputInterface $output)

Interact with the user before validating the input.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Prompt the user for any missing arguments.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected array promptForMissingArgumentsUsing()

Prompt for missing input arguments using the returned questions.

Return Value

array

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

protected bool didReceiveOptions(InputInterface $input)

Determine whether the input contains any options that differ from the default values.

Parameters

InputInterface $input

Return Value

bool

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

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

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

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 68
static void flushMacros()

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 78
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 103
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Command at line 112
__construct(string|null $name = null)

No description

Parameters

string|null $name

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

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

in Command at line 187
protected void configureIsolation()

Configure the console command for isolation.

Return Value

void

in Command at line 201
protected void configureFromAttributes()

Configure the command from class attributes.

Return Value

void

in Command at line 243
protected void configureUsageFromAttribute()

Configure usage examples for the command from class attributes.

Return Value

void

in Command at line 255
protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

in Command at line 268
protected void configure()

No description

Return Value

void

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

No description

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

in Command at line 366
protected CommandMutex commandIsolationMutex()

Get a command isolation mutex instance for the command.

Return Value

CommandMutex

in Command at line 373
protected void replaceOutput()

No description

Return Value

void

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

Fail the command manually.

Parameters

string|Throwable|null $exception

Return Value

void

Exceptions

Throwable

in Command at line 427
bool isHidden()

Determine if the command is hidden.

Return Value

bool

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

Set whether the command is hidden.

Parameters

bool $hidden

Return Value

Command

in Command at line 447
Application getHypervel()

Get the Hypervel application instance.

Return Value

Application

Exceptions

RuntimeException

in Command at line 459
void setHypervel(Application $hypervel)

Set the Hypervel application instance.

Parameters

Application $hypervel

Return Value

void

in Command at line 467
protected array setUpTraits(InputInterface $input, OutputInterface $output)

Set up the traits used by the command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

array

in Command at line 483
static void flushState()

Flush all static state.

Return Value

void

at line 35
void handle()

Execute the console command.

Return Value

void

at line 59
protected array getFailedJobs()

Compile the failed jobs into a displayable format.

Return Value

array

at line 71
protected array parseFailedJob(array $failed)

Parse the failed job row.

Parameters

array $failed

Return Value

array

at line 105
protected string|null matchJobName(array $payload)

Match the job name from the payload.

Parameters

array $payload

Return Value

string|null

at line 115
protected void displayFailedJobs(array $jobs)

Display the failed jobs in the console.

Parameters

array $jobs

Return Value

void

at line 128
protected void displayFailedJobsAsJson(array $jobs)

Display the failed jobs as JSON.

Parameters

array $jobs

Return Value

void