HTTP handler to validate a report template to ensure that it has valid syntax. This action is accessed via the Template editor toolbar button to validate the current template. If the template is validated successfully it will return an JSON object with a response code of 200. If it fails it will return a different "code" in the JSON object. More...

Public Member Functions
	handle ($params)
	out ($params)

Detailed Description

HTTP handler to validate a report template to ensure that it has valid syntax. This action is accessed via the Template editor toolbar button to validate the current template. If the template is validated successfully it will return an JSON object with a response code of 200. If it fails it will return a different "code" in the JSON object.

Permissions

In order to view a row, the user must be granted the validate report template permission for the target table.

See also:: Permissions for the HTML Reports Module

REST API

POST Parameters

Parameter Name	Parameter Description	Example Input
`-table`	The name of the table on which the template is designed to run.	transactions
`-action=htmlreports_validate_template`	Specifies this action	N/A
`--template`	The HTML for the template that is being validated.	<h1>My Template</h1>

Return Type

This handler will return a text/json response containing a JSON data with the following keys:

Key	Description	Possible Values
code	The response code	200 for success. Some other value for an error or failure
message	The response message	"Template validation was successful. No errors found."

Definition at line 73 of file htmlreports_validate_template.php.

Member Function Documentation

handle ( $ params )

Definition at line 74 of file htmlreports_validate_template.php.

out ( $ params )

Definition at line 116 of file htmlreports_validate_template.php.

The documentation for this class was generated from the following file:

actions/htmlreports_validate_template.php