BaseTemplate Class Reference
[Template System]

Inheritance diagram for BaseTemplate:

List of all members.

---

Detailed Description

The mother template.

It handles lots of good stuff from output buffering to getting errors and such.

Definition at line 8 of file base-template.inc.php.

Public Member Functions
	draw ()
	This function draws the entire page.
	drawHeader ($title)
	This function draws the header of the page.
	drawPage ()
	This function draws the content area of the page.
	drawError ()
	This draws all the errors that the page init generated.
	drawStatus ()
	This draws all the status messages that the page init generated.
	drawContent ()
	This draws teh content by calling draw() on the object in question.
	getContent ()
	this function gets our content for display.
	drawFooter ()
	This function draws teh footer of the page.
	drawGenerationStats ()
	this function draws text that gets replaced with page generation stats.
	drawRecachePageLink ($link= 'Recache Page')
	this function draws a link to recache the page (if it needs it...) this is only for entire page caches, and not object caches.
Public Attributes
	$object
	$content = null

---

Member Function Documentation

BaseTemplate::draw (   )

This function draws the entire page. It draws the header/footer if needed, and then has the object draw the actual content. Definition at line 18 of file base-template.inc.php.

BaseTemplate::drawContent (   )

This draws teh content by calling draw() on the object in question. Definition at line 89 of file base-template.inc.php. Referenced by XMLTemplate::drawPage(), and JSONTemplate::drawPage().

BaseTemplate::drawError (   )

This draws all the errors that the page init generated. they are all wrapped in a with class pf 'baseError' and an id of 'error-$key' where key is the key in the error array. Reimplemented in HTMLTemplate, JSONTemplate, and XMLTemplate. Definition at line 68 of file base-template.inc.php.

BaseTemplate::drawFooter (   )

This function draws teh footer of the page. Definition at line 111 of file base-template.inc.php.

BaseTemplate::drawGenerationStats (   )

this function draws text that gets replaced with page generation stats. Definition at line 118 of file base-template.inc.php.

BaseTemplate::drawHeader (  $  title  )

This function draws the header of the page. Parameters: $title  is the title of the page Definition at line 40 of file base-template.inc.php.

BaseTemplate::drawPage (   )

This function draws the content area of the page. Reimplemented in JSONTemplate, and XMLTemplate. Definition at line 47 of file base-template.inc.php.

BaseTemplate::drawRecachePageLink (  $  link = 'Recache Page'  )

this function draws a link to recache the page (if it needs it...) this is only for entire page caches, and not object caches. Parameters: $link  the text to link Definition at line 129 of file base-template.inc.php.

BaseTemplate::drawStatus (   )

This draws all the status messages that the page init generated. they are all wrapped in a with class pf 'baseStatus' and an id of 'status-$key' where key is the key in the status array. Reimplemented in HTMLTemplate, JSONTemplate, and XMLTemplate. Definition at line 80 of file base-template.inc.php.

BaseTemplate::getContent (   )

this function gets our content for display. Returns: the content string. Definition at line 99 of file base-template.inc.php.

---

Member Data Documentation

BaseTemplate::$content = null

Definition at line 12 of file base-template.inc.php.

BaseTemplate::$object

Definition at line 10 of file base-template.inc.php.

---

The documentation for this class was generated from the following file:

• lib/templates/base-template.inc.php

---