Support Joomla!

Packages

Package: patTemplate

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Abstract Class patTemplate_Module

Description
Description | Descendents | Variables (details) | Methods (details)

patTemplate Module base class

$Id: Module.php 10381 2008-06-01 03:35:53Z pasamio $

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
Description | Descendents | Variables (details) | Methods (details)
Class Description
Abstract classpatTemplate_OutputCache Base class for patTemplate output cache
Abstract classpatTemplate_TemplateCache Base class for patTemplate template cache
Abstract classpatTemplate_Dump Base class for patTemplate dumpers
Abstract classpatTemplate_Function Base class for patTemplate functions
Abstract classpatTemplate_Reader Base class for patTemplate readers
Abstract classpatTemplate_Modifier Base class for patTemplate variable modifiers
Abstract classpatTemplate_OutputFilter Base class for patTemplate output filter
Abstract classpatTemplate_InputFilter Base class for patTemplate input filter
Abstract classpatTemplate_Stat Base class for patTemplate Stat
Variable Summary
Description | Descendants | Variables (details) | Methods (details)
Variable string $_name
Variable array $_params
Method Summary
Description | Descendants | Variables (details) | Methods (details)
Method string getName ()
Method mixed getParam (string $name)
Method void setParams (array $params, [boolean $clear = false])
Variables
Description | Descendents | Variables (details) | Methods (details)
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
Description | Descendents | Variables (details) Methods (details)
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 Sat, 14 Nov 2009 11:16:03 +0000 by phpDocumentor 1.3.1