Public Member Functions | Data Fields | Protected Attributes

Zend_Cache_Frontend_File Class Reference

Inheritance diagram for Zend_Cache_Frontend_File:
Zend_Cache_Core

Public Member Functions

 __construct (array $options=array())
 setMasterFiles ($masterFiles)
 setMasterFile ($masterFile)
 setOption ($name, $value)
 load ($id, $doNotTestCacheValidity=false, $doNotUnserialize=false)
 test ($id)

Data Fields

const MODE_AND = 'AND'
const MODE_OR = 'OR'

Protected Attributes

 $_specificOptions

Detailed Description

Definition at line 36 of file File.php.


Constructor & Destructor Documentation

__construct ( array $  options = array() )

Constructor

Parameters:
array$optionsAssociative array of options
Exceptions:
Zend_Cache_Exception
Returns:
void

Definition at line 89 of file File.php.


Member Function Documentation

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$idCache id
boolean$doNotTestCacheValidityIf set to true, the cache validity won't be tested
boolean$doNotUnserializeDo not serialize (even if automatic_serialization is true) => for internal use
Returns:
mixed|false Cached datas

Reimplemented from Zend_Cache_Core.

Definition at line 162 of file File.php.

setMasterFile ( masterFile )

Change the master_file option

To keep the compatibility

Deprecated:
Parameters:
string$masterFilethe complete path and name of the master file

Definition at line 128 of file File.php.

setMasterFiles ( masterFiles )

Change the master_file option

Parameters:
string$masterFilethe complete path and name of the master file

Definition at line 104 of file File.php.

setOption ( name,
value 
)

Public frontend to set an option

Just a wrapper to get a specific behaviour for master_file

Parameters:
string$nameName of the option
mixed$valueValue of the option
Exceptions:
Zend_Cache_Exception
Returns:
void

Reimplemented from Zend_Cache_Core.

Definition at line 143 of file File.php.

test ( id )

Test if a cache is available for the given id

Parameters:
string$idCache id
Returns:
int|false Last modified time of cache entry if it is available, false otherwise

Reimplemented from Zend_Cache_Core.

Definition at line 179 of file File.php.


Field Documentation

$_specificOptions [protected]
Initial value:
 array(
        'master_file' => null,
        'master_files' => null,
        'master_files_mode' => 'OR',
        'ignore_missing_master_files' => false
    )

Not used for the core, just a sort a hint to get a common setOption() method (for the core and for frontends)

Reimplemented from Zend_Cache_Core.

Definition at line 66 of file File.php.

const MODE_AND = 'AND'

Consts for master_files_mode

Definition at line 42 of file File.php.


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