Cache/Backend/Static.php
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_Backend
- Version
- $Id$
\Zend_Cache_Backend_Static
Package: Zend_Cache\Zend_Cache_Backend- Implements
- Parent(s)
- \Zend_Cache_Backend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants


INNER_CACHE_NAME
= 'zend_cache_backend_static_tagcache'
Properties



array $_options = array('public_dir' => null, 'sub_dir' => 'html', 'file_extension' => '.html', 'index_filename' => 'index', 'file_locking' => true, 'cache_file_perm' => 384, 'cache_directory_perm' => 448, 'debug_header' => false, 'tag_cache' => null, 'disable_caching' => false)
Default valuearray('public_dir' => null, 'sub_dir' => 'html', 'file_extension' => '.html', 'index_filename' => 'index', 'file_locking' => true, 'cache_file_perm' => 384, 'cache_directory_perm' => 448, 'debug_header' => false, 'tag_cache' => null, 'disable_caching' => false)
Details- Type
- array
Methods



_decodeId(string $id) : string
Decode a request URI from the provided ID
ParametersName | Type | Description |
---|
$id | string | |
---|
Returns 


_isSerialized( $data) : void
Detect serialization of data (cannot predict since this is the only way
to obey the interface yet pass in another parameter).
In future, ZF 2.0, check if we can just avoid the interface restraints.
This format is the only valid one possible for the class, so it's simple
to just run a regular expression for the starting serialized format.
Parameters


_octdec(string $val) : int
Detect an octal string and return its octal value for file permission ops
otherwise return the non-string (assumed octal or decimal int already)
ParametersName | Type | Description |
---|
$val | string | The potential octal in need of conversion |
---|
Returns 


_validateIdOrTag(string $string) : void
staticValidate a cache id or a tag (security, reliable filenames, reserved prefixes.
..)
Throw an exception if a problem is found
ParametersName | Type | Description |
---|
$string | string | Cache id or tag |
---|
ThrowsDetails- Deprecated
- Not usable until perhaps ZF 2.0



_verifyPath(string $path) : bool
Verify path exists and is non-empty
ParametersName | Type | Description |
---|
$path | string | |
---|
Returns 


clean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = array()) : boolean
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)
ParametersName | Type | Description |
---|
$mode | string | Clean mode |
---|
$tags | array | Array of tags |
---|
ReturnsType | Description |
---|
boolean | true if no problem |



getOption(string $name) : mixed
Retrieve any option via interception of the parent's statically held
options including the local option for a tag cache.
ParametersName | Type | Description |
---|
$name | string | |
---|
Returns 


load(string $id, boolean $doNotTestCacheValidity = false) : string | false
Test if a cache is available for the given id and (if yes) return it (false else)
Note : return value is always "string" (unserialization is done by the core not by the backend)
ParametersName | Type | Description |
---|
$id | string | Cache id |
---|
$doNotTestCacheValidity | boolean | If set to true, the cache validity won't be tested |
---|
ReturnsType | Description |
---|
string | false | cached datas |



remove(string $id) : boolean
ParametersName | Type | Description |
---|
$id | string | Cache id |
---|
ReturnsType | Description |
---|
boolean | True if no problem |



removeRecursively(string $id) : boolean
Remove a cache record recursively for the given directory matching a
REQUEST_URI based relative path (deletes the actual file matching this
in addition to the matching directory)
ParametersName | Type | Description |
---|
$id | string | Cache id |
---|
ReturnsType | Description |
---|
boolean | True if no problem |



save(string $data, string $id, array $tags = array(), int $specificLifetime = false) : boolean
Save some string datas into a cache record
Note : $data is always "string" (serialization is done by the
core not by the backend)
ParametersName | Type | Description |
---|
$data | string | Datas to cache |
---|
$id | string | Cache id |
---|
$tags | array | Array of strings, the cache record will be tagged by each string entry |
---|
$specificLifetime | int | If != false, set a specific lifetime for this cache record (null => infinite lifetime) |
---|
ReturnsType | Description |
---|
boolean | true if no problem |



setInnerCache( $cache) : void
Set an Inner Cache, used here primarily to store Tags associated
with caches created by this backend. Note: If Tags are lost, the cache
should be completely cleaned as the mapping of tags to caches will
have been irrevocably lost.
ParametersName | Type | Description |
---|
$cache | | |
---|



setOption(string $name, mixed $value) : \Zend_Cache_Backend_Static
Interceptor child method to handle the case where an Inner
Cache object is being set since it's not supported by the
standard backend interface
ParametersName | Type | Description |
---|
$name | string | |
---|
$value | mixed | |
---|
Returns 


test(string $id) : bool
Test if a cache is available or not (for the given id)
ParametersName | Type | Description |
---|
$id | string | cache id |
---|
Returns