JsonRenderer Class Reference

JSON renderer. More...

Public Member Functions
	getEngine ()
	Return the template engine object, if any.
	setResolver (Resolver $resolver)
	Set the resolver used to map a template name to a resource the renderer may consume.
	setMergeUnnamedChildren ($mergeUnnamedChildren)
	Set flag indicating whether or not to merge unnamed children.
	setJsonpCallback ($callback)
	Set the JSONP callback function name.
	hasJsonpCallback ()
	Returns whether or not the jsonpCallback has been set.
	mergeUnnamedChildren ()
	Should we merge unnamed children?
	render ($nameOrModel, $values=null)
	Renders values as JSON.
	canRenderTrees ()
	Can this renderer render trees of view models?

Protected Member Functions
	recurseModel (Model $model, $mergeWithVariables=true)
	Retrieve values from a model and recurse its children to build a data structure.
	injectChildren (Model $model, array $children)
	Inject discovered child model values into parent model.

Protected Attributes
	$mergeUnnamedChildren = false
	$resolver
	$jsonpCallback = null

Detailed Description

JSON renderer.

Member Function Documentation

canRenderTrees

(

)

Can this renderer render trees of view models?

Yes.

Returns

true

Implements TreeRendererInterface.

getEngine

(

)

Return the template engine object, if any.

If using a third-party template engine, such as Smarty, patTemplate, phplib, etc, return the template engine object. Useful for calling methods on these objects, such as for setting filters, modifiers, etc.

Returns

mixed

hasJsonpCallback

(

)

Returns whether or not the jsonpCallback has been set.

Returns

bool

injectChildren ( Model  $model, array  $children  )

protected

Inject discovered child model values into parent model.

Todo:

detect collisions and decide whether to append and/or aggregate?

Parameters

Model	$model
array	$children

mergeUnnamedChildren

(

)

Should we merge unnamed children?

Returns

bool

recurseModel ( Model  $model,   $mergeWithVariables = true  )

protected

Retrieve values from a model and recurse its children to build a data structure.

Parameters

Model	$model
bool	$mergeWithVariables	Whether or not to merge children with the variables of the $model

Returns

array

render	(		$nameOrModel,
			$values = null
	)

Renders values as JSON.

Todo:

Determine what use case exists for accepting both $nameOrModel and $values

Parameters

string | Model	$nameOrModel	The script/resource process, or a view model
null | array | \ArrayAccess	$values	Values to use during rendering

Exceptions

Exception\DomainException

Returns

string The script output.

setJsonpCallback

(

$callback

)

Set the JSONP callback function name.

Parameters

string

$callback

Returns

JsonRenderer

setMergeUnnamedChildren

(

$mergeUnnamedChildren

)

Set flag indicating whether or not to merge unnamed children.

Parameters

bool

$mergeUnnamedChildren

Returns

JsonRenderer

setResolver

(

Resolver

$resolver

)

Set the resolver used to map a template name to a resource the renderer may consume.

Todo:

Determine use case for resolvers when rendering JSON

Parameters

Resolver

$resolver

Returns

Renderer

Member Data Documentation

$jsonpCallback = null

protected

$mergeUnnamedChildren = false

protected

$resolver

protected