\patTemplate_Function

Base class for patTemplate functions

$Id: Function.php 311 2004-10-27 13:52:20Z schst $

Summary

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

$_reader

$_reader : object

reader object

Type

object

$type

$type : integer

function type

Type

integer

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

setReader()

setReader(  $reader) 

set the reference to the reader object

Parameters

$reader

call()

call(  $params,   $content) : string

call the function

Parameters

$params
$content

Returns

string —

content to insert into the template