Cache/Frontend/File.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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cache  
Subpackage
Zend_Cache_Frontend  
Version
$Id: File.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Cache_Frontend_File

Package: Zend\Cache\Zend\Cache\Frontend
Parent(s)
\Zend_Cache_Core
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  MODE_AND = 'AND'
Consts for master_files_mode
>VConstant  MODE_OR = 'OR'
>VConstant  BACKEND_NOT_SUPPORTS_TAG = 'tags are not supported by the current backend'
inherited
Messages
Inherited from: \Zend_Cache_Core::BACKEND_NOT_SUPPORTS_TAG
>VConstant  BACKEND_NOT_IMPLEMENTS_EXTENDED_IF = 'Current backend doesn\'t implement the Zend_Cache_Backend_ExtendedInterface, so this method is not available'

Properties

>VPropertyprotected\Zend_Cache_Backend_Interface $_backend = null
inherited
Backend Object
Inherited from: \Zend_Cache_Core::$$_backend
Default valuenullDetails
Type
\Zend_Cache_Backend_Interface
Inherited_from
\Zend_Cache_Core::$$_backend  
>VPropertyprotectedarray $_backendCapabilities = array()
inherited
Array of capabilities of the backend (only if it implements Zend_Cache_Backend_ExtendedInterface)
Inherited from: \Zend_Cache_Core::$$_backendCapabilities
Default valuearray()Details
Type
array
Inherited_from
\Zend_Cache_Core::$$_backendCapabilities  
>VPropertyprotectedarray $_directivesList = array('lifetime', 'logging', 'logger')
staticinherited
Array of options which have to be transfered to backend
Inherited from: \Zend_Cache_Core::$$_directivesList
Default valuearray('lifetime', 'logging', 'logger')Details
Type
array
Inherited_from
\Zend_Cache_Core::$$_directivesList  
>VPropertyprotectedboolean $_extendedBackend = false
inherited
True if the backend implements Zend_Cache_Backend_ExtendedInterface
Inherited from: \Zend_Cache_Core::$$_extendedBackend
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Cache_Core::$$_extendedBackend  
>VPropertyprivatestring $_lastId = null
inherited
Last used cache id
Inherited from: \Zend_Cache_Core::$$_lastId
Default valuenullDetails
Type
string
Inherited_from
\Zend_Cache_Core::$$_lastId  
>VPropertyprivatearray $_masterFile_mtimes = null
Master file mtimes

Array of int

Default valuenullDetails
Type
array
>VPropertyprotectedarray $_options = array('write_control' => true, 'caching' => true, 'cache_id_prefix' => null, 'automatic_serialization' => false, 'automatic_cleaning_factor' => 10, 'lifetime' => 3600, 'logging' => false, 'logger' => null, 'ignore_user_abort' => false)
inherited
Available options
Inherited from: \Zend_Cache_Core::$$_options

====> (boolean) write_control : - Enable / disable write control (the cache is read just after writing to detect corrupt entries) - Enable write control will lightly slow the cache writing but not the cache reading Write control can detect some corrupt cache files but maybe it's not a perfect control

====> (boolean) caching : - Enable / disable caching (can be very useful for the debug of cached scripts)

=====> (string) cache_id_prefix : - prefix for cache ids (namespace)

====> (boolean) automatic_serialization : - Enable / disable automatic serialization - It can be used to save directly datas which aren't strings (but it's slower)

====> (int) automatic_cleaning_factor : - Disable / Tune the automatic cleaning process - The automatic cleaning process destroy too old (for the given life time) cache files when a new cache file is written : 0 => no automatic cache cleaning 1 => systematic cache cleaning x (integer) > 1 => automatic cleaning randomly 1 times on x cache write

====> (int) lifetime : - Cache lifetime (in seconds) - If null, the cache is valid forever.

====> (boolean) logging : - If set to true, logging is activated (but the system is slower)

====> (boolean) ignore_user_abort - If set to true, the core will set the ignore_user_abort PHP flag inside the save() method to avoid cache corruptions in some cases (default false)

