API Documentation

Zend/Cache/Frontend/Output.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: Output.php 24801 2012-05-13 12:03:22Z mabe $  

\Zend_Cache_Frontend_Output

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

Propertyprivate  $_idStack= 'array()'
Default valuearray()Details
Type

Methods

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

Constructor

Parameters
Name Type Description
$options array

Associative array of options

methodpublicend( array $tags = array(), int $specificLifetime = false, string $forcedDatas = null, boolean $echoData = true, int $priority = 8 ) : void

Stop the cache

Parameters
Name Type Description
$tags array

Tags array

$specificLifetime int

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

$forcedDatas string

If not null, force written datas with this

$echoData boolean

If set to true, datas are sent to the browser

$priority int

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

methodpublicstart( string $id, boolean $doNotTestCacheValidity = false, boolean $echoData = true ) : mixed

Start the cache

Parameters
Name Type Description
$id string

Cache id

$doNotTestCacheValidity boolean

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

$echoData boolean

If set to true, datas are sent to the browser if the cache is hit (simply returned else)

Returns
Type Description
mixed True if the cache is hit (false else) with $echoData=true (default) ; string else (datas)
Documentation was generated by DocBlox 0.15.1.