Zend_Cache_Backend_File Class Reference

Inheritance diagram for Zend_Cache_Backend_File:

Public Member Functions
	__construct (array $options=array())
	setCacheDir ($value, $trailingSeparator=true)
	load ($id, $doNotTestCacheValidity=false)
	test ($id)
	save ($data, $id, $tags=array(), $specificLifetime=false)
	remove ($id)
	clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
	getIds ()
	getTags ()
	getIdsMatchingTags ($tags=array())
	getIdsNotMatchingTags ($tags=array())
	getIdsMatchingAnyTags ($tags=array())
	getFillingPercentage ()
	getMetadatas ($id)
	touch ($id, $extraLifetime)
	getCapabilities ()
	___expire ($id)
Public Member Functions inherited from Zend_Cache_Backend
	__construct (array $options=array())
	setDirectives ($directives)
	setOption ($name, $value)
	getOption ($name)
	getLifetime ($specificLifetime)
	isAutomaticCleaningAvailable ()
	getTmpDir ()
Public Member Functions inherited from Zend_Cache_Backend_Interface
	setDirectives ($directives)

Protected Member Functions
	_getMetadatas ($id)
	_setMetadatas ($id, $metadatas, $save=true)
	_delMetadatas ($id)
	_cleanMetadatas ()
	_loadMetadatas ($id)
	_saveMetadatas ($id, $metadatas)
	_metadatasFile ($id)
	_isMetadatasFile ($fileName)
	_remove ($file)
	_clean ($dir, $mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
	_get ($dir, $mode, $tags=array())
	_expireTime ($lifetime)
	_hash ($data, $controlType)
	_idToFileName ($id)
	_file ($id)
	_path ($id, $parts=false)
	_recursiveMkdirAndChmod ($id)
	_test ($id, $doNotTestCacheValidity)
	_fileGetContents ($file)
	_filePutContents ($file, $string)
	_fileNameToId ($fileName)
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)
	_loggerSanity ()
	_log ($message, $priority=4)

Protected Attributes
	$_options
	$_metadatasArray = array()
Protected Attributes inherited from Zend_Cache_Backend
	$_directives
	$_options = array()

Detailed Description

Definition at line 40 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

associative array of options

Exceptions

Zend_Cache_Exception

Definition at line 124 of file File.php.

    {
        parent::__construct($options);
        if ($this->_options['cache_dir'] !== null) { // particular case for this option
            $this->setCacheDir($this->_options['cache_dir']);
        } else {
            $this->setCacheDir(self::getTmpDir() . DIRECTORY_SEPARATOR, false);
        }
        if (isset($this->_options['file_name_prefix'])) { // particular case for this option
            if (!preg_match('~^[a-zA-Z0-9_]+$~D', $this->_options['file_name_prefix'])) {
                Zend_Cache::throwException('Invalid file_name_prefix : must use only [a-zA-Z0-9_]');
            }
        }
        if ($this->_options['metadatas_array_max_size'] < 10) {
            Zend_Cache::throwException('Invalid metadatas_array_max_size, must be > 10');
        }

        if (isset($options['hashed_directory_umask'])) {
            // See #ZF-12047
            trigger_error("'hashed_directory_umask' is deprecated -> please use 'hashed_directory_perm' instead", E_USER_NOTICE);
            if (!isset($options['hashed_directory_perm'])) {
                $options['hashed_directory_perm'] = $options['hashed_directory_umask'];
            }
        }
        if (isset($options['hashed_directory_perm']) && is_string($options['hashed_directory_perm'])) {
            // See #ZF-4422
            $this->_options['hashed_directory_perm'] = octdec($this->_options['hashed_directory_perm']);
        }

        if (isset($options['cache_file_umask'])) {
            // See #ZF-12047
            trigger_error("'cache_file_umask' is deprecated -> please use 'cache_file_perm' instead", E_USER_NOTICE);
            if (!isset($options['cache_file_perm'])) {
                $options['cache_file_perm'] = $options['cache_file_umask'];
            }
        }
        if (isset($options['cache_file_perm']) && is_string($options['cache_file_perm'])) {
            // See #ZF-4422
            $this->_options['cache_file_perm'] = octdec($this->_options['cache_file_perm']);
        }
    }

