eZPublish  4.7
eZClusterFileHandler Class Reference

Static Public Member Functions

static addGeneratingFile ($file)
 Adds a file to the generating list. More...
 
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. More...
 
static cleanupGeneratingFiles ()
 Cluster shutdown handler. More...
 
static instance ($filename=false)
 Returns the configured instance of an eZClusterFileHandlerInterface See ClusteringSettings.FileHandler in file.ini. More...
 
static preFork ()
 Performs required operations before forking a process. More...
 
static removeGeneratingFile ($file)
 Removes a file from the generating list. More...
 
static resetHandler ()
 Resets the handler so that a new one can be loaded. More...
 
static searchPathArray ()
 

Static Public Attributes

static $globalHandler
 

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.

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

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

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.

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

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

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

Referenced by eZImageAliasHandler\aliasList(), eZPackage\appendSimpleFile(), eZPHPCreator\canRestore(), eZContentCache\cleanup(), eZCache\clearClassID(), eZCache\clearDesignBaseCache(), eZCache\clearItem(), eZCache\clearSortKey(), eZCache\clearStateLimitations(), eZCache\clearTextToImageCache(), contentPDFPassthrough(), eZImageManager\convert(), ezpRestCacheStorageCluster\countDataItems(), eZImageManager\createImageAlias(), ezpRestCacheStorageCluster\delete(), eZMediaType\deleteStoredObjectAttribute(), eZBinaryFileType\deleteStoredObjectAttribute(), eZContentCache\exists(), eZPHPCreator\exists(), eZContentLanguage\expireCache(), eZExpiryHandler\eZExpiryHandler(), eZContentLanguage\fetchList(), eZWebDAVContentServer\fetchNodeInfo(), eZWebDAVContentBackend\fetchNodeInfo(), eZMediaType\fetchObjectAttributeHTTPInput(), eZBinaryFileType\fetchObjectAttributeHTTPInput(), eZBinaryFile\fileSize(), eZMedia\fileSize(), eZNodeviewfunctions\generateNodeView(), ezpRestCacheStorageCluster\getRemainingLifetime(), eZWebDAVContentBackend\getResourceContents(), eZUser\getUserCacheByUserId(), eZTemplateCacheBlock\handle(), eZFilePassthroughHandler\handleFileDownload(), 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(), ezpContentPublishingProcess\publish(), eZImageAliasHandler\purgeAllAliases(), eZCache\purgeTextToImageCache(), eZUser\purgeUserCacheByUserId(), eZImageAliasHandler\recreateDOMTree(), eZImageAliasHandler\removeAliases(), eZImageAliasHandler\removeAllAliases(), eZSubtreeCache\removeExpiryCacheFromDisk(), eZContentCache\restore(), ezpRestCacheStorageCluster\restore(), eZPHPCreator\restore(), eZImageType\restoreTrashedObjectAttribute(), eZScriptClusterPurge\run(), eZTemplateImageOperator\setLoadImage(), ezpRestCacheStorageCluster\store(), eZContentCache\store(), eZTemplateImageOperator\storeImage(), eZRSSEditFunction\storeRSSExport(), eZImageType\trashStoredObjectAttribute(), eZMediaType\trashStoredObjectAttribute(), eZBinaryFileType\trashStoredObjectAttribute(), eZBinaryFileType\unserializeContentObjectAttribute(), eZMediaType\unserializeContentObjectAttribute(), eZImageAliasHandler\updateAliasPath(), and eZPHPCreator\writeChunks().

static eZClusterFileHandler::preFork ( )
static

Performs required operations before forking a process.

  • disconnects DB based cluster handlers from the database

Referenced by ezpContentPublishingProcess\publish().

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

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

static eZClusterFileHandler::resetHandler ( )
static

Resets the handler so that a new one can be loaded.

static eZClusterFileHandler::searchPathArray ( )
static
Deprecated:
4.3 No longer used as we rely on ezpExtension & autoloads
Returns
array list of directories used to search cluster file handlers for

Member Data Documentation

eZClusterFileHandler::$generatingFiles = array()
staticprivate
eZClusterFileHandler::$globalHandler
static
eZClusterFileHandler::$isShutdownFunctionRegistered = false
staticprivate

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