1. class
  2. Khill
  3. Lavacharts
  4. Volcano

Volcano

class Volcano (View source)

Volcano Storage Class

Storage class that holds all defined charts and dashboards.

Methods

boolean
storeChart( Chart $chart)

Stores a chart in the volcano datastore.

boolean
storeDashboard( Dashboard $dashboard)

Stores a dashboard in the volcano datastore.

Chart
getChart( string $type, Label $label)

Retrieves a chart from the volcano datastore.

Dashboard
getDashboard( Label $label)

Retrieves a dashboard from the volcano datastore.

boolean
checkChart( string $type, Label $label)

Simple true/false test if a chart exists.

boolean
checkDashboard( Label $label)

Simple true/false test if a dashboard exists.

Details

at line 47
boolean storeChart( Chart $chart)

Stores a chart in the volcano datastore.

Parameters

Chart $chart Chart to store in the volcano.

Return Value

boolean

at line 60
boolean storeDashboard( Dashboard $dashboard)

Stores a dashboard in the volcano datastore.

Parameters

Dashboard $dashboard Dashboard to store in the volcano.

Return Value

boolean

at line 75
Chart getChart( string $type, Label $label)

Retrieves a chart from the volcano datastore.

Parameters

string $type Type of chart to store.
Label $label Identifying label for the chart.

Return Value

Chart

Exceptions

ChartNotFound

at line 91
Dashboard getDashboard( Label $label)

Retrieves a dashboard from the volcano datastore.

Parameters

Label $label Identifying label for the dashboard.

Return Value

Dashboard

Exceptions

DashboardNotFound

at line 107
boolean checkChart( string $type, Label $label)

Simple true/false test if a chart exists.

Parameters

string $type Type of chart to check.
Label $label Identifying label of a chart to check.

Return Value

boolean

at line 126
boolean checkDashboard( Label $label)

Simple true/false test if a dashboard exists.

Parameters

Label $label Identifying label of a chart to check.

Return Value

boolean