eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZScriptTrashPurge

class eZScriptTrashPurge

This class handles purging of trash items.

It is used by both the script and cronjob.

Methods

__construct(eZCLI $cli, bool $quiet = true, bool $memoryMonitoring = false, eZScript $script = null, string $logFile = 'trashpurge.log')

Constructor of eZScriptTrashPurge.

bool run(int|null $iterationLimit = 100, int|null $sleep = 1)

Executes the purge operation

Details

at line 58
public __construct(eZCLI $cli, bool $quiet = true, bool $memoryMonitoring = false, eZScript $script = null, string $logFile = 'trashpurge.log')

Constructor of eZScriptTrashPurge.

Parameters

eZCLI $cli The instance of eZCLI.
bool $quiet Whether the operation should be quiet or not.
bool $memoryMonitoring Set to true to turn on memory monitoring.
eZScript $script Optional eZScript object used while running.
string $logFile Log file to use for memory monitoring.

at line 75
public bool run(int|null $iterationLimit = 100, int|null $sleep = 1)

Executes the purge operation

Parameters

int|null $iterationLimit Number of trashed objects to treat per iteration, use null to use a default value.
int|null $sleep Number of seconds to sleep between two iterations, use null to use a default value.

Return Value

bool True if the operation succeeded.