Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitViewJsonHandler

Core::View::arbitViewJsonHandler

Class arbitViewJsonHandler

JSON view handler generating JSON from the provided view model.

JSON view handler generating JSON from the provided view model.

arbitViewHandler
   |
   --arbitViewJsonHandler
Author(s):
Version:   $Revision: 1650 $
License:   GPL

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 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 showError( $model )
Show default model Display an arbitrary model with some default view.
public string showUser( $model )
Show user model Special display handler for user models, to not reveal to much data about the user inside the JSON.
protected DOMNode transformArray( $array )
Return JSON representation of PHP array
protected DOMNode transformValue( $value )
Return JSON representation of some PHP value

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

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.

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( arbitDecorateable $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

showError

string showError( arbitViewErrorContextModel $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

showUser

string showUser( arbitViewUserModel $model )

Show user model Special display handler for user models, to not reveal to much data about the user inside the JSON.

Show user model Special display handler for user models, to not reveal to much data about the user inside the JSON.

Parameters:
Name Type Description
$model arbitViewUserModel

transformArray

DOMNode transformArray( $array )

Return JSON representation of PHP array

Return JSON representation of PHP array

Parameters:
Name Type Description
$array array

transformValue

DOMNode transformValue( mixed $value )

Return JSON representation of some PHP value

Return JSON representation of some PHP value

Parameters:
Name Type Description
$value mixed
Documentation generated on Mon, 05 Apr 2010 14:02:01 +0200 by phpDocumentor 1.4.3