Class patTemplate_Module

Description

patTemplate Module base class

$Id: Module.php,v 1.4 2004/05/25 20:38:38 schst Exp $

The patTemplate_Module is the base class for all patTemplate modules like readers, dumpers, filters, etc.

Located in /includes/patTemplate/patTemplate/Module.php (line 27)


	
			
Direct descendents
Class Description
patTemplate_Dump Base class for patTemplate dumpers
patTemplate_Function Base class for patTemplate functions
patTemplate_InputFilter Base class for patTemplate input filter
patTemplate_Modifier Base class for patTemplate variable modifiers
patTemplate_OutputCache Base class for patTemplate output cache
patTemplate_OutputFilter Base class for patTemplate output filter
patTemplate_Reader Base class for patTemplate readers
patTemplate_Stat Base class for patTemplate Stat
patTemplate_TemplateCache Base class for patTemplate template cache
Variable Summary
string $_name
array $_params
Method Summary
string getName ()
mixed getParam (string $name)
void setParams (array $params, [boolean $clear = false])
Variables
string $_name = null (line 38)

module name

This has to be set in the final module classes.

  • access: protected

Redefined in descendants as:
array $_params = array() (line 46)

module parameters

  • access: protected

Redefined in descendants as:
Methods
getName (line 54)

get the name of the module

  • return: name of the module
  • access: public
string getName ()
getParam (line 80)

gets a parameter of the module

  • return: value of the parameter
  • access: public
mixed getParam (string $name)
  • string $name: name of the parameter
setParams (line 66)

sets parameters of the module

  • access: public
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 Fri, 4 Mar 2005 13:56:43 +1000 by phpDocumentor 1.3.0RC3