\patTemplate_Module

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.

Summary

Methods
Properties
Constants
getName()
setParams()
getParam()
$_name
$_params
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

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