Class PurgeFailedCommand

Namespace: Cake\Queue\Command

Constants

int

CODE_ERROR ¶
```
1
```
Default error code
int

CODE_SUCCESS ¶
```
0
```
Default success code

Property Summary

$_eventClass protected

string

Default class name for new event objects.
$_eventManager protected

Cake\Event\EventManagerInterface|null

Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Table locator instance
$defaultTable protected

string|null

This object's default table alias.
$factory protected

?CommandFactoryInterface
$name protected

string

The name of this command.

Method Summary

__construct() public

Constructor
abort() public

Halt the current process with a StopException.
buildOptionParser() protected

Hook method for defining this command's option parser.
defaultName() public static

Get the command name.
dispatchEvent() public

Wrapper for creating and dispatching events.
displayHelp() protected

Output help content
execute() public

Implement this method with your command's logic.
executeCommand() public

Execute another command with the provided set of arguments.
fetchTable() public

Convenience method to get a table instance.
getDescription() public static

Get the command description.
getEventManager() public

Returns the Cake\Event\EventManager manager instance for this object.
getName() public

Get the command name.
getOptionParser() public

Gets the option parser instance and configures it.
getRootName() public

Get the root command name.
getTableLocator() public

Gets the table locator.
initialize() public

Hook method invoked by CakePHP when a command is about to be executed.
log() public

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
run() public

Run the command.
setEventManager() public

Returns the Cake\Event\EventManagerInterface instance for this object.
setName() public

Set the name this command uses in the collection.
setOutputLevel() protected

Set the output level based on the Arguments.
setTableLocator() public

Sets the table locator.

Method Detail

__construct() ¶ public

__construct(Cake\Console\CommandFactoryInterface $factory = null)

Constructor

Parameters

Cake\Console\CommandFactoryInterface $factory optional: Command factory instance.

abort() ¶ public

abort(int $code = self::CODE_ERROR): never

Halt the current process with a StopException.

Parameters

int $code optional: The exit code to use.

Returns

never

Throws

Cake\Console\Exception\StopException

buildOptionParser() ¶ protected

buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser

Hook method for defining this command's option parser.

Parameters

Cake\Console\ConsoleOptionParser $parser: The parser to be defined

Returns

Cake\Console\ConsoleOptionParser

defaultName() ¶ public static

defaultName(): string

Get the command name.

Returns the command name based on class name. For e.g. for a command with class name UpdateTableCommand the default name returned would be 'update_table'.

Returns

string

dispatchEvent() ¶ public

dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name: Name of the event.
array $data optional: Any value you wish to be transported with this event to it can be read by listeners.
TSubject|null $subject optional: The object that this event applies to ($this by default).

Returns

Cake\Event\EventInterface<TSubject>

displayHelp() ¶ protected

displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Output help content

Parameters

Cake\Console\ConsoleOptionParser $parser: The option parser.
Cake\Console\Arguments $args: The command arguments.
Cake\Console\ConsoleIo $io: The console io

Returns

void

execute() ¶ public

execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Implement this method with your command's logic.

Parameters

Cake\Console\Arguments $args: Arguments
Cake\Console\ConsoleIo $io: ConsoleIo

Returns

void

executeCommand() ¶ public

