kernel/private/classes/ezscriptclusterpurge.php

Show: inherited
Table of Contents

File containing the eZScriptClusterPurge class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
kernel  
Version
4.6.0  

\eZScriptClusterPurge

Package: Default

This class handles purging of cluster items. It is used by both the script and cronjob.

Performance note: this procedure should be quite nice to the server memory wise. It has been monitored as reaching about 5MB memory usage on a thousand items, and ended up with an almost constant usage. No particular setting should therefore be required to run it.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  

Constants

Constant  LOG_FILE = 'clusterpurge.log'

Properties

Propertypublicbool  = ''

optDryRun

optDryRun
Details
Type
bool
Magic
 
Property
optDryRun  
Propertypublicint  = ''

optIterationLimit

optIterationLimit
Details
Type
int
Magic
 
Property
optIterationLimit  
Propertypublicint  = ''

optIterationSleep

optIterationSleep
Details
Type
int
Magic
 
Property
optIterationSleep  
Propertypublicbool  = ''

optMemoryMonitoring

optMemoryMonitoring
Details
Type
bool
Magic
 
Property
optMemoryMonitoring  
Propertypublic\array(string)  = ''

optScopes

optScopes
Details
Type
\array(string)
Magic
 
Property
optScopes  
Propertypublicint  = ''

optExpiry

optExpiry
Details
Type
int
Magic
 
Property
optExpiry  
Propertyprivate  $options= 'array()'
Default valuearray()Details
Type
n/a

Methods

methodpublic__construct( ) : void

methodpublic__get(  $propertyName ) : void

Parameters
Name Type Description
$propertyName
methodpublic__set(  $propertyName,  $propertyValue ) : void

Parameters
Name Type Description
$propertyName
$propertyValue
Details
Todo
Add type & value check  
methodpublicisRequired( ) : bool
static

Performs preliminary checks in order to ensure the process can be started: - does the active cluster handler require purging of binary files

Returns
Type Description
bool
methodpublicmonitor(  $text ) : void

Parameters
Name Type Description
$text
methodpublicrun( ) : void

Executes the purge operation

Details
Todo
Endless loop on fetch list. The expired items are returned over and over again  
Documentation was generated by DocBlox 0.18.1.