eZ Publish  [4.2]
Static Public Member Functions | Static Private Attributes
eZClusterFileHandler Class Reference

List of all members.

Static Public Member Functions

static addGeneratingFile ($file)
 Adds a file to the generating list.
static cleanupEmptyDirectories ($path)
 Goes trough the directory path and removes empty directories, starting at the leaf and deleting down until a non empty directory is reached.
static cleanupGeneratingFiles ()
 Cluster shutdown handler.
static instance ($filename=false)
 Returns the configured instance of an eZClusterFileHandlerInterface See ClusteringSettings.FileHandler in php.ini.
static removeGeneratingFile ($file)
 Removes a file from the generating list.
static searchPathArray ()

Static Private Attributes

static $generatingFiles = array()
static $isShutdownFunctionRegistered = false

Detailed Description

Special failure object which can be used by some of the cluster functions to inform about failures or special exceptions.

Currently used by the *processCache* function to report that the retrieve callback failed to retrieve data because of expiration.

Definition at line 10 of file ezclusterfilehandler.php.

Member Function Documentation

static eZClusterFileHandler::addGeneratingFile ( $  file) [static]

Adds a file to the generating list.

Parameters:
eZDFSFileHandler | eZDFSFileHandler$fileCluster file handler instance Note that this method expect a version of the handler where the filePath is the REAL one, not the .generating

Definition at line 142 of file ezclusterfilehandler.php.

Referenced by eZDBFileHandler\startCacheGeneration(), and eZDFSFileHandler\startCacheGeneration().

static eZClusterFileHandler::cleanupEmptyDirectories ( $  path) [static]

Goes trough the directory path and removes empty directories, starting at the leaf and deleting down until a non empty directory is reached.

If the path is not a directory, nothing will happen.

Parameters:
string$path

Definition at line 101 of file ezclusterfilehandler.php.

Referenced by eZDFSFileHandlerDFSBackend\delete(), eZFSFileHandler\delete(), eZFS2FileHandler\deleteLocal(), eZDBFileHandler\deleteLocal(), eZDFSFileHandler\deleteLocal(), eZDBFileHandler\fileDeleteLocal(), eZDFSFileHandler\fileDeleteLocal(), eZFS2FileHandler\purge(), eZFSFileHandler\purge(), eZDBFileHandler\purge(), eZDFSFileHandler\purge(), and eZDFSFileHandlerDFSBackend\renameOnDFS().

static eZClusterFileHandler::cleanupGeneratingFiles ( ) [static]

Cluster shutdown handler.

Terminates generation for unterminated files. This situation doesn't happen by default, but may with custom code that doesn't follow recommendations.

Definition at line 117 of file ezclusterfilehandler.php.

static eZClusterFileHandler::instance ( $  filename = false) [static]

Returns the configured instance of an eZClusterFileHandlerInterface See ClusteringSettings.FileHandler in php.ini.

Parameters:
string | bool$filenameOptional filename the handler should be initialized with
Returns:
eZClusterFileHandlerInterface

Definition at line 21 of file ezclusterfilehandler.php.

Referenced by eZImageAliasHandler\aliasList(), eZPackage\appendSimpleFile(), eZPHPCreator\canRestore(), eZContentCache\cleanup(), eZCache\clearClassID(), eZCache\clearItem(), eZCache\clearSortKey(), eZCache\clearStateLimitations(), eZCache\clearTextToImageCache(), eZMediaType\deleteStoredObjectAttribute(), eZBinaryFileType\deleteStoredObjectAttribute(), eZContentCache\exists(), eZPHPCreator\exists(), eZContentLanguage\expireCache(), eZContentLanguage\fetchList(), eZWebDAVContentServer\fetchNodeInfo(), eZWebDAVContentBackend\fetchNodeInfo(), eZMediaType\fetchObjectAttributeHTTPInput(), eZBinaryFileType\fetchObjectAttributeHTTPInput(), eZBinaryFile\fileSize(), eZMedia\fileSize(), eZNodeviewfunctions\generateNodeView(), eZTemplateCacheBlock\handle(), eZTemplateImageOperator\hasImage(), eZImageAliasHandler\imageAlias(), eZImageAliasHandler\initialize(), eZBinaryFileType\insertHTTPFile(), eZMediaType\insertHTTPFile(), eZBinaryFileType\insertRegularFile(), eZMediaType\insertRegularFile(), eZScriptClusterPurge\isRequired(), eZURLWildcard\loadCacheFile(), eZTemplateImageOperator\loadImage(), eZBinaryFile\metaData(), eZPDF\modify(), eZWebDAVContentServer\outputSendDataToClient(), eZTemplateCacheFunction\processCached(), eZCache\purgeTextToImageCache(), eZImageAliasHandler\recreateDOMTree(), eZImageAliasHandler\removeAliases(), eZImageAliasHandler\removeAllAliases(), eZSubtreeCache\removeExpiryCacheFromDisk(), eZContentCache\restore(), eZPHPCreator\restore(), eZScriptClusterPurge\run(), searchPathArray(), eZTemplateImageOperator\setLoadImage(), eZContentCache\store(), eZTemplateImageOperator\storeImage(), eZImageType\trashStoredObjectAttribute(), eZMediaType\trashStoredObjectAttribute(), eZBinaryFileType\trashStoredObjectAttribute(), eZBinaryFileType\unserializeContentObjectAttribute(), eZMediaType\unserializeContentObjectAttribute(), eZImageAliasHandler\updateAliasPath(), and eZPHPCreator\writeChunks().

static eZClusterFileHandler::removeGeneratingFile ( $  file) [static]

Removes a file from the generating list.

Parameters:
eZDBFileHandler | eZDFSFileHandler$fileCluster file handler instance Note that this method expect a version of the handler where the filePath is the REAL one, not the .generating
Todo:
Clustering: apply the eZClusterFileHandlerInterface to all cluster handlers

Definition at line 158 of file ezclusterfilehandler.php.

Referenced by eZDBFileHandler\abortCacheGeneration(), eZDFSFileHandler\abortCacheGeneration(), cleanupGeneratingFiles(), eZDBFileHandler\endCacheGeneration(), and eZDFSFileHandler\endCacheGeneration().

static eZClusterFileHandler::searchPathArray ( ) [static]
Returns:
list of directories used to search cluster file handlers for.

Definition at line 69 of file ezclusterfilehandler.php.

Member Data Documentation

eZClusterFileHandler::$generatingFiles = array() [static, private]

Definition at line 170 of file ezclusterfilehandler.php.

eZClusterFileHandler::$isShutdownFunctionRegistered = false [static, private]

Definition at line 176 of file ezclusterfilehandler.php.

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