Xataface HTML Reports Module 0.2
HTML Reports Module for Xataface
Public Member Functions
actions_htmlreports_schemabrowser_preview_row Class Reference

HTTP handler to preview the data for a particular row of a table. More...

Public Member Functions

 handle ($params)
 out ($params)

Detailed Description

HTTP handler to preview the data for a particular row of a table.

This is used by the field browser to show hints to the user of what data is stored in each field.

See also:
Inserting a Field

Permissions

In order to view a row, the user must be granted both the view and export_json permissions for the record/row that is being requested. If they are not, then an error will be returned instead of the usual output.

REST API

POST Parameters

Parameter NameParameter DescriptionExample Input
-table The name of the table for which to return the schema transactions
-action=htmlreports_schemabrowser_preview_row Specifies this action N/A
Note:
Any request parameter conforming to Xataface's URL conventions may be used to help specify the result set that should be returned.

Return Type

This handler will return a text/json response containing a JSON data structure:

 {
    "code":200,
    "values":{
       "{$tool_id}":"1",
       "{$facility_id}":"Nanofabrication",
       "{$tool_name}":"Clean Room",
       "{$external_url}":"",
       "{$short_name}":"",
       "{$tool_type_id}":"Clean Room Access"
    }
 }

Error Output

If an error occurs, then this action will simply return a JSON data structure with the following keys:

  1. code - The Error code
  2. message - The error message

Definition at line 84 of file htmlreports_schemabrowser_preview_row.php.


Member Function Documentation

handle ( params)

Definition at line 85 of file htmlreports_schemabrowser_preview_row.php.

out ( params)

Definition at line 141 of file htmlreports_schemabrowser_preview_row.php.


The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Enumerations