Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitTemplateViewHandler

Packages:

Interfaces:

Classes:

Core::View::arbitTemplateViewHandler

[ Index ] [ Core classes ] [ Core elements ] [ All elements ] [ Errors ]

Class arbitTemplateViewHandler

Text view handler generating emails from the provided view model.

Text view handler generating emails from the provided view model.

arbitViewHandler
   |
   --arbitTemplateViewHandler
Author(s):
Version:   $Revision: 1236 $
License:   GPL

Descendants

Child Class Description
arbitViewTextHandler Text view handler generating emails from the provided view model.
arbitViewEmailHandler Email view handler generating emails from the provided view model.
arbitViewXHtmlHandler XHtml view handler generating XHtml from the provided view model.
arbitModuleTemplateViewHandler XHtml view handler generating XHtml from the provided view model.

Member Variables

protected static array $returnValues
Storage for tempalte return values from last call.

Storage for tempalte return values from last call.
protected ezcTemplateConfiguration $config = null
Template handler configuration

Template handler configuration
protected array $extensions = array(
'arbitViewTemplateFunctions',
)
Template extensions used by the view handler.

Template extensions used by the view handler.
protected array $templates = array(
)
Method template association for default calls.

Method template association for default calls. In most cases we just assign some template to a view more, for which a method on this class is called. The normal plain procedure may just be mapped using this array and is handled inside the __call method of this class.

Inherited Member Variables

From arbitViewHandler
protected arbitViewHandler::$request

Method Summary

public arbitDecorateable addContextInformation( $model )
Enriches view model with common context information
public string display( $output )
Display controller result Select the view, which should be used to display the controller results, process and return the view results.
public mixed getReturnValue( $property )
Get Template return value from last processed template.
public void setLocale( $locale )
Set view locale Set the view locale to the given locale string.
public string showDefaultModel( $model )
Show default model Display an arbitrary model with some default view.
public string __call( $method , $parameters )
Default template handler The default template handlers checks if a template has been registered for the received call and sends the module to the registered template without any modification or enhancement. the calls may be found in the protected class property $templates.

Inherited Methods

From arbitViewHandler
public abstract void arbitViewHandler::display()
Display controller result Select the view, which should be used to display the controller results, process and echo the view results.
public abstract void arbitViewHandler::setLocale()
Set view locale Set the view locale to the given locale string.

Methods

addContextInformation

arbitDecorateable addContextInformation( arbitDecorateable $model )

Enriches view model with common context information

Enriches view model with common context information

Parameters:
Name Type Description
$model arbitDecorateable
Redefined in descendants as:
Method Description
arbitViewXHtmlHandler::addContextInformation() Enriches view model with common context information 

display

string display( arbitDecorateable $output )

Display controller result Select the view, which should be used to display the controller results, process and return the view results.

Display controller result Select the view, which should be used to display the controller results, process and return the view results.

Parameters:
Name Type Description
$output arbitDecorateable
Redefinition of:
Method Description
arbitViewHandler::display() Display controller result Select the view, which should be used to display the controller results, process and echo the view results.

getReturnValue

mixed getReturnValue( string $property )

Get Template return value from last processed template.

Get Template return value from last processed template.

Parameters:
Name Type Description
$property string

setLocale

void setLocale( string $locale )

Set view locale Set the view locale to the given locale string.

Set view locale Set the view locale to the given locale string.

Parameters:
Name Type Description
$locale string
Redefinition of:
Method Description
arbitViewHandler::setLocale() Set view locale Set the view locale to the given locale string.

showDefaultModel

string showDefaultModel( arbitViewModel $model )

Show default model Display an arbitrary model with some default view.

Show default model Display an arbitrary model with some default view.

Parameters:
Name Type Description
$model arbitViewErrorModel

__call

string __call( string $method , $parameters )

Default template handler The default template handlers checks if a template has been registered for the received call and sends the module to the registered template without any modification or enhancement. the calls may be found in the protected class property $templates.

Default template handler The default template handlers checks if a template has been registered for the received call and sends the module to the registered template without any modification or enhancement. The registered templates for the calls may be found in the protected class property $templates.

Parameters:
Name Type Description
$method string
$parameters array
Documentation generated on Mon, 05 Apr 2010 14:02:19 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3