API Documentation

Zend/Cache/Backend/Static.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cache  
Subpackage
Zend_Cache_Backend  
Version
$Id: Static.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Cache_Backend_Static

Package: Zend\Cache\Zend\Cache\Backend

Implements
\Zend_Cache_Backend_Interface
Parent(s)
\Zend_Cache_Backend
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  INNER_CACHE_NAME = 'zend_cache_backend_static_tagcache'

Properties

Propertyprotectedarray  $_options= 'array( 'public_dir' => null'

Static backend options

Default valuearray( 'public_dir' => nullDetails
Type
array
Propertyprotected\Zend_Cache_Core  $_tagCache= 'null'

Cache for handling tags

Default valuenullDetails
Type
\Zend_Cache_Core
Propertyprotectedarray  $_tagged= 'null'

Tagged items

Default valuenullDetails
Type
array

Methods

methodprotected_createDirectoriesFor(  $path ) : void

Recursively create the directories needed to write the static file

Parameters
Name Type Description
$path
methodprotected_decodeId( string $id ) : string

Decode a request URI from the provided ID

Parameters
Name Type Description
$id string
Returns
Type Description
string
methodprotected_detectId( ) : string

Determine the page to save from the request

Returns
Type Description
string
methodprotected_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
Name Type Description
$data
methodprotected_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)

Parameters
Name Type Description
$val string

The potential octal in need of conversion

Returns
Type Description
int
methodprotected_validateIdOrTag( string $string ) : void
static

Validate a cache id or a tag (security, reliable filenames, reserved prefixes...)

Throw an exception if a problem is found

Parameters
Name Type Description
$string string

Cache id or tag

Throws
Exception Description
\Zend_Cache_Exception
Details
Deprecated
Not usable until perhaps ZF 2.0  
methodprotected_verifyPath( string $path ) : bool

Verify path exists and is non-empty

Parameters
Name Type Description
$path string
Returns
Type Description
bool
methodpublicclean( string $mode = Zend_Cache::CLEANING_MODE_ALL, array $tags = array() ) : boolean

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
Name Type Description
$mode string

Clean mode

$tags array

Array of tags

Returns
Type Description
boolean true if no problem
methodpublicgetInnerCache( ) : \Zend_Cache_Core

Get the Inner Cache if set

Returns
Type Description
\Zend_Cache_Core
methodpublicgetOption( string $name ) : mixed

Retrieve any option via interception of the parent's statically held options including the local option for a tag cache.

Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublicload( 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)

Parameters
Name Type Description
$id string

Cache id

$doNotTestCacheValidity boolean

If set to true, the cache validity won't be tested

Returns
Type Description
string|false cached datas
methodpublicremove( string $id ) : boolean

Remove a cache record

Parameters
Name Type Description
$id string

Cache id

Returns
Type Description
boolean True if no problem
methodpublicremoveRecursively( 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)

Parameters
Name Type Description
$id string

Cache id

Returns
Type Description
boolean True if no problem
methodpublicsave( 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)

Parameters
Name 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)

Returns
Type Description
boolean true if no problem
methodpublicsetInnerCache(  $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.

Parameters
Name Type Description
$cache

Zend_Cache_Core

methodpublicsetOption( 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

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Cache_Backend_Static
methodpublictest( string $id ) : bool

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

Parameters
Name Type Description
$id string

cache id

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.