CacheTask
Base class for PhalconKit CLI tasks.
Extend this class for framework/application CLI tasks that need Phalcon's native task lifecycle plus PhalconKit injectable service annotations. The class does not add task behavior itself; action methods remain normal Phalcon CLI task methods.
- Full name:
\PhalconKit\Modules\Cli\Tasks\CacheTask - Parent class:
\PhalconKit\Modules\Cli\Task
Properties
cliDoc
public string $cliDoc
Methods
clearAction
Clears all items from the cache.
public clearAction(): bool
Return Value:
True if all items were successfully cleared, false otherwise.
hasAction
Checks if the given action key exists in the cache.
public hasAction(string $key): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$key | string | The key identifying the action in the cache. |
Return Value:
Returns true if the action key exists in the cache, false otherwise.
Throws:
deleteAction
Deletes an item from the cache.
public deleteAction(string $key): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$key | string | The key of the item to be deleted. |
Return Value:
True if the item was successfully deleted, false otherwise.
Throws:
deleteMultipleAction
Deletes multiple cache entries specified by the given keys.
public deleteMultipleAction(string $keys): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$keys | string | A variable number of keys representing the cache entries to be deleted. |
Return Value:
Returns true if all cache entries were successfully deleted, false otherwise.
Inherited methods
beforeExecuteRoute
public beforeExecuteRoute(): void
helpAction
public helpAction(): void
mainAction
public mainAction(): ?array
afterExecuteRoute
Handle rest response automagically
public afterExecuteRoute(\Phalcon\Cli\Dispatcher $dispatcher): void
Parameters:
| Parameter | Type | Description |
|---|---|---|
$dispatcher | \Phalcon\Cli\Dispatcher |
Throws:
normalizeCliPayload
Normalize values before CLI output serializers see them.
protected normalizeCliPayload(mixed $payload): mixed
Phalcon message objects are useful inside the framework but are opaque for JSON automation. This helper recursively converts them into scalar arrays while leaving other payload values unchanged.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$payload | mixed |
normalizeCliMessages
Normalize a list of model messages and optionally add a fallback entry.
protected normalizeCliMessages(iterable $messages, ?string $fallbackMessage = null): list<array{message: string, field: string|null, type: string|null, code: int|null}>
Parameters:
| Parameter | Type | Description |
|---|---|---|
$messages | iterable | Messages returned by a model or resultset. |
$fallbackMessage | ?string |