Cache/Backend/ZendPlatform.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: ZendPlatform.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Cache_Backend_ZendPlatform

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_ZendPlatform
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: TAGS_PREFIX
Methods: __construct; load; test; save; remove; clean; _clean; _remove

Description

Impementation of Zend Cache Backend using the Zend Platform (Output Content Caching)

Constants

TAGS_PREFIX
jump to class

 TAGS_PREFIX = 'internal_ZPtag:'

internal ZP prefix

Details

value: internal_ZPtag:

Methods

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :
        void

Constructor Validate that the Zend Platform is loaded and licensed

Arguments

$options: array
Associative array of options

Details

visibility: public
final: false
static: false
throws

_clean
jump to class

_clean(
          string $dir, string $mode
          )
        
        :
        boolean

Clean a directory and recursivly go over it's subdirectories

Remove all the cached files that need to be cleaned (according to mode and files mtime)

Arguments

$dir: string
Path of directory ot clean
$mode: string
The same parameter as in Zend_Cache_Backend_ZendPlatform::clean()

Output

boolean: True if ok

Details

visibility: private
final: false
static: false

_remove
jump to class

_remove(
          string $file
          )
        
        :
        boolean

Remove a file

If we can't remove the file (because of locks or any problem), we will touch the file to invalidate it

Arguments

$file: string
Complete file path

Output

boolean: True if ok

Details

visibility: private
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) This mode is not supported in this backend 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 => unsupported 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
throws

load
jump to class

load(
          string $id, boolean $doNotTestCacheValidity
              =
              false
          )
        
        :
        string

Test if a cache is available for the given id and (if yes) return it (false else)

Arguments

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

Output

string: Cached data (or false)

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

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
Data 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

test
jump to class

test(
          string $id
          )
        
        :
        mixed|false

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

Arguments

$id: string
Cache id

Output

mixed|false: false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Details

visibility: public
final: false
static: false

API Documentation

Cache/Backend/ZendPlatform.php

Description

Zend_Cache_Backend_ZendPlatformjump to top

Description

Constants

TAGS_PREFIXjump to class

Details

Methods

__constructjump to class

Arguments

Details

_cleanjump to class

Arguments

Output

Details

_removejump to class

Arguments

Output

Details

cleanjump to class

Arguments

Output

Details

loadjump to class

Arguments

Output

Details

removejump to class

Arguments

Output

Details

savejump to class

Arguments

Output

Details

testjump to class

Arguments

Output

Details

Zend_Cache_Backend_ZendPlatform
jump to top

TAGS_PREFIX
jump to class

__construct
jump to class

_clean
jump to class

_remove
jump to class

clean
jump to class

load
jump to class

remove
jump to class

save
jump to class

test
jump to class