Summary_options Class Reference

Report options for all kinds of Summary reports. More...

Inheritance diagram for Summary_options:
Report_options Alert_history_options Histogram_options HttpApiEvent_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.

Data Fields

const RECENT_ALERTS = 1
 A summary that lists alerts from newest to oldest.
const ALERT_TOTALS = 2
 A summary that displays which ones and how many alerts each object has retrieved.
const TOP_ALERT_PRODUCERS = 3
 A summary that displays a top list of the most frequently alerting objects.

Static Public Attributes

static $type = 'summary'
 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

 set_alert_types (&$name, $value, $obj)
 Convert uses of the old alert_types property so that all host states are excluded if the user provides the "service states only" option, and the other way around.
 update_value ($name, $value)
 Will actually set the provided $name to the value $value.
 calculate_time ($report_period)
 Calculates $this['start_time'] and $this['end_time'] based on an availability report style period such as "today", "last24hours" or "lastmonth".

Detailed Description

Report options for all kinds of Summary reports.


Member Function Documentation

Summary_options::calculate_time ( report_period  )  [protected]

Calculates $this['start_time'] and $this['end_time'] based on an availability report style period such as "today", "last24hours" or "lastmonth".

Parameters:
$report_period The textual period to set our options by
Returns:
false on errors, true on success

Reimplemented from Report_options.

Summary_options::update_value ( name,
value 
) [protected]

Will actually set the provided $name to the value $value.

Warning: you probably want to use set() or utilize the ArrayAccess API

Reimplemented from Report_options.

Reimplemented in Histogram_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