API Documentation

Cache/Frontend/File.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: File.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Cache_Frontend_File

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_File
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
Constants
MODE_AND
MODE_OR
Properties
$_specificOptions
$_masterFile_mtimes
Methods
__construct
setMasterFiles
setMasterFile
setOption
load
test

Description

Constants

MODE_AND
jump to class

 MODE_AND = 'AND'

Consts for master_files_mode

Details

value
AND

MODE_OR
jump to class

 MODE_OR = 'OR'

Details

value
OR

Properties

$_masterFile_mtimes
jump to class

array $_masterFile_mtimes = 'null'

Master file mtimes

Array of int

Details

$_masterFile_mtimes
array
visibility
private
default
null
final
false
static
false

$_specificOptions
jump to class

array $_specificOptions = 'array'

Available options

====> (string) master_file : - a complete path of the master file - deprecated (see master_files)

====> (array) master_files : - an array of complete path of master files - this option has to be set !

====> (string) master_files_mode : - Zend_Cache_Frontend_File::MODE_AND or Zend_Cache_Frontend_File::MODE_OR - if MODE_AND, then all master files have to be touched to get a cache invalidation - if MODE_OR (default), then a single touched master file is enough to get a cache invalidation

====> (boolean) ignore_missing_master_files - if set to true, missing master files are ignored silently - if set to false (default), an exception is thrown if there is a missing master file

Details

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

load
jump to class

load( string $id, boolean $doNotTestCacheValidity = false, boolean $doNotUnserialize = false ) : mixed|false

Test if a cache is available for the given id and (if yes) return it (false else)

Arguments
$id
string
Cache id
$doNotTestCacheValidity
boolean
If set to true, the cache validity won't be tested
$doNotUnserialize
boolean
Do not serialize (even if automatic_serialization is true) => for internal use
Output
mixed|false
Cached datas
Details
visibility
public
final
false
static
false

setMasterFile
jump to class

setMasterFile( string $masterFile ) :

Change the master_file option

To keep the compatibility

Arguments
$masterFile
string
the complete path and name of the master file
Details
visibility
public
final
false
static
false
deprecated

setMasterFiles
jump to class

setMasterFiles(  $masterFiles ) :

Change the master_file option

Arguments
$masterFiles
Details
visibility
public
final
false
static
false

setOption
jump to class

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

Public frontend to set an option

Just a wrapper to get a specific behaviour for master_file

Arguments
$name
string
Name of the option
$value
mixed
Value of the option
Details
visibility
public
final
false
static
false
throws

test
jump to class

test( string $id ) : int|false

Test if a cache is available for the given id

Arguments
$id
string
Cache id
Output
int|false
Last modified time of cache entry if it is available, false otherwise
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.