API Documentation

Cache/Backend/Xcache.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cache  
subpackage
Zend_Cache_Backend  
version
$Id: Xcache.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Cache_Backend_Xcache

Extends from
\Zend_Cache_Backend
Implements
\Zend_Cache_Backend_Interface
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cache  
subpackage
Zend_Cache_Backend  

Constants

Constant  TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND = 'Zend_Cache_Backend_Xcache::clean() : tags are unsupported by the Xcache backend'

Log message

Constant  TAGS_UNSUPPORTED_BY_SAVE_OF_XCACHE_BACKEND = 'Zend_Cache_Backend_Xcache::save() : tags are unsupported by the Xcache backend'

Properties

Propertyprotectedarray  $_options= 'array'

Available options

available options

=====> (string) user : xcache.admin.user (necessary for the clean() method)

=====> (string) password : xcache.admin.pass (clear, not MD5) (necessary for the clean() method)

Default valuearrayDetails
Type
array

Methods

methodpublic__construct( array $options = array ) : void

Constructor

Parameters
Name Type Description
$options array associative array of options
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_isGoodTmpDir( string $dir ) : boolean

Verify if the given temporary directory is readable and writable

Inherited from: \Zend_Cache_Backend::_isGoodTmpDir()
Parameters
Name Type Description
$dir string temporary directory
Returns
Type Description
boolean true if the directory is ok
methodprotected_log( string $message,  $priority = 4 ) : void

Log a message at the WARN (4) priority.

Inherited from: \Zend_Cache_Backend::_log()
Parameters
Name Type Description
$message string
$priority
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_loggerSanity( ) : void

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
Exception Description
\Zend_Cache_Exception
methodpublicclean( string $mode = Zend_Cache, 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
methodpublicgetLifetime( int $specificLifetime ) : int

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
Name Type Description
$specificLifetime int
Returns
Type Description
int Cache life time
methodpublicgetTmpDir( ) : string

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
Type Description
string
Throws
Exception Description
\Zend_Cache_Exception if unable to determine directory
methodpublicisAutomaticCleaningAvailable( ) : boolean

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Returns
Type Description
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)

WARNING $doNotTestCacheValidity=true is unsupported by the Xcache backend

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
methodpublicsetDirectives( array $directives ) : void

Set the frontend directives

Inherited from: \Zend_Cache_Backend_Interface::setDirectives()
Parameters
Name Type Description
$directives array assoc of directives
Throws
Exception Description
\Zend_Cache_Exception
methodpublicsetOption( string $name, mixed $value ) : void

Set an option

Inherited from: \Zend_Cache_Backend::setOption()
Parameters
Name Type Description
$name string
$value mixed
Throws
Exception Description
\Zend_Cache_Exception
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
Documentation was generated by DocBlox 0.13.3.