API Documentation

Cache/Backend/Xcache.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Cache
subpackage
Zend_Cache_Backend
version
$Id: Xcache.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Cache_Backend_Xcache

Description

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.

Zend_Cache_Backend_Xcache
jump to top

Extends from
Zend_Cache_Backend
Implements
Zend_Cache_Backend_Interface
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Cache
subpackage
Zend_Cache_Backend
Constants
TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND
TAGS_UNSUPPORTED_BY_SAVE_OF_XCACHE_BACKEND
Properties
$_options
Methods
__construct
load
test
save
remove
clean
isAutomaticCleaningAvailable

Description

Constants

TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND
jump to class

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

Log message

Details

value
Zend_Cache_Backend_Xcache::clean() : tags are unsupported by the Xcache backend

TAGS_UNSUPPORTED_BY_SAVE_OF_XCACHE_BACKEND
jump to class

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

Details

value
Zend_Cache_Backend_Xcache::save() : tags are unsupported by the Xcache backend

Properties

$_options
jump to class

array $_options = 'array'

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)

Details

$_options
array
available options
visibility
protected
default
array
final
false
static
false

Methods

__construct
jump to class

__construct( array $options = array ) : void

Constructor

Arguments
$options
array
associative array of options
Details
visibility
public
final
false
static
false
throws

clean
jump to class

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

Arguments
$mode
string
clean mode
$tags
array
array of tags
Output
boolean
true if no problem
Details
visibility
public
final
false
static
false
throws

isAutomaticCleaningAvailable
jump to class

isAutomaticCleaningAvailable( ) : boolean

Return true if the automatic cleaning is available for the backend

Output
boolean
Details
visibility
public
final
false
static
false

load
jump to class

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

Arguments
$id
string
cache id
$doNotTestCacheValidity
boolean
if set to true, the cache validity won't be tested
Output
string
cached datas (or false)
Details
visibility
public
final
false
static
false

remove
jump to class

remove( string $id ) : boolean

Remove a cache record

Arguments
$id
string
cache id
Output
boolean
true if no problem
Details
visibility
public
final
false
static
false

save
jump to class

save( 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)

Arguments
$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)
Output
boolean
true if no problem
Details
visibility
public
final
false
static
false

test
jump to class

test( string $id ) : mixed

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

Arguments
$id
string
cache id
Output
mixed
false (a cache is not available) or "last modified" timestamp (int) of the available cache record
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.