DataLifeCycleTask
- Full name:
\PhalconKit\Modules\Cli\Tasks\DataLifeCycleTask - Parent class:
\PhalconKit\Modules\Cli\Task
Properties
cliDoc
public string $cliDoc
dataLifeCycleConfig
Configuration array for defining the data lifecycle settings, including the models and policies applicable.
public array $dataLifeCycleConfig
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.
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.
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: