\patTemplate_Stat

Base class for patTemplate Stat

$Id: Stat.php 423 2006-02-26 12:28:19Z schst $

A stat component should be implemented for each reader to support caching. Stats return information about the template source.

Summary

Methods
Properties
Constants
getName()
setParams()
getParam()
getModificationTime()
setOptions()
getTemplateRoot()
$_name
$_params
$_options
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$_name

$_name : string

module name

This has to be set in the final module classes.

Type

string

$_params

$_params : array

module parameters

Type

array

$_options

$_options : array

options, are identical to those of the corresponding reader

Type

array

Methods

getName()

getName() : string

get the name of the module

Returns

string —

name of the module

setParams()

setParams(  $params,   $clear = false) 

sets parameters of the module

Parameters

$params
$clear

getParam()

getParam(  $name) : mixed

gets a parameter of the module

Parameters

$name

Returns

mixed —

value of the parameter

getModificationTime()

getModificationTime(  $input) : integer

get the modification time of a template

Needed, if a template cache should be used, that auto-expires the cache.

Parameters

$input

Returns

integer —

unix timestamp

setOptions()

setOptions(  $options) 

set options

Parameters

$options

getTemplateRoot()

getTemplateRoot() : string

get the template root for this class

Returns

string