eZPublishCommunityProject(LegacyStack)  2013.5
eZScriptTrashPurge Class Reference

Public Member Functions

 __construct (eZCLI $cli, $quiet=true, $memoryMonitoring=false, eZScript $script=null, $logFile="trashpurge.log")
 Constructor of eZScriptTrashPurge. More...
 
 run ($iterationLimit=100, $sleep=1)
 Executes the purge operation. More...
 

Protected Attributes

 $cli
 
 $logFile
 
 $memoryMonitoring
 
 $quiet
 
 $script
 

Private Member Functions

 monitor ($text)
 Log memory usage. More...
 

Constructor & Destructor Documentation

eZScriptTrashPurge::__construct ( eZCLI  $cli,
  $quiet = true,
  $memoryMonitoring = false,
eZScript  $script = null,
  $logFile = "trashpurge.log" 
)

Constructor of eZScriptTrashPurge.

Parameters
eZCLI$cliThe instance of eZCLI.
bool$quietWhether the operation should be quiet or not.
bool$memoryMonitoringSet to true to turn on memory monitoring.
eZScript$scriptOptional eZScript object used while running.
string$logFileLog file to use for memory monitoring.

Member Function Documentation

eZScriptTrashPurge::monitor (   $text)
private

Log memory usage.

Parameters
string$textText to use while logging.

Referenced by run().

eZScriptTrashPurge::run (   $iterationLimit = 100,
  $sleep = 1 
)

Executes the purge operation.

Parameters
int | null$iterationLimitNumber of trashed objects to treat per iteration, use null to use a default value.
int | null$sleepNumber of seconds to sleep between two iterations, use null to use a default value.
Returns
bool True if the operation succeeded.

Member Data Documentation

eZScriptTrashPurge::$cli
protected

Referenced by __construct().

eZScriptTrashPurge::$logFile
protected

Referenced by __construct().

eZScriptTrashPurge::$memoryMonitoring
protected

Referenced by __construct().

eZScriptTrashPurge::$quiet
protected

Referenced by __construct().

eZScriptTrashPurge::$script
protected

Referenced by __construct().


The documentation for this class was generated from the following file: