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

\Zend_Cache_Backend_ZendPlatform

Package: Zend\Cache\Zend\Cache\Backend
Impementation of Zend Cache Backend using the Zend Platform (Output Content Caching)
Implements
\Zend_Cache_Backend_Interface
Parent(s)
\Zend_Cache_Backend
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  TAGS_PREFIX = "internal_ZPtag:"
internal ZP prefix

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()
inherited
Available options
Inherited from: \Zend_Cache_Backend::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Cache_Backend::$$_options  

Methods

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

Constructor Validate that the Zend Platform is loaded and licensed

Parameters
NameTypeDescription
$optionsarray

Associative array of options

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprivate_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)

Parameters
NameTypeDescription
$dirstring

Path of directory ot clean

$modestring

The same parameter as in Zend_Cache_Backend_ZendPlatform::clean()

Returns
TypeDescription
booleanTrue if ok
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
methodprivate_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

Parameters
NameTypeDescription
$filestring

Complete file path

Returns
TypeDescription
booleanTrue if ok
methodpublicclean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, 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)

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 data (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

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

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

Parameters
NameTypeDescription
$idstring

Cache id

Returns
TypeDescription
mixed | falsefalse (a cache is not available) or "last modified" timestamp (int) of the available cache record
Documentation was generated by phpDocumentor 2.0.0a12.