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_Dump

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

Base class for patTemplate dumpers

The dump functionality is separated from the main class for performance reasons.

Located in /pattemplate/patTemplate/Dump.php (line 29) 

Abstract class patTemplate_Module

Abstract class patTemplate_Dump   (Subpackage Dump)
Direct descendents
Description | Descendents | Variables (details) | Methods (details)
Class Description
ClasspatTemplate_Dump_XUL Dumps templates as XUL, using PEAR::XML_XUL
ClasspatTemplate_Dump_Html Dumps templates as HTML
Variable Summary
Description | Descendants | Variables (details) | Methods (details)
Variable object $_tmpl
Method Summary
Description | Descendants | Variables (details) | Methods (details)
Method void displayFooter ()
Method void displayHeader ()
Abstract method void dumpGlobals (array $globals)
Abstract method void dumpTemplates (array $templates, array $vars)
Method void setTemplateReference (object patTemplate &$tmpl)
Variables
Description | Descendents | Variables (details) | Methods (details)
object $_tmpl (line 37)

reference to the patTemplate object that instantiated the module

  • access: protected

Inherited Variables

Inherited from patTemplate_Module

Variable patTemplate_Module::$_name
 Variable patTemplate_Module::$_params
Methods
Description | Descendents | Variables (details) Methods (details)
displayFooter (line 89)

display the footer

  • access: public
void displayFooter ()
Redefined in descendants as:
displayHeader (line 55)

display the header

  • access: public
void displayHeader ()
Redefined in descendants as:
dumpGlobals (line 66)

dump the global variables

  • abstract:
  • access: public
void dumpGlobals (array $globals)
  • array $globals: array containing all global variables
Redefined in descendants as:
dumpTemplates (line 80)

dump the templates

This method has to be implemented in the dumpers.

  • abstract:
  • access: public
void dumpTemplates (array $templates, array $vars)
  • array $templates: templates
  • array $vars: variables
Redefined in descendants as:
setTemplateReference (line 45)

set a reference to the patTemplate object that instantiated the reader

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

Inherited Methods

Inherited From patTemplate_Module

patTemplate_Module::getName()
patTemplate_Module::getParam()
patTemplate_Module::setParams()
Documentation generated on Sat, 14 Nov 2009 11:12:21 +0000 by phpDocumentor 1.3.1