Member Function Documentation

___expire()

___expire

(

$id

)

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire

Parameters

string

$id

cache id

Definition at line 483 of file File.php.

    {
        $metadatas = $this->_getMetadatas($id);
        if ($metadatas) {
            $metadatas['expire'] = 1;
            $this->_setMetadatas($id, $metadatas);
        }
    }

_clean()

_clean (   $dir,   $mode = Zend_Cache::CLEANING_MODE_ALL,   $tags = array()  )

protected

Clean some cache records (protected method used for recursive stuff)

Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

string	$dir	Directory to clean
string	$mode	Clean mode
array	$tags	Array of tags

Exceptions

Zend_Cache_Exception

Returns

boolean True if no problem

Definition at line 665 of file File.php.

    {
        if (!is_dir($dir)) {
            return false;
        }
        $result = true;
        $prefix = $this->_options['file_name_prefix'];
        $glob = @glob($dir . $prefix . '--*');
        if ($glob === false) {
            // On some systems it is impossible to distinguish between empty match and an error.
            return true;
        }
        $metadataFiles = array();
        foreach ($glob as $file)  {
            if (is_file($file)) {
                $fileName = basename($file);
                if ($this->_isMetadatasFile($fileName)) {
                    // In CLEANING_MODE_ALL, we drop anything, even remainings old metadatas files.
                    // To do that, we need to save the list of the metadata files first.
                    if ($mode == Zend_Cache::CLEANING_MODE_ALL) {
                        $metadataFiles[] = $file;
                    }
                    continue;
                }
                $id = $this->_fileNameToId($fileName);
                $metadatas = $this->_getMetadatas($id);
                if ($metadatas === FALSE) {
                    $metadatas = array('expire' => 1, 'tags' => array());
                }
                switch ($mode) {
                    case Zend_Cache::CLEANING_MODE_ALL:
                        $result = $result && $this->remove($id);
                        break;
                    case Zend_Cache::CLEANING_MODE_OLD:
                        if (time() > $metadatas['expire']) {
                            $result = $this->remove($id) && $result;
                        }
                        break;
                    case Zend_Cache::CLEANING_MODE_MATCHING_TAG:
                        $matching = true;
                        foreach ($tags as $tag) {
                            if (!in_array($tag, $metadatas['tags'])) {
                                $matching = false;
                                break;
                            }
                        }
                        if ($matching) {
                            $result = $this->remove($id) && $result;
                        }
                        break;
                    case Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG:
                        $matching = false;
                        foreach ($tags as $tag) {
                            if (in_array($tag, $metadatas['tags'])) {
                                $matching = true;
                                break;
                            }
                        }
                        if (!$matching) {
                            $result = $this->remove($id) && $result;
                        }
                        break;
                    case Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG:
                        $matching = false;
                        foreach ($tags as $tag) {
                            if (in_array($tag, $metadatas['tags'])) {
                                $matching = true;
                                break;
                            }
                        }
                        if ($matching) {
                            $result = $this->remove($id) && $result;
                        }
                        break;
                    default:
                        Zend_Cache::throwException('Invalid mode for clean() method');
                        break;
                }
            }
            if ((is_dir($file)) and ($this->_options['hashed_directory_level']>0)) {
                // Recursive call
                $result = $this->_clean($file . DIRECTORY_SEPARATOR, $mode, $tags) && $result;
                if ($mode == Zend_Cache::CLEANING_MODE_ALL) {
                    // we try to drop the structure too
                    @rmdir($file);
                }
            }
        }

        // cycle through metadataFiles and delete orphaned ones
        foreach ($metadataFiles as $file) {
            if (file_exists($file)) {
                $result = $this->_remove($file) && $result;
            }
        }

        return $result;
    }

_cleanMetadatas()

_cleanMetadatas ( )

protected

Clear the metadatas array

Returns

void

Definition at line 556 of file File.php.

    {
        $this->_metadatasArray = array();
    }

_delMetadatas()

