API Documentation

Zend/Cache/Frontend/Function.php

Show: inherited
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: Function.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Cache_Frontend_Function

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  

Properties

Propertyprotectedarray  $_specificOptions= 'array( 'cache_by_default' => true'

This frontend specific options

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)

Default valuearray( 'cache_by_default' => trueDetails
Type
array

Methods

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

Constructor

Parameters
Name Type Description
$options array

Associative array of options

methodprivate_makeId(  $callback,  $args ) : void

ZF-9970

Parameters
Name Type Description
$callback
$args
Details
Deprecated
 
methodpubliccall( 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

Parameters
Name Type Description
$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

Returns
Type Description
mixed Result
methodpublicmakeId( callback $callback, array $args = array() ) : string

Make a cache id from the function name and parameters

Parameters
Name Type Description
$callback callback

A valid callback

$args array

Function parameters

Returns
Type Description
string Cache id
Throws
Exception Description
\Zend_Cache_Exception
Documentation was generated by DocBlox 0.15.1.