kernel/classes/clusterfilehandlers/ezfsfilehandler.php

Show:

inherited

Classes
- \eZFSFileHandler

Table of Contents

File containing the eZFSFileHandler 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

\eZFSFileHandler
jump to top

Package: kernel

File containing the eZFSFileHandler class.

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

Constants

 
                EXPIRY_TIMESTAMP
                = 233366400

This should be defined in eZFS2FileHandler, but due to static members limitations in PHP < 5.3, it is declared here

Properties


                 $filePath= ''

Details

Type: n/a


                 $metaData= 'null'

Default valuenullDetails

Type: n/a

Methods

_exclusiveLock(
           $fname
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fname

_freeExclusiveLock(
           $fname
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fname

_mutex(
          
          )
        
        :
          void

abortCacheGeneration(
          
          )
        
        :
          void

Aborts the current cache generation process.

Does so by rolling back the current transaction, which should be the .generating file lock

checkCacheGenerationTimeout(
          
          )
        
        :
          void

Checks if the .generating file was changed, which would mean that generation timed out. If not timed out, refreshes the timestamp so that storage won't be stolen

delete(
          
          )
        
        :
          void

Deletes specified file/directory.

If a directory specified it is deleted recursively.

\public \static

deleteLocal(
          
          )
        
        :
          void

Deletes a file that has been fetched before.

In case of fetching from filesystem does nothing.

\public

eZFSFileHandler(
           $filePath
              =
              false
          )
        
        :
          void

Constructor.

$filePath File path. If specified, file metadata is fetched in the constructor.

Parameters

Name	Type	Description
$filePath

endCacheGeneration(
          
          )
        
        :
          void

Ends the cache generation started by startCacheGeneration().

exists(
          
          )
        
        :
          void

Check if given file/dir exists.

NOTE: this function does not interact with filesystem. Instead, it just returns existance status determined in the constructor.

\public

fetch(
           $noLocalCache
              =
              false
          )
        
        :
          void

Fetches file from db and saves it in FS under the same name.

In case of fetching from filesystem does nothing.

Parameters

Name	Type	Description
$noLocalCache

fetchContents(
          
          )
        
        :
          void

Returns file contents.

\public \return contents string, or false in case of an error.

fetchUnique(
          
          )
        
        :
          string

Fetches file from db and saves it in FS under unique name.

In case of fetching from filesystem, does nothing

Returns

Type	Description
string	The unique file path. on FS, the file path.

fileCopy(
           $srcPath,  $dstPath
          )
        
        :
          void

Copy file.

\public \static

Parameters

Name	Type	Description
$srcPath
$dstPath

fileDelete(
           $path,  $fnamePart
              =
              false
          )
        
        :
          void

\public \static

Parameters

Name	Type	Description
$path
$fnamePart

fileDeleteByDirList(
           $dirList,  $commonPath,  $commonSuffix
          )
        
        :
          void

Delete files located in a directories from dirList, with common prefix specified by commonPath, and common suffix with added wildcard at the end

\public \static \sa fileDeleteByRegex()

Parameters

Name	Type	Description
$dirList
$commonPath
$commonSuffix

fileDeleteByRegex(
           $dir,  $fileRegex
          )
        
        :
          void

Delete files matching regex $fileRegex under directory $dir.

\public \static \sa fileDeleteByWildcard()

Parameters

Name	Type	Description
$dir
$fileRegex

fileDeleteByWildcard(
           $wildcard
          )
        
        :
          void

Delete files matching given wildcard.

Note that this method is faster than fileDeleteByRegex().

\public \static \sa fileDeleteByRegex()

Parameters

Name	Type	Description
$wildcard

fileDeleteLocal(
           $path
          )
        
        :
          void

Deletes a file that has been fetched before.

Parameters

Name	Type	Description
$path

Details

See: \fetchUnique

fileExists(
           $path
          )
        
        :
          void

Check if given file/dir exists.

\public \static

Parameters

Name	Type	Description
$path

fileFetch(
           $filePath
          )
        
        :
          void

Fetches file from db and saves it in FS under the same name.

In case of fetching from filesystem does nothing.

Parameters

Name	Type	Description
$filePath

fileFetchContents(
           $filePath
          )
        
        :
          string | false

Returns file contents.

Parameters

Name	Type	Description
$filePath

Returns

Type	Description
string \| false	contents string, or false in case of an error.

fileLinkCopy(
           $srcPath,  $dstPath,  $symLink
          )
        
        :
          void

Create symbolic or hard link to file.

\public \static

Parameters

Name	Type	Description
$srcPath
$dstPath
$symLink

fileMove(
           $srcPath,  $dstPath
          )
        
        :
          void

Move file.

\public \static

Parameters

Name	Type	Description
$srcPath
$dstPath

fileStore(
          string $filePath, string $scope
              =
              false, string $delete
              =
              false,  $datatype
              =
              false
          )
        
        :
          void

Store file.

In case of storing to filesystem does nothing.

Parameters

Name	Type	Description
$filePath	string	Path to the file being stored.
$scope	string	Means something like "file category". May be used to clean caches of a certain type.
$delete	string	true if the file should be deleted after storing.
$datatype

fileStoreContents(
           $filePath,  $contents,  $scope
              =
              false,  $datatype
              =
              false
          )
        
        :
          void

Store file contents.

\public \static

Parameters

Name	Type	Description
$filePath
$contents
$scope
$datatype

isExpired(
          int $expiry, int $curtime, int $ttl
          )
        
        :
          bool

Calculates if the current file data is expired or not.

Parameters

Name	Type	Description
$expiry	int	Time when file is to be expired, a value of -1 will disable this check.
$curtime	int	The current time to check against.
$ttl	int	Number of seconds the data can live, set to null to disable TTL.

Returns

Type	Description
bool

isFileExpired(
          string $fname, int $mtime, int $expiry, int $curtime, int $ttl
          )
        
        :
          bool

static

Calculates if the file data is expired or not.

Parameters

Name	Type	Description
$fname	string	Name of file, available for easy debugging.
$mtime	int	Modification time of file, can be set to false if file does not exist.
$expiry	int	Time when file is to be expired, a value of -1 will disable this check.
$curtime	int	The current time to check against.
$ttl	int	Number of seconds the data can live, set to null to disable TTL.

Returns

Type	Description
bool

loadMetaData(
           $force
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$force

move(
           $dstPath
          )
        
        :
          void

Move file.

\public

Parameters

Name	Type	Description
$dstPath

Returns file modification time.

\public

Returns file name.

\public

passthrough(
          int $offset
              =
              0, int $length
              =
              false
          )
        
        :
          void

Outputs file contents to the browser Note: does not handle headers. eZFile::downloadHeaders() can be used for this

Parameters

Name	Type	Description
$offset	int	Transfer start offset
$length	int	Transfer length, in bytes

processCache(
           $retrieveCallback,  $generateCallback
              =
              null,  $ttl
              =
              null,  $expiry
              =
              null,  $extraData
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$retrieveCallback
$generateCallback
$ttl
$expiry
$extraData

processFile(
           $callback,  $expiry
              =
              false,  $extraData
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$callback
$expiry
$extraData

purge(
           $printCallback
              =
              false,  $microsleep
              =
              false,  $max
              =
              false,  $expiry
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$printCallback
$microsleep
$max
$expiry

requiresBinaryPurge(
          
          )
        
        :
          bool

eZFS does not require binary purge.

Files are stored on plain FS and removed using FS functions

Returns

Type	Description
bool

Details

Deprecated: Deprecated as of 4.5, use {@link eZFSFileHandler::requiresPurge()} instead.
Since: 4.3

requiresClusterizing(
          
          )
        
        :
          bool

eZFS only stores data to FS and doesn't require/support clusterizing

Returns

Type	Description
bool	false

requiresPurge(
          
          )
        
        :
          bool

eZFS does not require binary purge.

Files are stored on plain FS and removed using FS functions

Returns

Type	Description
bool

Details

Since: 4.5.0

Returns file size.

\public

startCacheGeneration(
          
          )
        
        :
          mixed

Starts cache generation for the current file.

This is done by creating a file named by the original file name, prefixed with '.generating'.

Returns

Type	Description
mixed	true if generation lock was granted, an integer matching the time before the current generation times out

Details

Todo: add timeout handling...

Returns file metadata.

\public

storeCache(
           $fileData,  $storeCache
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$fileData
$storeCache

storeContents(
          string $contents, string $scope
              =
              false, string $datatype
              =
              false, bool $storeLocally
              =
              false
          )
        
        :
          void

Store file contents to disk

Parameters

Name	Type	Description
$contents	string	Binary file data
$scope	string	Not used in the FS handler
$datatype	string	Not used in the FS handler
$storeLocally	bool	Not used in the FS handler

kernel/classes/clusterfilehandlers/ezfsfilehandler.php

\eZFSFileHandlerjump to top

Constants

Properties

Methods

\eZFSFileHandler
jump to top