_delMetadatas (   $id )

protected

Drop a metadata record

Parameters

string

$id

Cache id

Returns

boolean True if no problem

Definition at line 542 of file File.php.

    {
        if (isset($this->_metadatasArray[$id])) {
            unset($this->_metadatasArray[$id]);
        }
        $file = $this->_metadatasFile($id);
        return $this->_remove($file);
    }

_expireTime()

_expireTime (   $lifetime )

protected

Compute & return the expire time

Parameters

int

$lifetime

Returns

int expire time (unix timestamp)

Definition at line 854 of file File.php.

    {
        if ($lifetime === null) {
            return 9999999999;
        }
        return time() + $lifetime;
    }

_file()

_file (   $id )

protected

Make and return a file name (with path)

Parameters

string

$id

Cache id

Returns

string File name (with path)

Definition at line 905 of file File.php.

    {
        $path = $this->_path($id);
        $fileName = $this->_idToFileName($id);
        return $path . $fileName;
    }

_fileGetContents()

_fileGetContents (   $file )

protected

Return the file content of the given file

Parameters

string

$file

File complete path

Returns

string File content (or false if problem)

Definition at line 984 of file File.php.

    {
        $result = false;
        if (!is_file($file)) {
            return false;
        }
        $f = @fopen($file, 'rb');
        if ($f) {
            if ($this->_options['file_locking']) @flock($f, LOCK_SH);
            $result = stream_get_contents($f);
            if ($this->_options['file_locking']) @flock($f, LOCK_UN);
            @fclose($f);
        }
        return $result;
    }

_fileNameToId()

_fileNameToId (   $fileName )

protected

Transform a file name into cache id and return it

Parameters

string

$fileName

File name

Returns

string Cache id

Definition at line 1031 of file File.php.

    {
        $prefix = $this->_options['file_name_prefix'];
        return preg_replace('~^' . $prefix . '---(.*)$~', '$1', $fileName);
    }

_filePutContents()

_filePutContents (   $file,   $string  )

protected

Put the given string into the given file

Parameters

string	$file	File complete path
string	$string	String to put in file

Returns

boolean true if no problem

Definition at line 1007 of file File.php.

    {
        $result = false;
        $f = @fopen($file, 'ab+');
        if ($f) {
            if ($this->_options['file_locking']) @flock($f, LOCK_EX);
            fseek($f, 0);
            ftruncate($f, 0);
            $tmp = @fwrite($f, $string);
            if (!($tmp === FALSE)) {
                $result = true;
            }
            @fclose($f);
        }
        @chmod($file, $this->_options['cache_file_perm']);
        return $result;
    }

_get()

_get (   $dir,   $mode,   $tags = array()  )

protected

Definition at line 764 of file File.php.

    {
        if (!is_dir($dir)) {
            return false;
        }
        $result = array();
        $prefix = $this->_options['file_name_prefix'];
        $glob = @glob($dir . $prefix . '--*');
        if ($glob === false) {
            // On some systems it is impossible to distinguish between empty match and an error.
            return array();
        }
        foreach ($glob as $file)  {
            if (is_file($file)) {
                $fileName = basename($file);
                $id = $this->_fileNameToId($fileName);
                $metadatas = $this->_getMetadatas($id);
                if ($metadatas === FALSE) {
                    continue;
                }
                if (time() > $metadatas['expire']) {
                    continue;
                }
                switch ($mode) {
                    case 'ids':
                        $result[] = $id;
                        break;
                    case 'tags':
                        $result = array_unique(array_merge($result, $metadatas['tags']));
                        break;
                    case 'matching':
                        $matching = true;
                        foreach ($tags as $tag) {
                            if (!in_array($tag, $metadatas['tags'])) {
                                $matching = false;
                                break;
                            }
                        }
                        if ($matching) {
                            $result[] = $id;
                        }
                        break;
                    case 'notMatching':
                        $matching = false;
                        foreach ($tags as $tag) {
                            if (in_array($tag, $metadatas['tags'])) {
                                $matching = true;
                                break;
                            }
                        }
                        if (!$matching) {
                            $result[] = $id;
                        }
                        break;
                    case 'matchingAny':
                        $matching = false;
                        foreach ($tags as $tag) {
                            if (in_array($tag, $metadatas['tags'])) {
                                $matching = true;
                                break;
                            }
                        }
                        if ($matching) {
                            $result[] = $id;
                        }
                        break;
                    default:
                        Zend_Cache::throwException('Invalid mode for _get() method');
                        break;
                }
            }
            if ((is_dir($file)) and ($this->_options['hashed_directory_level']>0)) {
                // Recursive call
                $recursiveRs =  $this->_get($file . DIRECTORY_SEPARATOR, $mode, $tags);
                if ($recursiveRs === false) {
                    $this->_log('Zend_Cache_Backend_File::_get() / recursive call : can\'t list entries of "'.$file.'"');
                } else {
                    $result = array_unique(array_merge($result, $recursiveRs));
                }
            }
        }
        return array_unique($result);
    }

