Docs for class patTemplate_Function

Joomla! 1.5 Documentation

Packages

Package: patTemplate

Developer Network License

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 221 2004-05-28 15:45:08Z schst $

author: Sebastian Mordziol <[email protected]>
author: Stephan Schmidt <[email protected]>

Located in /pattemplate/patTemplate/Function/Globalvar.php (line 34)

 patTemplate_Module

 patTemplate_Function
   
    patTemplate_Function_Globalvar   (Subpackage Functions)

Variable Summary

object $_tmpl

Method Summary

string call (array $params, string $content)

void setTemplateReference (object patTemplate &$tmpl)

Variables

object $_tmpl (line 49)

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 70)

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 57)

set a reference to the patTemplate object that instantiated the reader

access: public

void setTemplateReference (object patTemplate &$tmpl)

object patTemplate &$tmpl: object

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 Mon, 05 Mar 2007 21:05:10 +0000 by phpDocumentor 1.3.1