User management for the world wide web

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

GenieGate_View_Php Class Reference

A view that uses PHP documents for display. More...

Inheritance diagram for GenieGate_View_Php:

Inheritance graph
[legend]
Collaboration diagram for GenieGate_View_Php:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 GenieGate_View_Php ($page, $tpl=FALSE)
 Construct a view.

 display ()
 Display the view.

 input ($name, $value="", $sz=20, $type="TEXT")
 Create an INPUT tag.

 passThrough ($skip=array())
 Passes form variables on.

 param ($param=FALSE, $value=FALSE)
 Get/Set a named parameter.

 getLink ($qry=array())
 Returns a link to this page.


Public Attributes

 $page
 the PHP document that will be included.

 $shell_template
 Shell template, view will use this, (if set to something) to "wrap" the results in, this is a handy place to put header and footer HTML code.


Detailed Description

A view that uses PHP documents for display.

This is just a glorified include() that provides view methods to the underlying PHP document, and a notion of a "shell" that provides a handy place to store global HEADERS/FOOTERS etc..

Definition at line 13 of file Php.php.


Constructor & Destructor Documentation

GenieGate_View_Php page,
tpl = FALSE
 

Construct a view.

Parameters:
$page - The PHP page to display.
$tpl - The "shell template". (optional)

Definition at line 30 of file Php.php.


Member Function Documentation

display  ) 
 

Display the view.

In this case, does nothing. (a "blank" view for Controller methods that "cheat" by sending output themselves.)

Reimplemented from GenieGate_View.

Definition at line 37 of file Php.php.

getLink qry = array()  )  [inherited]
 

Returns a link to this page.

Parameters:
$qry - An array of Key => Value pairs to be urlencoded.
Returns:
a string with a link to this page.

Definition at line 66 of file View.php.

input name,
value = "",
sz = 20,
type = "TEXT"
 

Create an INPUT tag.

Parameters:
$name - The variable name.
$value - The variable value.
$sz - The input size.
$type - The input TYPE, example, HIDDEN or TEXT

Definition at line 52 of file Php.php.

param param = FALSE,
value = FALSE
[inherited]
 

Get/Set a named parameter.

With no parameters, returns an associative array of all the available parameters. (Same as $view->PARAM, but encapsulated)

With 1 parameter, ($param) just returns the value of the named parameter.

With 2 parameters, assigns $param a new value (returns old value).

Parameters:
$param - The parameter name.
$value - The value to assign it to.

Definition at line 36 of file View.php.

Referenced by GenieGate_View_XMLExport::display().

passThrough skip = array()  ) 
 

Passes form variables on.

Create series of HTML HIDDEN input variables for all the current form variables, except those found in $skip.

Parameters:
$skip - List of variable names NOT to pass on.

Definition at line 61 of file Php.php.


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