_getMetadatas()

_getMetadatas (   $id )

protected

Get a metadatas record

Parameters

string

$id

Cache id

Returns

array|false Associative array of metadatas

Definition at line 498 of file File.php.

    {
        if (isset($this->_metadatasArray[$id])) {
            return $this->_metadatasArray[$id];
        } else {
            $metadatas = $this->_loadMetadatas($id);
            if (!$metadatas) {
                return false;
            }
            $this->_setMetadatas($id, $metadatas, false);
            return $metadatas;
        }
    }

_hash()

_hash (   $data,   $controlType  )

protected

Make a control key with the string containing datas

Parameters

string	$data	Data
string	$controlType	Type of control 'md5', 'crc32' or 'strlen'

Exceptions

Zend_Cache_Exception

Returns

string Control key

Definition at line 870 of file File.php.

    {
        switch ($controlType) {
        case 'md5':
            return md5($data);
        case 'crc32':
            return crc32($data);
        case 'strlen':
            return strlen($data);
        case 'adler32':
            return hash('adler32', $data);
        default:
            Zend_Cache::throwException("Incorrect hash function : $controlType");
        }
    }

_idToFileName()

_idToFileName (   $id )

protected

Transform a cache id into a file name and return it

Parameters

string

$id

Cache id

Returns

string File name

Definition at line 892 of file File.php.

    {
        $prefix = $this->_options['file_name_prefix'];
        $result = $prefix . '---' . $id;
        return $result;
    }

_isMetadatasFile()

_isMetadatasFile (   $fileName )

protected

Check if the given filename is a metadatas one

Parameters

string

$fileName

File name

Returns

boolean True if it's a metadatas one

Definition at line 614 of file File.php.

    {
        $id = $this->_fileNameToId($fileName);
        if (substr($id, 0, 21) == 'internal-metadatas---') {
            return true;
        } else {
            return false;
        }
    }

_loadMetadatas()

_loadMetadatas (   $id )

protected

Load metadatas from disk

Parameters

string

$id

Cache id

Returns

array|false Metadatas associative array

Definition at line 567 of file File.php.

    {
        $file = $this->_metadatasFile($id);
        $result = $this->_fileGetContents($file);
        if (!$result) {
            return false;
        }
        $tmp = @unserialize($result);
        return $tmp;
    }

_metadatasFile()

_metadatasFile (   $id )

protected

Make and return a file name (with path) for metadatas

Parameters

string

$id

Cache id

Returns

string Metadatas file name (with path)

Definition at line 601 of file File.php.

    {
        $path = $this->_path($id);
        $fileName = $this->_idToFileName('internal-metadatas---' . $id);
        return $path . $fileName;
    }

_path()

_path (   $id,   $parts = false  )

protected

Return the complete directory path of a filename (including hashedDirectoryStructure)

Parameters

string	$id	Cache id
boolean	$parts	if true, returns array of directory parts instead of single string

Returns

string Complete directory path

