API Documentation

Zend/Cache/Backend/ZendPlatform.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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

Constant  TAGS_PREFIX = "internal_ZPtag:"

internal ZP prefix

Methods

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

Constructor Validate that the Zend Platform is loaded and licensed

Parameters
Name Type Description
$options array

Associative array of options

Throws
Exception Description
\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
Name Type Description
$dir string

Path of directory ot clean

$mode string

The same parameter as in Zend_Cache_Backend_ZendPlatform::clean()

Returns
Type Description
boolean True if ok
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
Name Type Description
$file string

Complete file path

Returns
Type Description
boolean True 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
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
methodpublicload( string $id, boolean $doNotTestCacheValidity = false ) : string

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

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

Data 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
methodpublictest( string $id ) : mixed|false

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 false (a cache is not available) or "last modified" timestamp (int) of the available cache record
Documentation was generated by DocBlox 0.15.1.