executeCommand(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

Execute another command with the provided set of arguments.

If you are using a string command name, that command's dependencies will not be resolved with the application container. Instead you will need to pass the command as an object with all of its dependencies.

Parameters

Cake\Console\CommandInterface|string $command: The command class name or command instance.
array $args optional: The arguments to invoke the command with.
Cake\Console\ConsoleIo|null $io optional: The ConsoleIo instance to use for the executed command.

Returns

int|null

fetchTable() ¶ public

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Convenience method to get a table instance.

Parameters

string|null $alias optional: The alias name you want to get. Should be in CamelCase format. If null then the value of $defaultTable property is used.
array<string, mixed> $options optional: The options you want to build the table with. If a table has already been loaded the registry options will be ignored.

Returns

Cake\ORM\Table

Throws

Cake\Core\Exception\CakeException
If `$alias` argument and `$defaultTable` property both are `null`.

getDescription() ¶ public static

getDescription(): string

Get the command description.

Returns

string

getEventManager() ¶ public

getEventManager(): Cake\Event\EventManagerInterface

Returns the Cake\Event\EventManager manager instance for this object.

You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.

Returns

Cake\Event\EventManagerInterface

getName() ¶ public

getName(): string

Get the command name.

Returns

string

getOptionParser() ¶ public

getOptionParser(): Cake\Console\ConsoleOptionParser

Gets the option parser instance and configures it.

You can override buildOptionParser() to define your options & arguments.

Returns

Cake\Console\ConsoleOptionParser

getRootName() ¶ public

getRootName(): string

Get the root command name.

Returns

string

getTableLocator() ¶ public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

initialize() ¶ public

initialize(): void

Hook method invoked by CakePHP when a command is about to be executed.

Override this method and implement expensive/important setup steps that should not run on every command run. This method will be called before the options and arguments are validated and processed.

Returns

void

log() ¶ public

log(Stringable|string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

Parameters

Stringable|string $message: Log message.
string|int $level optional: Error level.
array|string $context optional: Additional log data relevant to this message.

Returns

bool

run() ¶ public

run(array $argv, Cake\Console\ConsoleIo $io): int|null

Run the command.

Parameters

array $argv
Cake\Console\ConsoleIo $io

Returns

int|null

setEventManager() ¶ public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

Returns the Cake\Event\EventManagerInterface instance for this object.

You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.

Parameters

Cake\Event\EventManagerInterface $eventManager: the eventManager to set

Returns

$this

setName() ¶ public

setName(string $name): $this

Set the name this command uses in the collection.

Generally invoked by the CommandCollection when the command is added. Required to have at least one space in the name so that the root command can be calculated.

Parameters

string $name

Returns

$this

setOutputLevel() ¶ protected

setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Set the output level based on the Arguments.

Parameters

Cake\Console\Arguments $args: The command arguments.
Cake\Console\ConsoleIo $io: The console io

Returns

void

setTableLocator() ¶ public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface instance.

Returns

$this

Property Detail

`$_eventClass` ¶ protected

Default class name for new event objects.

Type

string

`$_eventManager` ¶ protected

Instance of the Cake\Event\EventManager this object is using to dispatch inner events.

Type

Cake\Event\EventManagerInterface|null

`$_tableLocator` ¶ protected

Table locator instance

Type

Cake\ORM\Locator\LocatorInterface|null

`$defaultTable` ¶ protected

This object's default table alias.

Type

string|null

`$factory` ¶ protected

Type

?CommandFactoryInterface

`$name` ¶ protected

The name of this command.

Type

string

Namespaces

Class PurgeFailedCommand

Constants

Property Summary

Method Summary

__construct() public

abort() public

buildOptionParser() protected

defaultName() public static

dispatchEvent() public

displayHelp() protected

execute() public

executeCommand() public

fetchTable() public

getDescription() public static

getEventManager() public

getName() public

getOptionParser() public

getRootName() public

getTableLocator() public

initialize() public

log() public

run() public

setEventManager() public

setName() public

setOutputLevel() protected

setTableLocator() public

Method Detail

__construct() ¶ public

Parameters

abort() ¶ public

Parameters

Returns

Throws

buildOptionParser() ¶ protected

Parameters

Returns

defaultName() ¶ public static

Returns

dispatchEvent() ¶ public

Parameters

Returns

displayHelp() ¶ protected

Parameters

Returns

execute() ¶ public

Parameters

Returns

executeCommand() ¶ public

Parameters

Returns

fetchTable() ¶ public

Parameters

Returns

Throws

See Also

getDescription() ¶ public static

Returns

getEventManager() ¶ public

Returns

getName() ¶ public

Returns

getOptionParser() ¶ public

Returns

getRootName() ¶ public

Returns

getTableLocator() ¶ public

Returns

initialize() ¶ public

Returns

log() ¶ public

Parameters

Returns

run() ¶ public

Parameters

Returns

setEventManager() ¶ public

Parameters

Returns

setName() ¶ public

`$_eventClass` ¶ protected

`$_eventManager` ¶ protected

`$_tableLocator` ¶ protected

`$defaultTable` ¶ protected

`$factory` ¶ protected

`$name` ¶ protected