Class patTemplate_Dump

Description

Base class for patTemplate dumpers

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

Located in /includes/patTemplate/patTemplate/Dump.php (line 26)

patTemplate_Module
   |
   --patTemplate_Dump
Direct descendents
Class Description
patTemplate_Dump_Html Dumps templates as HTML
Variable Summary
object $_tmpl
Method Summary
void displayFooter ()
void displayHeader ()
void dumpGlobals (array $globals)
void dumpTemplates (array $templates, array $vars)
Variables
object $_tmpl (line 34)

reference to the patTemplate object that instantiated the module

  • access: protected

Inherited Variables

Inherited from patTemplate_Module

patTemplate_Module::$_name
patTemplate_Module::$_params
Methods
displayFooter (line 86)

display the footer

  • access: public
void displayFooter ()

Redefined in descendants as:
displayHeader (line 52)

display the header

  • access: public
void displayHeader ()

Redefined in descendants as:
dumpGlobals (line 63)

dump the global variables

  • abstract:
  • access: public
void dumpGlobals (array $globals)
  • array $globals: array containing all global variables

Redefined in descendants as:
dumpTemplates (line 77)

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

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 Fri, 4 Mar 2005 13:56:07 +1000 by phpDocumentor 1.3.0RC3