HttpApiState_options Class Reference

The report options for the State type of reports in the HTTP API. More...

Inheritance diagram for HttpApiState_options:
Report_options

Public Member Functions

 setup_properties ()
 Properties should be completely setup - with translations and all - before loading any options, and options are loaded by the construct, so do initialization here.
 format_default ($value, $type)
 set_options ($options)
 Not as forgiving as the parent.
 to_output ($row)
 Final step in the "from merlin.report_data row to API-output" process.

Static Public Attributes

static $type = 'httpapistate'
 A name for this report type that doesn't rely on splitting class_name() by _ This is used when saving the report.

Protected Member Functions

 validate_value ($key, &$value)

Detailed Description

The report options for the State type of reports in the HTTP API.


Member Function Documentation

HttpApiState_options::format_default ( value,
type 
)
Parameters:
$value mixed
$type string
Returns:
string
HttpApiState_options::set_options ( options  ) 

Not as forgiving as the parent.

(Why is parent forgiving?)

Parameters:
$options array
Exceptions:
ReportValidationException 

Reimplemented from Report_options.

HttpApiState_options::to_output ( row  ) 

Final step in the "from merlin.report_data row to API-output" process.

Parameters:
$row array
Returns:
array
HttpApiState_options::validate_value ( key,
&$  value 
) [protected]
Todo:
be able to throw exceptions here to give feedback of *which* error we experienced, since, you know, there's at least one user (you) exposed to this API.. Help yourself
Parameters:
$key string
$value mixed
Returns:
boolean

Reimplemented from Report_options.


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

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1