Cache/Backend.php

Show:

inherited

Classes
- \Zend_Cache_Backend

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
jump to top

Package: Zend_Cache\Zend_Cache_Backend

Children: \Zend_Cache_Backend_BlackHole; \Zend_Cache_Backend_WinCache; \Zend_Cache_Backend_Memcached; \Zend_Cache_Backend_ZendServer; \Zend_Cache_Backend_ZendPlatform; \Zend_Cache_Backend_Static; \Zend_Cache_Backend_File; \Zend_Cache_Backend_Test; \Zend_Cache_Backend_Libmemcached; \Zend_Cache_Backend_TwoLevels; \Zend_Cache_Backend_Xcache; \Zend_Cache_Backend_Apc; \Zend_Cache_Backend_Sqlite
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_directives = array('lifetime' => 3600, 'logging' => false, 'logger' => null)

Frontend or Core directives

=====> (int) lifetime : - Cache lifetime (in seconds) - If null, the cache is valid forever =====> (int) logging : - if set to true, a logging is activated throw Zend_Log

Default valuearray('lifetime' => 3600, 'logging' => false, 'logger' => null)Details

Type: array

array $_options = array()

Available options

Default valuearray()Details

Type: array

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array	Associative array of options

Throws

Exception	Description
\Zend_Cache_Exception

_isGoodTmpDir(string $dir) : boolean

Verify if the given temporary directory is readable and writable

Parameters

Name	Type	Description
$dir	string	temporary directory

Returns

Type	Description
boolean	true if the directory is ok

_log(string $message, $priority = 4) : void

Log a message at the WARN (4) priority.

Parameters

Name	Type	Description
$message	string
$priority

Throws

Exception	Description
\Zend_Cache_Exception

_loggerSanity() : void

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

Create a default log object if none is set.

Throws

Exception	Description
\Zend_Cache_Exception

getLifetime(int $specificLifetime) : int

Get the life time

if $specificLifetime is not false, the given specific life time is used else, the global lifetime is used

Parameters

Name	Type	Description
$specificLifetime	int

Returns

Type	Description
int	Cache life time

getOption(string $name) : mixed

Returns an option

Parameters

Name	Type	Description
$name	string	Optional, the options name to return

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Cache_Exceptions

getTmpDir() : string

Determine system TMP directory and detect if we have read access

inspired from Zend_File_Transfer_Adapter_Abstract

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Cache_Exception	if unable to determine directory

isAutomaticCleaningAvailable() : boolean

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Returns

Type	Description
boolean

Details

Deprecated

setDirectives(array $directives) : void

Set the frontend directives

Parameters

Name	Type	Description
$directives	array	Assoc of directives

Throws

Exception	Description
\Zend_Cache_Exception

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

Set an option

Parameters

Name	Type	Description
$name	string
$value	mixed

Throws

Exception	Description
\Zend_Cache_Exception

Cache/Backend.php

\Zend_Cache_Backendjump to top

Properties

Methods

\Zend_Cache_Backend
jump to top