Definition at line 919 of file File.php.

    {
        $partsArray = array();
        $root = $this->_options['cache_dir'];
        $prefix = $this->_options['file_name_prefix'];
        if ($this->_options['hashed_directory_level']>0) {
            $hash = hash('adler32', $id);
            for ($i=0 ; $i < $this->_options['hashed_directory_level'] ; $i++) {
                $root = $root . $prefix . '--' . substr($hash, 0, $i + 1) . DIRECTORY_SEPARATOR;
                $partsArray[] = $root;
            }
        }
        if ($parts) {
            return $partsArray;
        } else {
            return $root;
        }
    }

_recursiveMkdirAndChmod()

_recursiveMkdirAndChmod (   $id )

protected

Make the directory strucuture for the given id

Parameters

string

$id

cache id

Returns

boolean true

Definition at line 944 of file File.php.

    {
        if ($this->_options['hashed_directory_level'] <=0) {
            return true;
        }
        $partsArray = $this->_path($id, true);
        foreach ($partsArray as $part) {
            if (!is_dir($part)) {
                @mkdir($part, $this->_options['hashed_directory_perm']);
                @chmod($part, $this->_options['hashed_directory_perm']); // see #ZF-320 (this line is required in some configurations)
            }
        }
        return true;
    }

_remove()

_remove (   $file )

protected

Remove a file

If we can't remove the file (because of locks or any problem), we will touch the file to invalidate it

Parameters

string

$file

Complete file path

Returns

boolean True if ok

Definition at line 633 of file File.php.

    {
        if (!is_file($file)) {
            return false;
        }
        if (!@unlink($file)) {
            # we can't remove the file (because of locks or any problem)
            $this->_log("Zend_Cache_Backend_File::_remove() : we can't remove $file");
            return false;
        }
        return true;
    }

_saveMetadatas()

_saveMetadatas (   $id,   $metadatas  )

protected

Save metadatas to disk

Parameters

string	$id	Cache id
array	$metadatas	Associative array

Returns

boolean True if no problem

Definition at line 585 of file File.php.

    {
        $file = $this->_metadatasFile($id);
        $result = $this->_filePutContents($file, serialize($metadatas));
        if (!$result) {
            return false;
        }
        return true;
    }

_setMetadatas()

_setMetadatas (   $id,   $metadatas,   $save = true  )

protected

Set a metadatas record

Parameters

string	$id	Cache id
array	$metadatas	Associative array of metadatas
boolean	$save	optional pass false to disable saving to file

Returns

boolean True if no problem

Definition at line 520 of file File.php.

    {
        if (count($this->_metadatasArray) >= $this->_options['metadatas_array_max_size']) {
            $n = (int) ($this->_options['metadatas_array_max_size'] / 10);
            $this->_metadatasArray = array_slice($this->_metadatasArray, $n);
        }
        if ($save) {
            $result = $this->_saveMetadatas($id, $metadatas);
            if (!$result) {
                return false;
            }
        }
        $this->_metadatasArray[$id] = $metadatas;
        return true;
    }

_test()

_test (   $id,   $doNotTestCacheValidity  )

protected

Test if the given cache id is available (and still valid as a cache record)

Parameters

string	$id	Cache id
boolean	$doNotTestCacheValidity	If set to true, the cache validity won't be tested

Returns

boolean|mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Definition at line 966 of file File.php.

    {
        $metadatas = $this->_getMetadatas($id);
        if (!$metadatas) {
            return false;
        }
        if ($doNotTestCacheValidity || (time() <= $metadatas['expire'])) {
            return $metadatas['mtime'];
        }
        return false;
    }

clean()

clean	(		$mode = Zend_Cache::CLEANING_MODE_ALL,
			$tags = array()
	)

Clean some cache records

Available modes are :

Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

string	$mode	clean mode
array	$tags	array of tags

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 308 of file File.php.

    {
        // We use this protected method to hide the recursive stuff
        clearstatcache();
        return $this->_clean($this->_options['cache_dir'], $mode, $tags);
    }

getCapabilities()

getCapabilities

(

)

Return an associative array of capabilities (booleans) of the backend

The array must include these keys :

• automatic_cleaning (is automating cleaning necessary)
• tags (are tags supported)
• expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example))
• priority does the backend deal with priority when saving
• infinite_lifetime (is infinite lifetime can work with this backend)
• get_list (is it possible to get the list of cache ids and the complete list of tags)

