Cache/Backend/Static.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Backend
version: $Id: BlackHole.php 17867 2009-08-28 09:42:11Z yoshida@zend.co.jp $
Classes: Zend_Cache_Backend_Static

Description

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.

Zend_Cache_Backend_Static
jump to top

Extends from: Zend_Cache_Backend
Implements: Zend_Cache_Backend_Interface
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Backend
Constants: INNER_CACHE_NAME
Properties: $_options; $_tagCache; $_tagged
Methods: setOption; getOption; load; test; save; _createDirectoriesFor; _isSerialized; remove; removeRecursively; clean; setInnerCache; getInnerCache; _verifyPath; _detectId; _validateIdOrTag; _octdec; _decodeId

Description

Constants

INNER_CACHE_NAME
jump to class

 INNER_CACHE_NAME = 'zend_cache_backend_static_tagcache'

Details

value: zend_cache_backend_static_tagcache

Properties

$_options
jump to class

array $_options = 'array'

Static backend options

Details

$_options: array
visibility: protected
default: array
final: false
static: false

$_tagCache
jump to class

Zend_Cache_Core $_tagCache = 'null'

Cache for handling tags

Details

$_tagCache: Zend_Cache_Core
visibility: protected
default: null
final: false
static: false

$_tagged
jump to class

array $_tagged = 'null'

Tagged items

Details

$_tagged: array
visibility: protected
default: null
final: false
static: false

Methods

_createDirectoriesFor
jump to class

_createDirectoriesFor(
           $path
          )
        
        :

Recursively create the directories needed to write the static file

Arguments

$path

Details

visibility: protected
final: false
static: false

_decodeId
jump to class

_decodeId(
           $id
          )
        
        :

Decode a request URI from the provided ID

Arguments

$id

Details

visibility: protected
final: false
static: false

_detectId
jump to class

_detectId(
          
          )
        
        :
        string

Determine the page to save from the request

Output

string

Details

visibility: protected
final: false
static: false

_isSerialized
jump to class

_isSerialized(
           $data
          )
        
        :

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.

Arguments

$data

Details

visibility: protected
final: false
static: false

_octdec
jump to class

_octdec(
          $val $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)

Arguments

$val: $val
The potential octal in need of conversion

Output

int

Details

visibility: protected
final: false
static: false

_validateIdOrTag
jump to class

_validateIdOrTag(
          string $string
          )
        
        :
        void

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

Throw an exception if a problem is found

Arguments

$string: string
Cache id or tag

Details

visibility: protected
final: false
static: true
deprecated: Not usable until perhaps ZF 2.0
throws

_verifyPath
jump to class

_verifyPath(
          string $path
          )
        
        :
        bool

Verify path exists and is non-empty

Arguments

$path: string

Output

bool

Details

visibility: protected
final: false
static: false

clean
jump to class

clean(
          string $mode
              =
              Zend_Cache, 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)

Arguments

$mode: string
Clean mode
$tags: array
Array of tags

Output

boolean: true if no problem

Details

visibility: public
final: false
static: false

getInnerCache
jump to class

getInnerCache(
          
          )
        
        :
        Zend_Cache_Core

Get the Inner Cache if set

Output

Zend_Cache_Core

Details

visibility: public
final: false
static: false

getOption
jump to class

getOption(
          string $name
          )
        
        :
        mixed

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

Arguments

$name: string

Output

mixed

Details

visibility: public
final: false
static: false

load
jump to class

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)

Arguments

$id: string
Cache id
$doNotTestCacheValidity: boolean
If set to true, the cache validity won't be tested

Output

string|false: cached datas

Details

visibility: public
final: false
static: false

remove
jump to class

remove(
          string $id
          )
        
        :
        boolean

Remove a cache record

Arguments

$id: string
Cache id

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

removeRecursively
jump to class

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)

Arguments

$id: string
Cache id

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

save
jump to class

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)

Arguments

$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)

Output

boolean: true if no problem

Details

visibility: public
final: false
static: false

setInnerCache
jump to class

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.

Arguments

$cache: Zend_Cache_Core

Details

visibility: public
final: false
static: false

setOption
jump to class

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

Arguments

$name: string
$value: mixed

Output

Zend_Cache_Backend_Static

Details

visibility: public
final: false
static: false

test
jump to class

test(
          string $id
          )
        
        :
        bool

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

Arguments

$id: string
cache id

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Cache/Backend/Static.php

Description

Zend_Cache_Backend_Staticjump to top

Description

Constants

INNER_CACHE_NAMEjump to class

Details

Properties

$_optionsjump to class

Details

$_tagCachejump to class

Details

$_taggedjump to class

Details

Methods

_createDirectoriesForjump to class

Arguments

Details

_decodeIdjump to class

Arguments

Details

_detectIdjump to class

Output

Details

_isSerializedjump to class

Arguments

Details

_octdecjump to class

Arguments

Output

Details

_validateIdOrTagjump to class

Arguments

Details

_verifyPathjump to class

Arguments

Output

Details

cleanjump to class

Arguments

Output

Details

getInnerCachejump to class

Output

Details

getOptionjump to class

Arguments

Output

Details

loadjump to class

Arguments

Output

Details

removejump to class

Arguments

Output

Details

removeRecursivelyjump to class

Arguments

Output

Details

savejump to class

Arguments

Output

Details

setInnerCachejump to class

Arguments

Details

setOptionjump to class

Arguments

Output

Details

testjump to class

Arguments

Output

Details

Zend_Cache_Backend_Static
jump to top

INNER_CACHE_NAME
jump to class

$_options
jump to class

$_tagCache
jump to class

$_tagged
jump to class

_createDirectoriesFor
jump to class

_decodeId
jump to class

_detectId
jump to class

_isSerialized
jump to class

_octdec
jump to class

_validateIdOrTag
jump to class

_verifyPath
jump to class

clean
jump to class

getInnerCache
jump to class

getOption
jump to class

load
jump to class

remove
jump to class

removeRecursively
jump to class

save
jump to class

setInnerCache
jump to class

setOption
jump to class

test
jump to class