patTemplate_Module
Description
patTemplate Module base class
$Id: Module.php 219 2004-05-25 20:38:38Z schst $
The patTemplate_Module is the base class for all patTemplate modules like readers, dumpers, filters, etc.
Located in /pattemplate/patTemplate/Module.php (line 27)
patTemplate_Module
Direct descendents
Class | Description |
---|---|
patTemplate_Dump | Base class for patTemplate dumpers |
patTemplate_TemplateCache | Base class for patTemplate template cache |
patTemplate_OutputFilter | Base class for patTemplate output filter |
patTemplate_Stat | Base class for patTemplate Stat |
patTemplate_Reader | Base class for patTemplate readers |
patTemplate_OutputCache | Base class for patTemplate output cache |
patTemplate_Function | Base class for patTemplate functions |
patTemplate_Modifier | Base class for patTemplate variable modifiers |
patTemplate_InputFilter | Base class for patTemplate input filter |
Method Summary
Variables
string
$_name
= null (line 38)
module name
This has to be set in the final module classes.
Redefined in descendants as:
- patTemplate_OutputFilter_HighlightPhp::$_name : filter name
- patTemplate_OutputFilter_StripWhitespace::$_name : filter name
- patTemplate_OutputFilter_PdfLatex::$_name : filter name
- patTemplate_OutputFilter_Tidy::$_name : filter name
- patTemplate_OutputFilter_Gzip::$_name : filter name
- patTemplate_OutputFilter_BBCode::$_name : filter name
- patTemplate_InputFilter_StripComments::$_name : filter name
Methods
getParam (line 80)
gets a parameter of the module
mixed
getParam
(string $name)
- string $name: name of the parameter
setParams (line 66)
sets parameters of the module
void
setParams
(array $params, [boolean $clear = false])
- array $params: assoc array containing parameters
- boolean $clear: flag to indicate, whether previously set parameters should be cleared
Documentation generated on Mon, 05 Mar 2007 21:11:02 +0000 by phpDocumentor 1.3.1