Default valuearray('write_control' => true, 'caching' => true, 'cache_id_prefix' => null, 'automatic_serialization' => false, 'automatic_cleaning_factor' => 10, 'lifetime' => 3600, 'logging' => false, 'logger' => null, 'ignore_user_abort' => false)Details
Type
array
Inherited_from
\Zend_Cache_Core::$$_options  
>VPropertyprotectedarray $_specificOptions = array('master_file' => null, 'master_files' => null, 'master_files_mode' => 'OR', 'ignore_missing_master_files' => false)
Available options

====> (string) master_file : - a complete path of the master file - deprecated (see master_files)

====> (array) master_files : - an array of complete path of master files - this option has to be set !

====> (string) master_files_mode : - Zend_Cache_Frontend_File::MODE_AND or Zend_Cache_Frontend_File::MODE_OR - if MODE_AND, then all master files have to be touched to get a cache invalidation - if MODE_OR (default), then a single touched master file is enough to get a cache invalidation

====> (boolean) ignore_missing_master_files - if set to true, missing master files are ignored silently - if set to false (default), an exception is thrown if there is a missing master file

Default valuearray('master_file' => null, 'master_files' => null, 'master_files_mode' => 'OR', 'ignore_missing_master_files' => false)Details
Type
array

Methods

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

Constructor

Parameters
NameTypeDescription
$optionsarray

Associative array of options

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_id(string $id) : string
inherited

Make and return a cache id

Inherited from: \Zend_Cache_Core::_id()

Checks 'cache_id_prefix' and returns new id with prefix or simply the id if null

Parameters
NameTypeDescription
$idstring

Cache id

Returns
TypeDescription
stringCache id (with or without prefix)
methodprotected_log(string $message,  $priority = 4) : void
inherited

Log a message at the WARN (4) priority.

Inherited from: \Zend_Cache_Core::_log()
Parameters
NameTypeDescription
$messagestring
$priority
Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_loggerSanity() : void
inherited

Make sure if we enable logging that the Zend_Log class is available.

Inherited from: \Zend_Cache_Core::_loggerSanity()

Create a default log object if none is set.

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprivate_setOption(string $name, mixed $value) : void
inherited

Set an option

Inherited from: \Zend_Cache_Core::_setOption()
Parameters
NameTypeDescription
$namestring

Name of the option

$valuemixed

Value of the option

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_validateIdOrTag(string $string) : void
staticinherited

Validate a cache id or a tag (security, reliable filenames, reserved prefixes.

Inherited from: \Zend_Cache_Core::_validateIdOrTag()

..)

Throw an exception if a problem is found

Parameters
NameTypeDescription
$stringstring

Cache id or tag

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprotected_validateTagsArray(array $tags) : void
staticinherited

Validate a tags array (security, reliable filenames, reserved prefixes.

Inherited from: \Zend_Cache_Core::_validateTagsArray()

..)

Throw an exception if a problem is found

Parameters
NameTypeDescription
$tagsarray

Array of tags

Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicclean(string $mode = 'all', array | string $tags = array()) : boolean
inherited

Clean cache entries

Inherited from: \Zend_Cache_Core::clean()

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters
NameTypeDescription
$modestring
$tagsarray | string
Returns
TypeDescription
booleanTrue if ok
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicgetBackend() : \Zend_Cache_Backend
inherited

Returns the backend

Inherited from: \Zend_Cache_Core::getBackend()
Returns
TypeDescription
\Zend_Cache_Backendbackend object
methodpublicgetFillingPercentage() : int
inherited

Return the filling percentage of the backend storage

Inherited from: \Zend_Cache_Core::getFillingPercentage()
Returns
TypeDescription
intinteger between 0 and 100
methodpublicgetIds() : array
inherited

Return an array of stored cache ids

Inherited from: \Zend_Cache_Core::getIds()
Returns
TypeDescription
arrayarray of stored cache ids (string)
methodpublicgetIdsMatchingAnyTags(array $tags = array()) : array
inherited

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

Inherited from: \Zend_Cache_Core::getIdsMatchingAnyTags()

