Cache/Backend/ZendServer.php

Show: PublicProtectedPrivateinherited
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 24593 2012-01-05 20:35:02Z 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

>VPropertyprotectedarray $_directives = array('lifetime' => 3600, 'logging' => false, 'logger' => null)
inherited
Frontend or Core directives
Inherited from: \Zend_Cache_Backend::$$_directives

=====> (int) lifetime : - Cache lifetime (in seconds) - If null, the cache is valid forever

=====> (int) logging : - if set to true, a logging is activated throw Zend_Log

Default valuearray('lifetime' => 3600, 'logging' => false, 'logger' => null)Details
Type
array
Inherited_from
\Zend_Cache_Backend::$$_directives  
>VPropertyprotectedarray $_options = array('namespace' => 'zendframework')
Available options

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

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

Methods

methodpublic__construct(array $options = array()) : void
inherited

Constructor

Inherited from: \Zend_Cache_Backend::__construct()
Parameters
NameTypeDescription
$optionsarray

Associative array of options

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_clear() : void
abstract

Clear cache

methodprivate_expireTime( $lifetime) : int

Compute & return the expire time

Parameters
NameTypeDescription
$lifetime
Returns
TypeDescription
intexpire time (unix timestamp)
methodprotected_fetch(string $id) : void
abstract

Fetch data

Parameters
NameTypeDescription
$idstring

Cache id

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_isGoodTmpDir(string $dir) : boolean
inherited

Verify if the given temporary directory is readable and writable

Inherited from: \Zend_Cache_Backend::_isGoodTmpDir()
Parameters
NameTypeDescription
$dirstring

temporary directory

Returns
TypeDescription
booleantrue if the directory is ok
methodprotected_log(string $message,  $priority = 4) : void
inherited

Log a message at the WARN (4) priority.

Inherited from: \Zend_Cache_Backend::_log()
Parameters
NameTypeDescription
$messagestring
$priority
Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_loggerSanity() : void
inherited

Make sure if we enable logging that the Zend_Log class is available.

Inherited from: \Zend_Cache_Backend::_loggerSanity()

Create a default log object if none is set.

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

Store data

Parameters
NameTypeDescription
$datamixed

Object to store

$idstring

Cache id

$timeToLiveint

Time to live in seconds

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

Unset data

Parameters
NameTypeDescription
$idstring

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
NameTypeDescription
$modestring

clean mode

$tagsarray

array of tags

Returns
TypeDescription
booleantrue if no problem
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicgetLifetime(int $specificLifetime) : int
inherited

Get the life time

Inherited from: \Zend_Cache_Backend::getLifetime()

if $specificLifetime is not false, the given specific life time is used else, the global lifetime is used

Parameters
NameTypeDescription
$specificLifetimeint
Returns
TypeDescription
intCache life time
methodpublicgetOption(string $name) : mixed
inherited

Returns an option

Inherited from: \Zend_Cache_Backend::getOption()
Parameters
NameTypeDescription
$namestring

Optional, the options name to return

Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Cache_Exceptions
methodpublicgetTmpDir() : string
inherited

Determine system TMP directory and detect if we have read access

Inherited from: \Zend_Cache_Backend::getTmpDir()

inspired from Zend_File_Transfer_Adapter_Abstract

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Cache_Exceptionif unable to determine directory
methodpublicisAutomaticCleaningAvailable() : boolean
inherited

Return true if the automatic cleaning is available for the backend

Inherited from: \Zend_Cache_Backend::isAutomaticCleaningAvailable()

DEPRECATED : use getCapabilities() instead

Returns
TypeDescription
boolean
methodpublicload(string $id, boolean $doNotTestCacheValidity = false) : string

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
NameTypeDescription
$idstring

cache id

$doNotTestCacheValidityboolean

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

Returns
TypeDescription
stringcached datas (or false)
methodpublicremove(string $id) : boolean

Remove a cache record

Parameters
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
booleantrue 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
NameTypeDescription
$datastring

datas to cache

$idstring

cache id

$tagsarray

array of strings, the cache record will be tagged by each string entry

$specificLifetimeint

if != false, set a specific lifetime for this cache record (null => infinite lifetime)

Returns
TypeDescription
booleantrue if no problem
methodpublicsetDirectives(array $directives) : void
inherited

Set the frontend directives

Inherited from: \Zend_Cache_Backend_Interface::setDirectives()
Parameters
NameTypeDescription
$directivesarray

assoc of directives

Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicsetOption(string $name, mixed $value) : void
inherited

Set an option

Inherited from: \Zend_Cache_Backend::setOption()
Parameters
NameTypeDescription
$namestring
$valuemixed
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublictest(string $id) : mixed

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

Parameters
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
mixedfalse (a cache is not available) or "last modified" timestamp (int) of the available cache record
Throws
ExceptionDescription
\Zend_Cache_Exception
Documentation was generated by phpDocumentor 2.0.0a12.