Class: View
Source Location: /view/View.class.php
MojaviObject
|
--View
A view represents the presentation layer of an action. Output can be customized by supplying attributes, which a template can manipulate and display.
Author(s):
- Sean Kerr (skerr@mojavi.org)
Version:
- $Id: View.class.php 755 2005-01-27 19:36:09Z seank $
Copyright:
|
|
|
|
Child classes:
|
Inherited Methods
|
Class Details
Class Variables
Class Methods
method clearAttributes [line 114]
Clear all attributes associated with this view.
Tags:
Overridden in child classes as:
- PHPView::clearAttributes()
- Clear all attributes associated with this view.
method decorate [line 129]
string &decorate(
string
&$content)
|
|
Loop through all template slots and fill them in with the results of presentation data.
Tags:
Overridden in child classes as:
- PHPView::decorate()
- Loop through all template slots and fill them in with the results of presentation data.
Parameters:
method execute [line 191]
Execute any presentation logic and set template attributes.
Tags:
method getAttribute [line 206]
mixed &getAttribute(
string
$name)
|
|
Retrieve an attribute.
Tags:
Overridden in child classes as:
- PHPView::getAttribute()
- Retrieve an attribute.
Parameters:
method getAttributeNames [line 218]
array getAttributeNames(
)
|
|
Retrieve an array of attribute names.
Tags:
Overridden in child classes as:
- PHPView::getAttributeNames()
- Retrieve an array of attribute names.
method getContext [line 230]
Retrieve the current application context.
Tags:
method getDecoratorDirectory [line 248]
string getDecoratorDirectory(
)
|
|
Retrieve this views decorator template directory.
Tags:
method getDecoratorTemplate [line 266]
string getDecoratorTemplate(
)
|
|
Retrieve this views decorator template.
Tags:
method getDirectory [line 284]
Retrieve this views template directory.
Tags:
method getEngine [line 300]
Retrieve the template engine associated with this view. Note: This will return null for PHPView instances.
Tags:
Overridden in child classes as:
- PHPView::getEngine()
- Retrieve the template engine associated with this view.
method getSlots [line 312]
Retrieve an array of specified slots for the decorator template.
Tags:
method getTemplate [line 330]
Retrieve this views template.
Tags:
method importAttributes [line 354]
void importAttributes(
array
$names, [bool
$files = false], [bool
$errors = true], [bool
$stripTags = true], [bool
$specialChars = true])
|
|
Import parameter values and error messages from the request directly as view attributes.
Tags:
Parameters:
method initialize [line 491]
Initialize this view.
Tags:
Parameters:
method isDecorator [line 517]
Indicates that this view is a decorating view.
Tags:
method preRenderCheck [line 537]
Execute a basic pre-render check to verify all required variables exist and that the template is readable.
Tags:
method removeAttribute [line 599]
mixed &removeAttribute(
string
$name)
|
|
Remove an attribute.
Tags:
Overridden in child classes as:
- PHPView::removeAttribute()
- Remove an attribute.
Parameters:
method render [line 616]
Render the presentation. When the controller render mode is View::RENDER_CLIENT, this method will render the presentation directly to the client and null will be returned.
Tags:
Overridden in child classes as:
- PHPView::render()
- Render the presentation.
method setAttribute [line 631]
void setAttribute(
string
$name, mixed
$value)
|
|
Set an attribute.
Tags:
Overridden in child classes as:
- PHPView::setAttribute()
- Set an attribute.
Parameters:
method setAttributeByRef [line 646]
void setAttributeByRef(
string
$name, mixed
&$value)
|
|
Set an attribute by reference.
Tags:
Overridden in child classes as:
- PHPView::setAttributeByRef()
- Set an attribute by reference.
Parameters:
method setAttributes [line 661]
void setAttributes(
array
$values)
|
|
Set an array of attributes.
Tags:
Overridden in child classes as:
- PHPView::setAttributes()
- Set an array of attributes.
Parameters:
method setAttributesByRef [line 676]
void setAttributesByRef(
array
&$values)
|
|
Set an array of attributes by reference.
Tags:
Overridden in child classes as:
- PHPView::setAttributesByRef()
- Set an array of attributes by reference.
Parameters:
method setDecoratorDirectory [line 690]
void setDecoratorDirectory(
string
$directory)
|
|
Set the decorator template directory for this view.
Tags:
Parameters:
method setDecoratorTemplate [line 712]
void setDecoratorTemplate(
string
$template)
|
|
Set the decorator template for this view. If the template path is relative, it will be based on the currently executing module's template sub-directory.
Tags:
Parameters:
method setDirectory [line 745]
void setDirectory(
string
$directory)
|
|
Set the template directory for this view.
Tags:
Parameters:
method setSlot [line 769]
void setSlot(
string
$attributeName, string
$moduleName, string
$actionName)
|
|
Set the module and action to be executed in place of a particular template attribute. If a slot with the name already exists, it will be overridden.
Tags:
Parameters:
method setTemplate [line 793]
void setTemplate(
string
$template)
|
|
Set the template for this view. If the template path is relative, it will be based on the currently executing module's template sub-directory.
Tags:
Parameters:
Class Constants
|
|