HttpApiEvent_options Class Reference

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

Inheritance diagram for HttpApiEvent_options:
Summary_options Report_options

Public Member Functions

 __construct ($options=false)
 Select report options' properties to include and adjust them for the HTTP API.
 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 Member Functions

static discover_options ($input=false)
 Listen for "http api" options/properties, instead of "report" options.

Data Fields

const MAX_EVENTS = 10000
 Pagination limit for events retrieved from HTTP API.

Static Public Attributes

static $http_api_options
 Means to translate options back and forth between Report_options terms and HTTP API parameters.

Protected Member Functions

 validate_value ($key, &$value)

Detailed Description

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


Constructor & Destructor Documentation

HttpApiEvent_options::__construct ( options = false  ) 

Select report options' properties to include and adjust them for the HTTP API.

Parameters:
$options array = false

Reimplemented from Report_options.


Member Function Documentation

static HttpApiEvent_options::discover_options ( input = false  )  [static]

Listen for "http api" options/properties, instead of "report" options.

Parameters:
$input array = false
Returns:
array

Reimplemented from Report_options.

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

Not as forgiving as the parent.

(Why is parent forgiving?)

Parameters:
$options array
Exceptions:
Api_Error_Response 

Reimplemented from Report_options.

HttpApiEvent_options::to_output ( row  ) 

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

Parameters:
$row array
Returns:
array
HttpApiEvent_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.


Field Documentation

HttpApiEvent_options::$http_api_options [static]

Means to translate options back and forth between Report_options terms and HTTP API parameters.

Handles both input and output translation.

Pagination limit for events retrieved from HTTP API.

Hardcoded, deal with it


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

Generated on 4 Apr 2014 for ninja by  doxygen 1.6.1