Skip to content

DataLifeCycleTask

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.

Properties

cliDoc

public string $cliDoc

dataLifeCycleConfig

Configuration array for defining the data lifecycle settings, including the models and policies applicable.

public array $dataLifeCycleConfig

models

App tasks can populate these before calling parent::initialize().

public array $models

policies

public array $policies

Methods

initialize

Initializes the configuration for data life cycle and sets up permissions for models.

public initialize(): void

mainAction

Executes the main action by processing the provided table names.

public mainAction(string $tables): array|null

This method delegates processing to the modelsAction method with the given table names. The results are then returned in an associative array under the 'models' key.

Parameters:

Parameter Type Description
$tables string A variable number of table names to process.

Return Value:

An associative array with the processed data under the 'models' key, or null if no data is returned.

modelsAction

Processes lifecycle models based on a defined retention policy and tables whitelist, executing actions such as deletion and collecting associated messages.

public modelsAction(string $tables): array

The method retrieves the lifecycle models and applies retention policies to the records. It processes only whitelisted tables if specified, and skips models not matching the input. The response contains information about the number of records processed (deleted) and any associated messages per table.

Parameters:

Parameter Type Description
$tables string A variadic list of table names, which may include comma-separated
values. These are used to filter models by matching the table names.
Only matched table records are processed.

Return Value:

An associative array where keys are table names and values are arrays containing the count of deleted records ('deleted') and any messages ('messages') encountered during processing.

requireLifeCycleModel

Require a lifecycle model loaded by the models manager.

protected requireLifeCycleModel(mixed $model, class-string $modelClass): \PhalconKit\Mvc\Model

Lifecycle tasks need the concrete PhalconKit model implementation because they disable soft-delete behavior and call lifecycle helpers on the model class. Keeping this validation outside the main loop keeps the task flow readable and gives applications a deterministic PhalconKit exception when a configured model class resolves to the wrong type.

Parameters:

Parameter Type Description
$model mixed Model instance returned by the models manager.
$modelClass class-string Configured lifecycle model class.

Throws:

When the configured model does not resolve to a PhalconKit model instance. - LogicException

requireLifeCycleResultset

Require the lifecycle query to return a Phalcon resultset.

protected requireLifeCycleResultset(mixed $records, class-string $modelClass): \Phalcon\Mvc\Model\Resultset

findLifeCycle() is expected to return records that can be iterated and passed to the configured lifecycle callback. This guard avoids silently continuing with malformed model lifecycle implementations when assertions are disabled.

Parameters:

Parameter Type Description
$records mixed Records returned by findLifeCycle().
$modelClass class-string Model class being processed.

Throws:

When the lifecycle query does not return a Phalcon resultset. - LogicException

getDataLifeCycleModels

Retrieves the data lifecycle models from the configuration.

public getDataLifeCycleModels(): array

Return Value:

An array of data lifecycle models or an empty array if not configured.

getDataLifeCyclePolicies

Retrieves the data lifecycle policies from the configuration.

public getDataLifeCyclePolicies(): array

Return Value:

An array of data lifecycle policies or an empty array if not configured.

getTaskDataLifeCycleModels

private getTaskDataLifeCycleModels(): array

getTaskDataLifeCyclePolicies

private getTaskDataLifeCyclePolicies(): array

addModelsPermissions

Adds permissions for the specified models to the configuration.

public addModelsPermissions(array|null $models = null): void

If no models are provided, the method retrieves models from the data lifecycle. Each model is granted full permissions ('*'), and these permissions are merged into the configuration under the 'cli' role.

Parameters:

Parameter Type Description
$models array|null An associative array of models to add permissions for,
where keys are the model names and values are entities.
If null, the models are retrieved using the data lifecycle logic.

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