Path

ez components / documentation / api reference / 2009.1.2 / mvctools


eZ Components 2009.1.2

MvcTools: ezcMvcJsonViewHandler

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMvcJsonViewHandler

The view handler that renders result objects as JSON. [source]

Implemented Interfaces

Member Variables

protected mixed $result
Contains the result after process() has been called.
protected array(mixed) $variables = array()
Contains the variables that will be available in the template.
protected string $zoneName
Contains the zone name

Method Summary

public ezcMvcJsonViewHandler __construct( $zoneName, [$templateLocation = null] )
Creates a new view handler, where $zoneName is the name of the block and $templateLocation the location of a view template.
public string getName( )
Returns the name of the template, as set in the constructor.
public mixed getResult( )
Returns the result of the process() method.
public void process( $last )
Processes the template with the variables added by the send() method.
public void send( $name, $value )
Adds a variable to the template, which can then be used for rendering the view.

Methods

__construct

ezcMvcJsonViewHandler __construct( string $zoneName, [string $templateLocation = null] )
Creates a new view handler, where $zoneName is the name of the block and $templateLocation the location of a view template.

Parameters

Name Type Description
$zoneName string  
$templateLocation string  

getName

string getName( )
Returns the name of the template, as set in the constructor.

getResult

mixed getResult( )
Returns the result of the process() method.

process

void process( bool $last )
Processes the template with the variables added by the send() method.
The result of this action should be retrievable through the getResult() method.
The $last parameter is set if the view handler is the last one in the list of zones for a specific view. Only in that case is json_encode() used to generate JSON output.

Parameters

Name Type Description
$last bool  

send

void send( string $name, mixed $value )
Adds a variable to the template, which can then be used for rendering the view.

Parameters

Name Type Description
$name string  
$value mixed  

Last updated: Tue, 01 Sep 2009