API Documentation

Cache/Backend.php

Classes 
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: Backend.php 20882 2010-02-03 18:19:44Z matthew $
Classes
Zend_Cache_Backend

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

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
$_directives
$_options
Methods
__construct
setDirectives
setOption
getLifetime
isAutomaticCleaningAvailable
getTmpDir
_isGoodTmpDir
_loggerSanity
_log

Description

Properties

$_directives
jump to class

array $_directives = 'array'

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

Details

$_directives
array
directives
visibility
protected
default
array
final
false
static
false

$_options
jump to class

array $_options = 'array'

Available options

Details

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

Methods

__construct
jump to class

__construct( array $options = array ) : void

Constructor

Arguments
$options
array
Associative array of options
Details
visibility
public
final
false
static
false
throws

_isGoodTmpDir
jump to class

_isGoodTmpDir( $dir $dir ) : boolean

Verify if the given temporary directory is readable and writable

Arguments
$dir
$dir
temporary directory
Output
boolean
true if the directory is ok
Details
visibility
protected
final
false
static
false

_log
jump to class

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

Log a message at the WARN (4) priority.

Arguments
$message
string
$priority
Details
visibility
protected
final
false
static
false
throws

_loggerSanity
jump to class

_loggerSanity( ) : void

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

Create a default log object if none is set.

Details
visibility
protected
final
false
static
false
throws

getLifetime
jump to class

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

Arguments
$specificLifetime
int
Output
int
Cache life time
Details
visibility
public
final
false
static
false

getTmpDir
jump to class

getTmpDir( ) : string

Determine system TMP directory and detect if we have read access

inspired from Zend_File_Transfer_Adapter_Abstract

Output
string
Details
visibility
public
final
false
static
false
throws
if unable to determine directory

isAutomaticCleaningAvailable
jump to class

isAutomaticCleaningAvailable( ) : boolean

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Output
boolean
Details
visibility
public
final
false
static
false
deprecated

setDirectives
jump to class

setDirectives( array $directives ) : void

Set the frontend directives

Arguments
$directives
array
Assoc of directives
Details
visibility
public
final
false
static
false
throws

setOption
jump to class

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

Set an option

Arguments
$name
string
$value
mixed
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.