Class FOFHalRenderJson

Description

Implements interfaces:

Implements the HAL over JSON renderer

  • since: 2.1

Located in /libraries/fof/hal/render/json.php (line 16)


	
			
Variable Summary
Method Summary
 FOFHalRenderJson __construct (FOFHalDocument &$document)
 string render ([array $options = array()])
 stdClass _getLink (FOFHalLink $link)
Variables
FOFHalDocument $_document (line 30)

The document to render

  • access: protected
Methods
Constructor __construct (line 37)

Public constructor

  • access: public
FOFHalRenderJson __construct (FOFHalDocument &$document)
render (line 49)

Render a HAL document in JSON format

  • return: The JSON representation of the HAL document
  • access: public
string render ([array $options = array()])
  • array $options: Rendering options. You can currently only set json_options (json_encode options)

Implementation of:
FOFHalRenderInterface::render()
Render a HAL document into a representation suitable for consumption.
_getLink (line 149)

Converts a FOFHalLink object into a stdClass object which will be used for JSON serialisation

  • return: The converted link object
  • access: protected
stdClass _getLink (FOFHalLink $link)

Documentation generated on Tue, 19 Nov 2013 15:06:19 +0100 by phpDocumentor 1.4.3