Cache/Backend/ZendServer.php

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: ZendServer.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Cache_Backend_ZendServer

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_ZendServer
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
Properties: $_options
Methods: _store; _fetch; _unset; _clear; load; test; _expireTime; save; remove; clean

Description

Properties

$_options
jump to class

array $_options = 'array'

Available options

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

Details

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

Methods

_clear
jump to class

Clear cache

Details

visibility: protected
final: false
static: false

_expireTime
jump to class

_expireTime(
           $lifetime
          )
        
        :
        int

Compute & return the expire time

Arguments

$lifetime

Output

int: expire time (unix timestamp)

Details

visibility: private
final: false
static: false

_fetch
jump to class

_fetch(
          string $id
          )
        
        :

Fetch data

Arguments

$id: string
Cache id

Details

visibility: protected
final: false
static: false
throws

_store
jump to class

_store(
          mixed $data, string $id, int $timeToLive
          )
        
        :

Store data

Arguments

$data: mixed
Object to store
$id: string
Cache id
$timeToLive: int
Time to live in seconds

Details

visibility: protected
final: false
static: false
throws

_unset
jump to class

_unset(
          string $id
          )
        
        :

Unset data

Arguments

$id: string
Cache id

Details

visibility: protected
final: false
static: false

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

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)

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
throws

API Documentation

Cache/Backend/ZendServer.php

Description

Zend_Cache_Backend_ZendServerjump to top

Description

Properties

$_optionsjump to class

Details

Methods

_clearjump to class

Details

_expireTimejump to class

Arguments

Output

Details

_fetchjump to class

Arguments

Details

_storejump to class

Arguments

Details

_unsetjump to class

Arguments

Details

cleanjump to class

Arguments

Output

Details

loadjump to class

Arguments

Output

Details

removejump to class

Arguments

Output

Details

savejump to class

Arguments

Output

Details

testjump to class

Arguments

Output

Details

Zend_Cache_Backend_ZendServer
jump to top

$_options
jump to class

_clear
jump to class

_expireTime
jump to class

_fetch
jump to class

_store
jump to class

_unset
jump to class

clean
jump to class

load
jump to class

remove
jump to class

save
jump to class

test
jump to class