Class Anemometer

Description

class Anemometer

This is the controller class for the Box Anemometer web application.

It is designed to closely resemble Codeigniter, so it can be easily added to a CI installation (untested.)

Public method represent controller actions, callable through the index.php

  • author: Gavin Towey <gavin@box.com> and Geoff Anderson <geoff@box.com>
  • license: please

Located in /Anemometer.php (line 21)


	
			
Method Summary
Anemometer __construct (type $conf)
void api ()
void graph_search ()
void index ()
void quicksearch ()
void report ()
void samples ()
void show_query ()
void upd_query ()
Methods
Constructor __construct (line 33)

Constructor. Pass in the global configuration object

Anemometer __construct (type $conf)
  • type $conf
api (line 53)

main method for getting report results. This method can be called as an ajax callback and return the raw data in json format, or it can display a table or graph directly. All other methods that get report results use this either directly or as an ajax call.

  • access: public
void api ()
graph_search (line 95)

Search by using a graph. A brief search form is shown to allow a graph to be built. Html table results that corespond to the time range of the graph is displayed below. Regions can be selected in the graph directly which will update the table results with the new time range.

  • access: public
void graph_search ()
index (line 136)

show the index page where users can select the datasource. If there's only

one, just redirect to the default report

  • access: public
void index ()
quicksearch (line 162)

Search for a checksum value. Redirect to show_query if it's found

or display an error message

  • access: public
void quicksearch ()
report (line 181)

Display the search form, and the report results (by default as a html table)

  • access: public
void report ()
samples (line 221)

Show query samples for a specific checksum

  • access: public
void samples ()
show_query (line 251)

Display a specific query from its checksum value

  • access: public
void show_query ()
upd_query (line 308)

Update the review and comments for a query by its checksum

  • access: public
void upd_query ()

Documentation generated on Mon, 12 Mar 2012 11:59:40 -0700 by phpDocumentor 1.4.4