Heratio Framework API Reference

ExpireDataCommand extends BaseCommand
in package

Expire and remove data past retention dates.

Ported from lib/task/tools/expireDataTask.class.php. Uses Propel for complex data expiry logic involving multiple related tables and cascade operations.

Table of Contents

Constants

ACCESS_LOG_MAX_AGE_DAYS  = 7

Properties

$TYPE_SPECIFICATIONS  : array<string|int, mixed>

Methods

__construct()  : mixed
getDescription()  : string
Get the command description.
getName()  : string
Get the command name.
getNamespace()  : string
Get the namespace portion of the command name.
run()  : int
Run the command (called by the CLI router).

Constants

Properties

$TYPE_SPECIFICATIONS

public static array<string|int, mixed> $TYPE_SPECIFICATIONS = ['access_log' => ['name' => 'access log', 'plural_name' => 'access logs', 'method_name' => 'accessLogExpireData', 'default_max_age' => self::ACCESS_LOG_MAX_AGE_DAYS], 'clipboard' => ['name' => 'saved clipboard', 'plural_name' => 'saved clipboards', 'method_name' => 'clipboardExpireData', 'age_setting_name' => 'app_clipboard_save_max_age'], 'job' => ['name' => 'job (and any related file)', 'plural_name' => 'jobs (and any related files)', 'method_name' => 'jobExpireData']]

Methods

__construct()

public __construct([array<string|int, mixed> $argv = [] ]) : mixed
Parameters
$argv : array<string|int, mixed> = []

getDescription()

Get the command description.

public getDescription() : string
Return values
string

getName()

Get the command name.

public getName() : string
Return values
string

getNamespace()

Get the namespace portion of the command name.

public getNamespace() : string
Return values
string

run()

Run the command (called by the CLI router).

public run() : int
Return values
int

        
On this page

Search results