Cache/Backend/WinCache.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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cache  
Subpackage
Zend_Cache_Backend  
Version
$Id$  

\Zend_Cache_Backend_WinCache

Package: Zend_Cache\Zend_Cache_Backend
Implements
Parent(s)
\Zend_Cache_Backend
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  TAGS_UNSUPPORTED_BY_CLEAN_OF_WINCACHE_BACKEND = 'Zend_Cache_Backend_WinCache::clean() : tags are unsupported by the WinCache backend'
Log message
>VConstant  TAGS_UNSUPPORTED_BY_SAVE_OF_WINCACHE_BACKEND = 'Zend_Cache_Backend_WinCache::save() : tags are unsupported by the WinCache backend'

Methods

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

Constructor

Parameters
NameTypeDescription
$optionsarray

associative array of options

Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicclean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, 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
NameTypeDescription
$modestring

clean mode

$tagsarray

array of tags

Returns
TypeDescription
booleantrue if no problem
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicgetCapabilities() : array

Return an associative array of capabilities (booleans) of the backend

The array must include these keys : - automatic_cleaning (is automating cleaning necessary) - tags (are tags supported) - expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example)) - priority does the backend deal with priority when saving - infinite_lifetime (is infinite lifetime can work with this backend) - get_list (is it possible to get the list of cache ids and the complete list of tags)
Returns
TypeDescription
arrayassociative of with capabilities
methodpublicgetFillingPercentage() : int

Return the filling percentage of the backend storage

Returns
TypeDescription
intinteger between 0 and 100
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicgetIds() : array

Return an array of stored cache ids

Returns
TypeDescription
arrayarray of stored cache ids (string)
methodpublicgetIdsMatchingAnyTags(array $tags = array()) : array

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical AND is made between tags
Parameters
NameTypeDescription
$tagsarray

array of tags

Returns
TypeDescription
arrayarray of any matching cache ids (string)
methodpublicgetIdsMatchingTags(array $tags = array()) : array

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags
Parameters
NameTypeDescription
$tagsarray

array of tags

Returns
TypeDescription
arrayarray of matching cache ids (string)
methodpublicgetIdsNotMatchingTags(array $tags = array()) : array

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags
Parameters
NameTypeDescription
$tagsarray

array of tags

Returns
TypeDescription
arrayarray of not matching cache ids (string)
methodpublicgetMetadatas(string $id) : array

Return an array of metadatas for the given cache id

The array must include these keys : - expire : the expire timestamp - tags : a string array of tags - mtime : timestamp of last modification time
Parameters
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
arrayarray of metadatas (false if the cache id is not found)
methodpublicgetTags() : array

Return an array of stored tags

Returns
TypeDescription
arrayarray of stored tags (string)
methodpublicisAutomaticCleaningAvailable() : boolean

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead
Returns
TypeDescription
boolean
Details
Deprecated
 
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 WinCache backend
Parameters
NameTypeDescription
$idstring

cache id

$doNotTestCacheValidityboolean

if set to true, the cache validity won't be tested

Returns
TypeDescription
stringcached datas (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

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

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

Parameters
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
mixedfalse (a cache is not available) or "last modified" timestamp (int) of the available cache record
methodpublictouch(string $id, int $extraLifetime) : boolean

Give (if possible) an extra lifetime to the given cache id

Parameters
NameTypeDescription
$idstring

cache id

$extraLifetimeint
Returns
TypeDescription
booleantrue if ok
Documentation was generated by phpDocumentor 2.2.0 .