API Documentation

Cache/Frontend/Function.php

Includes 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_Frontend
version
$Id: Function.php 22654 2010-07-22 18:44:13Z mabe $
Classes
Zend_Cache_Frontend_Function

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

Extends from
Zend_Cache_Core
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_Frontend
Properties
$_specificOptions
Methods
__construct
call
_makeId
makeId

Description

Properties

$_specificOptions
jump to class

array $_specificOptions = 'array'

This frontend specific options

====> (boolean) cache_by_default : - if true, function calls will be cached by default

====> (array) cached_functions : - an array of function names which will be cached (even if cache_by_default = false)

====> (array) non_cached_functions : - an array of function names which won't be cached (even if cache_by_default = true)

Details

$_specificOptions
array
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

_makeId
jump to class

_makeId(  $callback,  $args ) :

ZF-9970

Arguments
$callback
$args
Details
visibility
private
final
false
static
false
deprecated

call
jump to class

call( callback $callback, array $parameters = array, array $tags = array, int $specificLifetime = false, int $priority = 8 ) : mixed

Main method : call the specified function or get the result from cache

Arguments
$callback
callback
A valid callback
$parameters
array
Function parameters
$tags
array
Cache tags
$specificLifetime
int
If != false, set a specific lifetime for this cache record (null => infinite lifetime)
$priority
int
integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends
Output
mixed
Result
Details
visibility
public
final
false
static
false

makeId
jump to class

makeId( callback $callback, array $args = array ) : string

Make a cache id from the function name and parameters

Arguments
$callback
callback
A valid callback
$args
array
Function parameters
Output
string
Cache id
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.