Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: patTemplate

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Abstract Class 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)

Abstract class patTemplate_Module
Direct descendents
Class Description
Abstract classpatTemplate_Dump Base class for patTemplate dumpers
Abstract classpatTemplate_TemplateCache Base class for patTemplate template cache
Abstract classpatTemplate_OutputFilter Base class for patTemplate output filter
Abstract classpatTemplate_Stat Base class for patTemplate Stat
Abstract classpatTemplate_Reader Base class for patTemplate readers
Abstract classpatTemplate_OutputCache Base class for patTemplate output cache
Abstract classpatTemplate_Function Base class for patTemplate functions
Abstract classpatTemplate_Modifier Base class for patTemplate variable modifiers
Abstract classpatTemplate_InputFilter Base class for patTemplate input filter
Variable Summary
Variable string $_name
Variable array $_params
Method Summary
Method string getName ()
Method mixed getParam (string $name)
Method 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 Mon, 05 Mar 2007 21:11:02 +0000 by phpDocumentor 1.3.1