User management for the world wide web
Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

GenieGate_View Class Reference

A View is part of the Model-View-Controller design pattern, the View is used to show the result of a Model. More...

Inheritance diagram for GenieGate_View:

Inheritance graph
[legend]
List of all members.

Public Member Functions

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

 display ()
 Display the view.

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

Detailed Description

A View is part of the Model-View-Controller design pattern, the View is used to show the result of a Model.

In english, this means that the PHP pages used to show the results of an operation are wrapped around a view object like this one.

The purpose of having View`s are to facilitate the design of multiple languages or relocation/re-implementation of the display. (such that we could send XML or something instead of a PHP document) without modifying a lot of code.

Views are "use once and throw away" objects, the same view should not be used across multiple requests, however, they could (in theory) be shown again and again.

Classes implementing View`s should extend this class to obtain any added functionality that can be emulated.

Definition at line 19 of file View.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 in GenieGate_View_FlatFile, GenieGate_View_Ganged, GenieGate_View_Location, GenieGate_View_Mail, GenieGate_View_Php, GenieGate_View_VCard, and GenieGate_View_XMLExport.

Definition at line 56 of file View.php.

getLink (  $  qry = array()  ) 
 

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.

param (  $  param = FALSE,
$  value = FALSE
) 
 

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().

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