Cache/Frontend/File.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Cache
- Subpackage
- Zend_Cache_Frontend
- Version
- $Id$
\Zend_Cache_Frontend_File
Package: Zend_Cache\Zend_Cache_Frontend
Details
Throws
- Parent(s)
- \Zend_Cache_Core
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties
array $_masterFile_mtimes = nullMaster file mtimes
Array of int
Default valuenullDetails- Type
- array
array $_specificOptions = array('master_file' => null, 'master_files' => null, 'master_files_mode' => 'OR', 'ignore_missing_master_files' => false)Available options
====> (string) master_file :
- a complete path of the master file
- deprecated (see master_files)
====> (array) master_files :
- an array of complete path of master files
- this option has to be set !
====> (string) master_files_mode :
- Zend_Cache_Frontend_File::MODE_AND or Zend_Cache_Frontend_File::MODE_OR
- if MODE_AND, then all master files have to be touched to get a cache invalidation
- if MODE_OR (default), then a single touched master file is enough to get a cache invalidation
====> (boolean) ignore_missing_master_files
- if set to true, missing master files are ignored silently
- if set to false (default), an exception is thrown if there is a missing master file
Default valuearray('master_file' => null, 'master_files' => null, 'master_files_mode' => 'OR', 'ignore_missing_master_files' => false)Details- Type
- array
Methods
__construct(array $options = array()) : voidConstructor
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $options | array | Associative array of options |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
load(string $id, boolean $doNotTestCacheValidity = false, boolean $doNotUnserialize = false) : mixed | falseTest if a cache is available for the given id and (if yes) return it (false else)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $id | string | Cache id |
| $doNotTestCacheValidity | boolean | If set to true, the cache validity won't be tested |
| $doNotUnserialize | boolean | Do not serialize (even if automatic_serialization is true) => for internal use |
| Type | Description |
|---|---|
| mixed | false | Cached datas |
setMasterFile(string $masterFile) : voidChange the master_file option
To keep the compatibility
Parameters| Name | Type | Description |
|---|---|---|
| $masterFile | string | the complete path and name of the master file |
- Deprecated
setMasterFiles(array $masterFiles) : voidChange the master_files option
Parameters
| Name | Type | Description |
|---|---|---|
| $masterFiles | array | the complete paths and name of the master files |
setOption(string $name, mixed $value) : voidPublic frontend to set an option
Just a wrapper to get a specific behaviour for master_file
Parameters| Name | Type | Description |
|---|---|---|
| $name | string | Name of the option |
| $value | mixed | Value of the option |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
test(string $id) : int | falseTest if a cache is available for the given id
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $id | string | Cache id |
| Type | Description |
|---|---|
| int | false | Last modified time of cache entry if it is available, false otherwise |