Returns

array associative of with capabilities

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 464 of file File.php.

    {
        return array(
            'automatic_cleaning' => true,
            'tags' => true,
            'expired_read' => true,
            'priority' => false,
            'infinite_lifetime' => true,
            'get_list' => true
        );
    }

getFillingPercentage()

getFillingPercentage

(

)

Return the filling percentage of the backend storage

Exceptions

Zend_Cache_Exception

Returns

int integer between 0 and 100

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 380 of file File.php.

    {
        $free = disk_free_space($this->_options['cache_dir']);
        $total = disk_total_space($this->_options['cache_dir']);
        if ($total == 0) {
            Zend_Cache::throwException('can\'t get disk_total_space');
        } else {
            if ($free >= $total) {
                return 100;
            }
            return ((int) (100. * ($total - $free) / $total));
        }
    }

getIds()

getIds

(

)

Return an array of stored cache ids

Returns

array array of stored cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 320 of file File.php.

    {
        return $this->_get($this->_options['cache_dir'], 'ids', array());
    }

getIdsMatchingAnyTags()

getIdsMatchingAnyTags

(

$tags = array()

)

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical AND is made between tags

Parameters

array

$tags

array of tags

Returns

array array of any matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 369 of file File.php.

    {
        return $this->_get($this->_options['cache_dir'], 'matchingAny', $tags);
    }

getIdsMatchingTags()

getIdsMatchingTags

(

$tags = array()

)

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags

Parameters

array

$tags

array of tags

Returns

array array of matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 343 of file File.php.

    {
        return $this->_get($this->_options['cache_dir'], 'matching', $tags);
    }

getIdsNotMatchingTags()

getIdsNotMatchingTags

(

$tags = array()

)

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags

Parameters

array

$tags

array of tags

Returns

array array of not matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 356 of file File.php.

    {
        return $this->_get($this->_options['cache_dir'], 'notMatching', $tags);
    }

getMetadatas()

getMetadatas

(

$id

)

Return an array of metadatas for the given cache id

The array must include these keys :

• expire : the expire timestamp
• tags : a string array of tags
• mtime : timestamp of last modification time

Parameters

string

$id

cache id

Returns

array array of metadatas (false if the cache id is not found)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 405 of file File.php.

    {
        $metadatas = $this->_getMetadatas($id);
        if (!$metadatas) {
            return false;
        }
        if (time() > $metadatas['expire']) {
            return false;
        }
        return array(
            'expire' => $metadatas['expire'],
            'tags' => $metadatas['tags'],
            'mtime' => $metadatas['mtime']
        );
    }

getTags()

getTags

(

)

Return an array of stored tags

Returns

