+ // rrdstat PHP class
+ // rrdtool statistics functions
+ //
+ // function __construct($rrdconfig, [$conf_id])
+ // CONSTRUCTOR
+ // if $conf_id is set, $rrdconfig is a total configuration set
+ // else it's the configuration for this one RRD
+ // currently only a config array is supported, XML config is planned
+ //
+ // private $rrdtool_bin
+ // RRDtool binary to use
+ //
+ // private $rrd_file
+ // RRD file name
+ //
+ // private $basename
+ // base name for this RRD (usually file name without .rrd)
+ //
+ // private $basedir
+ // base directory for this RRD (with a trailing slash)
+ // note that $rrd_file usually includes that path as well, but graph directory gets based on this value
+ //
+ // private $config_all
+ // complete, raw configuration array set
+ //
+ // private $config_raw
+ // configuration array set for current RRD
+ //
+ // private $config_graph
+ // configuration array set for default graph in this RRD
+ //
+ // private $config_page
+ // configuration array set for default page in this RRD
+ //
+ // private $rrd_fields
+ // definition of this RRD's fields
+ //
+ // private $rra_base
+ // definition of this RRD's base RRAs
+ //
+ // private $rrd_step
+ // basic stepping of this RRD in seconds (default: 300)
+ //
+ // private $rra_add_max
+ // should RRAs for MAX be added for every base RRA? (bool, default: true)
+ //
+ // private $status
+ // status of the RRD (unused/ok/readonly/graphonly)
+ // note that most functions require certain status values
+ // (e.g. update only works if status is ok, graph for ok/readonly/graphonly)
+ //
+ // private $mod_textdomain
+ // GNU gettext domain for this module
+ //
+ // private function set_def($rrdconfig, [$conf_id])
+ // set definitions based on given configuration
+ // [intended for internal use, called by the constructor]
+ //
+ // public function rrd_version() {
+ // get RRDtool version string
+ //
+ // public function create()
+ // create RRD file according to set config
+ //
+ // public function update([$upArray])
+ // feed new data into RRD (either use given array of values or use auto-update info from config)
+ //
+ // public function fetch([$cf] = 'AVERAGE', $resolution = null, $start = null, $end = null)
+ // fetch data from the defined RRD
+ // using given consolidation function [default is AVERAGE],
+ // resolution (seconds, default is the RRD's stepping),
+ // start and end times (unix epoch, defaults are the RRD's last update time)
+ //
+ // public function last_update()
+ // fetch time of last update in this RRD file
+ //
+ // public function graph([$timeframe], [$sub], [$extra])
+ // create a RRD graph (and return all meta info in a flat string)
+ // for given timeframe (day [default]/week/month/year),
+ // sub-graph ID (if given) and extra config options (if given)
+ //
+ // public function graph_plus([$timeframe], [$sub], [$extra])
+ // create a RRD graph (see above) and return meta info as a ready-to-use array
+ //
+ // public function page([$sub], [$page_extras], [$graph_extras])
+ // create a (HTML) page and return it in a string
+ // for given sub-page ID (if given, default is a simple HTML page)
+ // and extra page and graph config options (if given)
+ //
+ // public function simple_html([$sub], [$page_extras], [$graph_extras])
+ // create a simple (MRTG-like) HTML page and return it in a string
+ // XXX: this is here temporarily for compat only, it's preferred to use page()!
+ //
+ // private function page_index($pconf)
+ // create a bare, very simple index list HTML page and return it in a string
+ // using given page config options
+ // [intended for internal use, called by page()]
+ //
+ // private function page_overview($pconf, [$graph_extras])
+ // create an overview HTML page (including graphs) and return it in a string
+ // using given page config options and extra graph options (if given)
+ // [intended for internal use, called by page()]
+ //
+ // private function page_simple($pconf, [$graph_extras])
+ // create a simple (MRTG-like) HTML page and return it in a string
+ // using given page config options and extra graph options (if given)
+ // [intended for internal use, called by page()]
+ //
+ // private function h_page_statsArray($pconf)
+ // return array of stats to list on a page, using given page config options
+ // [intended for internal use, called by page_*()]
+ //
+ // private function h_page_footer()
+ // return generic page footer
+ // [intended for internal use, called by page_*()]
+ //
+ // private function text_quote($text)
+ // return a quoted/escaped text for use in rrdtool commandline text fields
+
+ private $rrdtool_bin = '/usr/bin/rrdtool';
+
+ private $rrd_file = null;
+ private $basename = null;
+ private $basedir = null;
+
+ private $config_all = null;
+ private $config_raw = null;
+ private $config_graph = null;
+ private $config_page = null;