Docs For Class WFPageRendering

Interface WFPageRendering

Description

author: Alan Pinstein <apinstein@mac.com>
version: $Id: kvcoding.php,v 1.3 2004/12/12 02:44:09 alanpinstein Exp $
copyright: Copyright (c) 2005 Alan Pinstein. All Rights Reserved.

Located in /framework/WFPageRendering.php (line 11)

Method Summary

void assign (string $name, mixed $value)

object WFWidget getCurrentWidget (assoc_array $params)

object WFPage getPage ()

string render ([boolean $display = true])

void setTemplate (string $template)

Methods

assign (line 18)

Assign a name/value pair to the underlying template engine.

void assign (string $name, mixed $value)

string $name: Name of the variable.
mixed $value: Value of the variable.

getCurrentWidget (line 33)

Get the widget specified in the "id" field of the passed associative array. Do all sanity checking along the way.

return: Sublcass specified by the current widget... with smarty we look in $params['id'].
throws: Exception

object WFWidget getCurrentWidget (assoc_array $params)

assoc_array $params: An associative array with the name/value pairs of the item's attributes in the template engine.

getPage (line 42)

Get the WFPage object that is using the template.

The only thing the framework assigns to the template is __page, which is a reference to itself so that the template can access widgets, etc. By having this interface include this function, we can always get back to the WFPage from any template engine.

return: Page that the template is part of.

object WFPage getPage ()

render (line 25)

Render the view.

return: The HTML output, or NULL, depending on $display.

string render ([boolean $display = true])

boolean $display: Display the output or return it in a variable?

setTemplate (line 48)

Set the template file path.

void setTemplate (string $template)

string $template: The HTML template file path for this view.

Documentation generated on Thu, 07 Aug 2008 10:36:53 -0400 by phpDocumentor 1.4.1