array array of stored tags (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 330 of file File.php.

    {
        return $this->_get($this->_options['cache_dir'], 'tags', array());
    }

load()

load	(		$id,
			$doNotTestCacheValidity = false
	)

Test if a cache is available for the given id and (if yes) return it (false else)

Parameters

string	$id	cache id
boolean	$doNotTestCacheValidity	if set to true, the cache validity won't be tested

Returns

string|false cached datas

Implements Zend_Cache_Backend_Interface.

Definition at line 196 of file File.php.

    {
        if (!($this->_test($id, $doNotTestCacheValidity))) {
            // The cache is not hit !
            return false;
        }
        $metadatas = $this->_getMetadatas($id);
        $file = $this->_file($id);
        $data = $this->_fileGetContents($file);
        if ($this->_options['read_control']) {
            $hashData = $this->_hash($data, $this->_options['read_control_type']);
            $hashControl = $metadatas['hash'];
            if ($hashData != $hashControl) {
                // Problem detected by the read control !
                $this->_log('Zend_Cache_Backend_File::load() / read_control : stored hash and computed hash do not match');
                $this->remove($id);
                return false;
            }
        }
        return $data;
    }

remove()

remove

(

$id

)

Remove a cache record

Parameters

string

$id

cache id

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 282 of file File.php.

    {
        $file = $this->_file($id);
        $boolRemove   = $this->_remove($file);
        $boolMetadata = $this->_delMetadatas($id);
        return $boolMetadata && $boolRemove;
    }

save()

save	(		$data,
			$id,
			$tags = array(),
			$specificLifetime = false
	)

Save some string datas into a cache record

Note : $data is always "string" (serialization is done by the core not by the backend)

Parameters

string	$data	Datas to cache
string	$id	Cache id
array	$tags	Array of strings, the cache record will be tagged by each string entry
boolean | int	$specificLifetime	If != false, set a specific lifetime for this cache record (null => infinite lifetime)

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 242 of file File.php.

    {
        clearstatcache();
        $file = $this->_file($id);
        $path = $this->_path($id);
        if ($this->_options['hashed_directory_level'] > 0) {
            if (!is_writable($path)) {
                // maybe, we just have to build the directory structure
                $this->_recursiveMkdirAndChmod($id);
            }
            if (!is_writable($path)) {
                return false;
            }
        }
        if ($this->_options['read_control']) {
            $hash = $this->_hash($data, $this->_options['read_control_type']);
        } else {
            $hash = '';
        }
        $metadatas = array(
            'hash' => $hash,
            'mtime' => time(),
            'expire' => $this->_expireTime($this->getLifetime($specificLifetime)),
            'tags' => $tags
        );
        $res = $this->_setMetadatas($id, $metadatas);
        if (!$res) {
            $this->_log('Zend_Cache_Backend_File::save() / error on saving metadata');
            return false;
        }
        $res = $this->_filePutContents($file, $data);
        return $res;
    }

setCacheDir()

setCacheDir	(		$value,
			$trailingSeparator = true
	)

Set the cache_dir (particular case of setOption() method)

Parameters

string	$value
boolean	$trailingSeparator	If true, add a trailing separator is necessary

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 174 of file File.php.

    {
        if (!is_dir($value)) {
            Zend_Cache::throwException(sprintf('cache_dir "%s" must be a directory', $value));
        }
        if (!is_writable($value)) {
            Zend_Cache::throwException(sprintf('cache_dir "%s" is not writable', $value));
        }
        if ($trailingSeparator) {
            // add a trailing DIRECTORY_SEPARATOR if necessary
            $value = rtrim(realpath($value), '\\/') . DIRECTORY_SEPARATOR;
        }
        $this->_options['cache_dir'] = $value;
    }

test()

test

(

$id

)

Test if a cache is available or not (for the given id)

Parameters

string

$id

cache id

Returns

mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Implements Zend_Cache_Backend_Interface.

Definition at line 224 of file File.php.

    {
        clearstatcache();
        return $this->_test($id, false);
    }

touch()

touch	(		$id,
			$extraLifetime
	)

Give (if possible) an extra lifetime to the given cache id

Parameters

string	$id	cache id
int	$extraLifetime

Returns

boolean true if ok

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 428 of file File.php.

    {
        $metadatas = $this->_getMetadatas($id);
        if (!$metadatas) {
            return false;
        }
        if (time() > $metadatas['expire']) {
            return false;
        }
        $newMetadatas = array(
            'hash' => $metadatas['hash'],
            'mtime' => time(),
            'expire' => $metadatas['expire'] + $extraLifetime,
            'tags' => $metadatas['tags']
        );
        $res = $this->_setMetadatas($id, $newMetadatas);
        if (!$res) {
            return false;
        }
        return true;
    }

Field Documentation

$_metadatasArray

$_metadatasArray = array()

protected

Definition at line 115 of file File.php.

$_options

$_options

protected

Initial value:

= array(
        'cache_dir' => null,
        'file_locking' => true,
        'read_control' => true,
        'read_control_type' => 'crc32',
        'hashed_directory_level' => 0,
        'hashed_directory_perm' => 0700,
        'file_name_prefix' => 'zend_cache',
        'cache_file_perm' => 0600,
        'metadatas_array_max_size' => 100
    )

Definition at line 98 of file File.php.

---

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

• vendor/magento/zendframework1/library/Zend/Cache/Backend/File.php