Task

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\Task
• Parent class: \PhalconKit\Cli\Task

Properties

cliDoc

public string $cliDoc

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:

Throws:

• CliException

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:

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:

normalizeCliMessage

Convert one Phalcon message object to JSON-safe scalar fields.

private normalizeCliMessage(\Phalcon\Messages\MessageInterface $message): array{message: string, field: string|null, type: string|null, code: int|null}

Parameters:

normalizeCliMessageValue

Convert optional Phalcon message fields and types to JSON-safe strings.

private normalizeCliMessageValue(mixed $value): ?string

Parameters:

stringifyCliMessage

Convert non-standard message values to a concise CLI-safe string.

private stringifyCliMessage(mixed $message): string

Parameters: