Zend_Cache_Frontend_File Class Reference

Inheritance diagram for Zend_Cache_Frontend_File:

Public Member Functions
	__construct (array $options=array())
	setMasterFiles (array $masterFiles)
	setMasterFile ($masterFile)
	setOption ($name, $value)
	load ($id, $doNotTestCacheValidity=false, $doNotUnserialize=false)
	test ($id)
Public Member Functions inherited from Zend_Cache_Core
	__construct ($options=array())
	setConfig (Zend_Config $config)
	setBackend (Zend_Cache_Backend $backendObject)
	getBackend ()
	setOption ($name, $value)
	getOption ($name)
	setLifetime ($newLifetime)
	load ($id, $doNotTestCacheValidity=false, $doNotUnserialize=false)
	test ($id)
	save ($data, $id=null, $tags=array(), $specificLifetime=false, $priority=8)
	remove ($id)
	clean ($mode='all', $tags=array())
	getIdsMatchingTags ($tags=array())
	getIdsNotMatchingTags ($tags=array())
	getIdsMatchingAnyTags ($tags=array())
	getIds ()
	getTags ()
	getFillingPercentage ()
	getMetadatas ($id)
	touch ($id, $extraLifetime)

Data Fields
const	MODE_AND = 'AND'
const	MODE_OR = 'OR'
Data Fields inherited from Zend_Cache_Core
const	BACKEND_NOT_SUPPORTS_TAG = 'tags are not supported by the current backend'
const	BACKEND_NOT_IMPLEMENTS_EXTENDED_IF = 'Current backend doesn\'t implement the Zend_Cache_Backend_ExtendedInterface, so this method is not available'

Protected Attributes
	$_specificOptions
Protected Attributes inherited from Zend_Cache_Core
	$_backend = null
	$_options
	$_specificOptions = array()
	$_extendedBackend = false
	$_backendCapabilities = array()

Additional Inherited Members
Protected Member Functions inherited from Zend_Cache_Core
	_validateIdOrTag ($string)
	_validateTagsArray ($tags)
	_loggerSanity ()
	_log ($message, $priority=4)
	_id ($id)
Static Protected Attributes inherited from Zend_Cache_Core
static	$_directivesList = array('lifetime', 'logging', 'logger')

Detailed Description

Definition at line 36 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

Associative array of options

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 89 of file File.php.

    {
        foreach ($options as $name => $value) {
            $this->setOption($name, $value);
        }
        if (!isset($this->_specificOptions['master_files'])) {
            Zend_Cache::throwException('master_files option must be set');
        }
    }

Member Function Documentation

load()

load	(		$id,
			$doNotTestCacheValidity = false,
			$doNotUnserialize = 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
boolean	$doNotUnserialize	Do not serialize (even if automatic_serialization is true) => for internal use

Returns

mixed|false Cached datas

Definition at line 175 of file File.php.

    {
        if (!$doNotTestCacheValidity) {
            if ($this->test($id)) {
                return parent::load($id, true, $doNotUnserialize);
            }
            return false;
        }
        return parent::load($id, true, $doNotUnserialize);
    }

setMasterFile()

setMasterFile

(

$masterFile

)

Change the master_file option

To keep the compatibility

Deprecated:

Parameters

string

$masterFile

the complete path and name of the master file

Definition at line 141 of file File.php.

    {
          $this->setMasterFiles(array($masterFile));
    }

setMasterFiles()

setMasterFiles

(

array

$masterFiles

)

Change the master_files option

Parameters

array

$masterFiles

the complete paths and name of the master files

Definition at line 104 of file File.php.

    {
        $this->_specificOptions['master_file']  = null; // to keep a compatibility
        $this->_specificOptions['master_files'] = null;
        $this->_masterFile_mtimes = array();

        clearstatcache();
        $i = 0;
        foreach ($masterFiles as $masterFile) {
            if (file_exists($masterFile)) {
                $mtime = filemtime($masterFile);
            } else {
                $mtime = false;
            }

            if (!$this->_specificOptions['ignore_missing_master_files'] && !$mtime) {
                Zend_Cache::throwException('Unable to read master_file : ' . $masterFile);
            }

            $this->_masterFile_mtimes[$i] = $mtime;
            $this->_specificOptions['master_files'][$i] = $masterFile;
            if ($i === 0) { // to keep a compatibility
                $this->_specificOptions['master_file'] = $masterFile;
            }

            $i++;
        }
    }

setOption()

setOption	(		$name,
			$value
	)

Public frontend to set an option

Just a wrapper to get a specific behaviour for master_file

Parameters

string	$name	Name of the option
mixed	$value	Value of the option

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 156 of file File.php.

    {
        if ($name == 'master_file') {
            $this->setMasterFile($value);
        } else if ($name == 'master_files') {
            $this->setMasterFiles($value);
        } else {
            parent::setOption($name, $value);
        }
    }

test()

test

(

$id

)

Test if a cache is available for the given id

Parameters

string

$id

Cache id

Returns

int|false Last modified time of cache entry if it is available, false otherwise

Definition at line 192 of file File.php.

    {
        $lastModified = parent::test($id);
        if ($lastModified) {
            if ($this->_specificOptions['master_files_mode'] == self::MODE_AND) {
                // MODE_AND
                foreach($this->_masterFile_mtimes as $masterFileMTime) {
                    if ($masterFileMTime) {
                        if ($lastModified > $masterFileMTime) {
                            return $lastModified;
                        }
                    }
                }
            } else {
                // MODE_OR
                $res = true;
                foreach($this->_masterFile_mtimes as $masterFileMTime) {
                    if ($masterFileMTime) {
                        if ($lastModified <= $masterFileMTime) {
                            return false;
                        }
                    }
                }
                return $lastModified;
            }
        }
        return false;
    }

Field Documentation

$_specificOptions

$_specificOptions

protected

Initial value:

= array(
        'master_file' => null,
        'master_files' => null,
        'master_files_mode' => 'OR',
        'ignore_missing_master_files' => false
    )

Definition at line 66 of file File.php.

MODE_AND

const MODE_AND = 'AND'

Consts for master_files_mode

Definition at line 42 of file File.php.

MODE_OR

const MODE_OR = 'OR'

Definition at line 43 of file File.php.

---

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

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