Class patTemplate_Function_Globalvar

Description

patTemplate function that enables adding global variables from within a template.

Available attributes:

name > name of the variable default > default value of the variable hidden > whether to output the content of the variable: yes|no

$Id: Globalvar.php,v 1.2 2004/05/28 15:45:08 schst Exp $

Located in /includes/patTemplate/patTemplate/Function/Globalvar.php (line 31)

patTemplate_Module
   |
   --patTemplate_Function
      |
      --patTemplate_Function_Globalvar
Variable Summary
object $_tmpl
Method Summary
string call (array $params, string $content)
Variables
object $_tmpl (line 46)

reference to the patTemplate object that instantiated the module

  • access: protected

Inherited Variables

Inherited from patTemplate_Function

patTemplate_Function::$type

Inherited from patTemplate_Module

patTemplate_Module::$_params
Methods
call (line 67)

call the function

  • return: content to insert into the template
  • access: public
string call (array $params, string $content)
  • array $params: parameters of the function (= attributes of the tag)
  • string $content: content of the tag

Redefinition of:
patTemplate_Function::call()
call the function
setTemplateReference (line 54)

set a reference to the patTemplate object that instantiated the reader

  • access: public
void setTemplateReference (object patTemplate &$tmpl)

Inherited Methods

Inherited From patTemplate_Function

patTemplate_Function::call()
patTemplate_Function::setReader()

Inherited From patTemplate_Module

patTemplate_Module::getName()
patTemplate_Module::getParam()
patTemplate_Module::setParams()

Documentation generated on Fri, 4 Mar 2005 13:56:19 +1000 by phpDocumentor 1.3.0RC3