API Documentation

Zend/Cache/Backend/ZendServer.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: ZendServer.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Cache_Backend_ZendServer

Package: Zend\Cache\Zend\Cache\Backend

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

Properties

Propertyprotectedarray  $_options= 'array( 'namespace' => 'zendframework' )'

Available options

available options

=====> (string) namespace : Namespace to be used for chaching operations

Default valuearray( 'namespace' => 'zendframework' )Details
Type
array

Methods

methodprotected_clear( ) : void
abstract

Clear cache

methodprivate_expireTime(  $lifetime ) : int

Compute & return the expire time

Parameters
Name Type Description
$lifetime
Returns
Type Description
int expire time (unix timestamp)
methodprotected_fetch( string $id ) : void
abstract

Fetch data

Parameters
Name Type Description
$id string

Cache id

Throws
Exception Description
\Zend_Cache_Exception
methodprotected_store( mixed $data, string $id, int $timeToLive ) : void
abstract

Store data

Parameters
Name Type Description
$data mixed

Object to store

$id string

Cache id

$timeToLive int

Time to live in seconds

Throws
Exception Description
\Zend_Cache_Exception
methodprotected_unset( string $id ) : void
abstract

Unset data

Parameters
Name Type Description
$id string

Cache id

methodpublicclean( string $mode = Zend_Cache::CLEANING_MODE_ALL, array $tags = array() ) : boolean

Clean some cache records

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => unsupported 'matchingTag' => unsupported 'notMatchingTag' => unsupported 'matchingAnyTag' => unsupported

Parameters
Name Type Description
$mode string

clean mode

$tags array

array of tags

Returns
Type Description
boolean true if no problem
Throws
Exception Description
\Zend_Cache_Exception
methodpublicload( string $id, boolean $doNotTestCacheValidity = false ) : string

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

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 cached datas (or false)
methodpublicremove( string $id ) : boolean

Remove a cache record

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
methodpublictest( string $id ) : mixed

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

Parameters
Name Type Description
$id string

cache id

Returns
Type Description
mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record
Throws
Exception Description
\Zend_Cache_Exception
Documentation was generated by DocBlox 0.15.1.