In case of multiple tags, a logical OR is made between tags

Parameters
NameTypeDescription
$tagsarray

array of tags

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

Return an array of stored cache ids which match given tags

Inherited from: \Zend_Cache_Core::getIdsMatchingTags()

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
inherited

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

Inherited from: \Zend_Cache_Core::getIdsNotMatchingTags()

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
inherited

Return an array of metadatas for the given cache id

Inherited from: \Zend_Cache_Core::getMetadatas()

The array will 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)
methodpublicgetOption(string $name) : mixed
inherited

Public frontend to get an option value

Inherited from: \Zend_Cache_Core::getOption()
Parameters
NameTypeDescription
$namestring

Name of the option

Returns
TypeDescription
mixedoption value
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicgetTags() : array
inherited

Return an array of stored tags

Inherited from: \Zend_Cache_Core::getTags()
Returns
TypeDescription
arrayarray of stored tags (string)
methodpublicload(string $id, boolean $doNotTestCacheValidity = false, boolean $doNotUnserialize = false) : mixed | false

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

Parameters
NameTypeDescription
$idstring

Cache id

$doNotTestCacheValidityboolean

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

$doNotUnserializeboolean

Do not serialize (even if automatic_serialization is true) => for internal use

Returns
TypeDescription
mixed | falseCached datas
methodpublicremove(string $id) : boolean
inherited

Remove a cache

Inherited from: \Zend_Cache_Core::remove()
Parameters
NameTypeDescription
$idstring

Cache id to remove

Returns
TypeDescription
booleanTrue if ok
methodpublicsave(mixed $data, string $id = null, array $tags = array(), int $specificLifetime = false, int $priority = 8) : boolean
inherited

Save some data in a cache

Inherited from: \Zend_Cache_Core::save()
Parameters
NameTypeDescription
$datamixed

Data to put in cache (can be another type than string if automatic_serialization is on)

$idstring

Cache id (if not set, the last cache id will be used)

$tagsarray

Cache tags

$specificLifetimeint

If != false, set a specific lifetime for this cache record (null => infinite lifetime)

$priorityint

integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns
TypeDescription
booleanTrue if no problem
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicsetBackend(\Zend_Cache_Backend $backendObject) : void
inherited

Set the backend

Inherited from: \Zend_Cache_Core::setBackend()
Parameters
NameTypeDescription
$backendObject\Zend_Cache_Backend
Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublicsetConfig(\Zend_Config $config) : \Zend_Cache_Core
inherited

Set options using an instance of type Zend_Config

Inherited from: \Zend_Cache_Core::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Cache_Core
methodpublicsetLifetime(int $newLifetime) : void
inherited

Force a new lifetime

Inherited from: \Zend_Cache_Core::setLifetime()

The new value is set for the core/frontend but for the backend too (directive)

Parameters
NameTypeDescription
$newLifetimeint

New lifetime (in seconds)

methodpublicsetMasterFile(string $masterFile) : void

Change the master_file option

To keep the compatibility

Parameters
NameTypeDescription
$masterFilestring

the complete path and name of the master file

Details
Deprecated
 
methodpublicsetMasterFiles(array $masterFiles) : void

Change the master_files option

Parameters
NameTypeDescription
$masterFilesarray

the complete paths and name of the master files

methodpublicsetOption(string $name, mixed $value) : void

Public frontend to set an option

Just a wrapper to get a specific behaviour for master_file

Parameters
NameTypeDescription
$namestring

Name of the option

$valuemixed

Value of the option

Throws
ExceptionDescription
\Zend_Cache_Exception
methodpublictest(string $id) : int | false

Test if a cache is available for the given id

Parameters
NameTypeDescription
$idstring

Cache id

Returns
TypeDescription
int | falseLast modified time of cache entry if it is available, false otherwise
methodpublictouch(string $id, int $extraLifetime) : boolean
inherited

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

Inherited from: \Zend_Cache_Core::touch()
Parameters
NameTypeDescription
$idstring

cache id

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