Cache/Backend/ZendServer/ShMem.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: ShMem.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Cache_Backend_ZendServer_ShMem

Package: Zend\Cache\Zend\Cache\Backend
Implements
\Zend_Cache_Backend_Interface
Parent(s)
\Zend_Cache_Backend_ZendServer < \Zend_Cache_Backend
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)

=====> (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  
Inherited_from
\Zend_Cache_Backend_ZendServer::$$_directives  
>VPropertyprotectedarray $_options = array('namespace' => 'zendframework')
inherited
Available options
Inherited from: \Zend_Cache_Backend_ZendServer::$$_options

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

Default valuearray('namespace' => 'zendframework')Details
Type
array
Inherited_from
\Zend_Cache_Backend_ZendServer::$$_options  

Methods

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

Constructor

Parameters
NameTypeDescription
$optionsarray

associative array of options

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_clear() : void

Clear cache

methodprivate_expireTime( $lifetime) : int
inherited

Compute & return the expire time

Inherited from: \Zend_Cache_Backend_ZendServer::_expireTime()
Parameters
NameTypeDescription
$lifetime
Returns
TypeDescription
intexpire time (unix timestamp)
methodprotected_fetch(string $id) : void

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()\Zend_Cache_Backend_ZendServer::_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()\Zend_Cache_Backend_ZendServer::_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()\Zend_Cache_Backend_ZendServer::_loggerSanity()

Create a default log object if none is set.

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

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) : boolean

Unset data

Parameters
NameTypeDescription
$idstring

Cache id

Returns
TypeDescription
booleantrue if no problem
methodpublicclean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = array()) : boolean
inherited

Clean some cache records

Inherited from: \Zend_Cache_Backend_Interface::clean()

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

Clean mode

$tagsarray

Array of tags

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

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
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()\Zend_Cache_Backend_ZendServer::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()\Zend_Cache_Backend_ZendServer::isAutomaticCleaningAvailable()

DEPRECATED : use getCapabilities() instead

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

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

Inherited from: \Zend_Cache_Backend_Interface::load()

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
string | falsecached datas
methodpublicremove(string $id) : boolean
inherited

Remove a cache record

Inherited from: \Zend_Cache_Backend_Interface::remove()
Parameters
NameTypeDescription
$idstring

Cache id

Returns
TypeDescription
booleanTrue if no problem
methodpublicsave(string $data, string $id, array $tags = array(), int $specificLifetime = false) : boolean
inherited

Save some string datas into a cache record

Inherited from: \Zend_Cache_Backend_Interface::save()

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
Parameters
NameTypeDescription
$namestring
$valuemixed
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublictest(string $id) : mixed | false
inherited

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

Inherited from: \Zend_Cache_Backend_Interface::test()
Parameters
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
mixed | false(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.