sspmod_statistics_StatDataset Class Reference

Inheritance diagram for sspmod_statistics_StatDataset:

Collaboration diagram for sspmod_statistics_StatDataset:

Public Member Functions
	__construct ($statconfig, $ruleconfig, $ruleid, $timeres, $fileslot)
	Constructor. More...
	getFileSlot ()
	getTimeRes ()
	setDelimiter ($delimiter='_')
	getDelimiter ()
	calculateMax ()
	getDebugData ()
	aggregateSummary ()
	getTopDelimiters ()
	availDelimiters ()
	getPieData ()
	getMax ()
	getSummary ()
	getResults ()
	getAxis ()
	getPercentValues ()
	getDelimiterPresentation ()
	getDelimiterPresentationPie ()
	loadData ()

Protected Attributes
	$statconfig
	$ruleconfig
	$timeresconfig
	$ruleid
	$fileslot
	$timeres
	$delimiter
	$results
	$summary
	$max
	$datehandlerFile
	$datehandlerTick

Detailed Description

Definition at line 8 of file StatDataset.php.

Constructor & Destructor Documentation

__construct()

sspmod_statistics_StatDataset::__construct	(		$statconfig,
			$ruleconfig,
			$ruleid,
			$timeres,
			$fileslot
	)

Constructor.

Definition at line 30 of file StatDataset.php.

References $datehandlerTick, $fileslot, $ruleconfig, $ruleid, $statconfig, $timeres, and loadData().

    {
        assert($statconfig instanceof SimpleSAML_Configuration);
        assert($ruleconfig instanceof SimpleSAML_Configuration);
        $this->statconfig = $statconfig;
        $this->ruleconfig = $ruleconfig;

        $timeresconfigs = $statconfig->getConfigItem('timeres');
        $this->timeresconfig = $timeresconfigs->getConfigItem($timeres);

        $this->ruleid = $ruleid;
        $this->fileslot = $fileslot;
        $this->timeres = $timeres;

        $this->delimiter = '_';
        $this->max = 0;

        $this->datehandlerTick = new sspmod_statistics_DateHandler($this->statconfig->getValue('offset', 0));
        if ($this->timeresconfig->getValue('customDateHandler', 'default') === 'month') {
            $this->datehandlerFile = new sspmod_statistics_DateHandlerMonth(0);
        } else {
            $this->datehandlerFile = $this->datehandlerTick;
        }

        $this->loadData();
    }

Here is the call graph for this function:

Member Function Documentation

aggregateSummary()

sspmod_statistics_StatDataset::aggregateSummary

(

)

Definition at line 111 of file StatDataset.php.

References $key, and $res.

    {
        // aggregate summary table from dataset. To be used in the table view
        $this->summary = array();
        foreach ($this->results as $slot => $res) {
            foreach ($res as $key => $value) {
                if (array_key_exists($key, $this->summary)) {
                    $this->summary[$key] += $value;
                } else {
                    $this->summary[$key] = $value;
                }
            }
        }
        asort($this->summary);
        $this->summary = array_reverse($this->summary, true);
    }

availDelimiters()

sspmod_statistics_StatDataset::availDelimiters

(

)

Definition at line 145 of file StatDataset.php.

References $key.

Referenced by getDelimiterPresentation().

    {
        $availDelimiters = array();
        foreach ($this->summary as $key => $value) {
            $availDelimiters[$key] = 1;
        }
        return array_keys($availDelimiters);
    }

Here is the caller graph for this function:

calculateMax()

sspmod_statistics_StatDataset::calculateMax

(

)

Definition at line 83 of file StatDataset.php.

References $delimiter, $res, and sspmod_statistics_Graph_GoogleCharts\roof().

    {
        $maxvalue = 0;
        foreach ($this->results as $slot => &$res) {
            if (!array_key_exists($this->delimiter, $res)) {
                $res[$this->delimiter] = 0;
            }
            $maxvalue = max($res[$this->delimiter], $maxvalue);
        }
        $this->max = sspmod_statistics_Graph_GoogleCharts::roof($maxvalue);
    }

Here is the call graph for this function:

getAxis()

sspmod_statistics_StatDataset::getAxis

(

)

Definition at line 183 of file StatDataset.php.

References $axis, $i, and $res.

    {
        $slotsize = $this->timeresconfig->getValue('slot');
        $dateformat_intra = $this->timeresconfig->getValue('dateformat-intra');
        $axislabelint = $this->timeresconfig->getValue('axislabelint');

        $axis = array();
        $axispos = array();
        $xentries = count($this->results);
        $lastslot = 0;
        $i = 0;

        foreach ($this->results as $slot => $res) {
            // check if there should be an axis here...
            if ($slot % $axislabelint == 0) {
                $axis[] = $this->datehandlerTick->prettyDateSlot($slot, $slotsize, $dateformat_intra);
                $axispos[] = (($i) / ($xentries - 1));
            }
            $lastslot = $slot;
            $i++;
        }

        $axis[] = $this->datehandlerTick->prettyDateSlot($lastslot + 1, $slotsize, $dateformat_intra);

        return array('axis' => $axis, 'axispos' => $axispos);
    }

getDebugData()

sspmod_statistics_StatDataset::getDebugData

(

)

Definition at line 95 of file StatDataset.php.

References $delimiter, and $res.

    {
        $debugdata = array();

        $slotsize = $this->timeresconfig->getValue('slot');
        $dateformat_intra = $this->timeresconfig->getValue('dateformat-intra');

        foreach ($this->results as $slot => &$res) {
            $debugdata[$slot] = array(
                $this->datehandlerTick->prettyDateSlot($slot, $slotsize, $dateformat_intra),
                $res[$this->delimiter]
            );
        }
        return $debugdata;
    }

getDelimiter()

sspmod_statistics_StatDataset::getDelimiter

(

)

Definition at line 75 of file StatDataset.php.

References $delimiter.

    {
        if ($this->delimiter === '_') {
            return null;
        }
        return $this->delimiter;
    }

getDelimiterPresentation()

sspmod_statistics_StatDataset::getDelimiterPresentation

(

)

Definition at line 233 of file StatDataset.php.

References $config, $t, availDelimiters(), SimpleSAML_Configuration\getInstance(), and SimpleSAML\Module\resolveClass().

Referenced by getDelimiterPresentationPie().

    {
        $config = SimpleSAML_Configuration::getInstance();
        $t = new SimpleSAML_XHTML_Template($config, 'statistics:statistics.tpl.php');

        $availdelimiters = $this->availDelimiters();

        // create a delimiter presentation filter for this rule...
        if ($this->ruleconfig->hasValue('fieldPresentation')) {
            $fieldpresConfig = $this->ruleconfig->getConfigItem('fieldPresentation');
            $classname = SimpleSAML\Module::resolveClass(
                $fieldpresConfig->getValue('class'),
                'Statistics_FieldPresentation'
            );
            if (!class_exists($classname)) {
                throw new Exception('Could not find field presentation plugin ['.$classname.']: No class found');
            }
            $presentationHandler = new $classname($availdelimiters, $fieldpresConfig->getValue('config'), $t);

            return $presentationHandler->getPresentation();
        }

        return array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDelimiterPresentationPie()

sspmod_statistics_StatDataset::getDelimiterPresentationPie

(

)

Definition at line 258 of file StatDataset.php.

References $key, getDelimiterPresentation(), and getTopDelimiters().

    {
        $topdelimiters = $this->getTopDelimiters();
        $delimiterPresentation = $this->getDelimiterPresentation();

        $pieaxis = array();
        foreach ($topdelimiters as $key) {
            $keyName = $key;
            if (array_key_exists($key, $delimiterPresentation)) {
                $keyName = $delimiterPresentation[$key];
            }
            $pieaxis[] = $keyName;
        }
        $pieaxis[] = 'Others';
        return $pieaxis;
    }

Here is the call graph for this function:

getFileSlot()

sspmod_statistics_StatDataset::getFileSlot

(

)

Definition at line 57 of file StatDataset.php.

References $fileslot.

    {
        return $this->fileslot;
    }

getMax()

sspmod_statistics_StatDataset::getMax

(

)

Definition at line 168 of file StatDataset.php.

References $max.

    {
        return $this->max;
    }

getPercentValues()

sspmod_statistics_StatDataset::getPercentValues

(

)

Definition at line 213 of file StatDataset.php.

References $i, and $res.

    {
        $i = 0;
        $dataset = array();
        foreach ($this->results as $slot => $res) {
            if (array_key_exists($this->delimiter, $res)) {
                if ($res[$this->delimiter] === null) {
                    $dataset[] = -1;
                } else {
                    $dataset[] = number_format(100 * $res[$this->delimiter] / $this->max, 2);
                }
            } else {
                $dataset[] = '0';
            }
            $i++;
        }

        return $dataset;
    }

getPieData()

sspmod_statistics_StatDataset::getPieData

(

)

Definition at line 154 of file StatDataset.php.

References $piedata, and getTopDelimiters().

    {
        $piedata = array();
        $sum = 0;
        $topdelimiters = $this->getTopDelimiters();

        foreach ($topdelimiters as $td) {
            $sum += $this->summary[$td];
            $piedata[] = number_format(100 * $this->summary[$td] / $this->summary['_'], 2);
        }
        $piedata[] = number_format(100 - 100 * ($sum / $this->summary['_']), 2);
        return $piedata;
    }

Here is the call graph for this function:

getResults()

sspmod_statistics_StatDataset::getResults

(

)

Definition at line 178 of file StatDataset.php.

References $results.

    {
        return $this->results;
    }

getSummary()

sspmod_statistics_StatDataset::getSummary

(

)

Definition at line 173 of file StatDataset.php.

References $summary.

    {
        return $this->summary;
    }

getTimeRes()

sspmod_statistics_StatDataset::getTimeRes

(

)

Definition at line 62 of file StatDataset.php.

References $timeres.

    {
        return $this->timeres;
    }

getTopDelimiters()

sspmod_statistics_StatDataset::getTopDelimiters

(

)

Definition at line 128 of file StatDataset.php.

References $i, and $key.

Referenced by getDelimiterPresentationPie(), and getPieData().

    {
        // create a list of delimiter keys that has the highest total summary in this period
        $topdelimiters = array();
        $maxdelimiters = 4;
        $i = 0;
        foreach ($this->summary as $key => $value) {
            if ($key !== '_') {
                $topdelimiters[] = $key;
            }
            if ($i++ >= $maxdelimiters) {
                break;
            }
        }
        return $topdelimiters;
    }

Here is the caller graph for this function:

loadData()

sspmod_statistics_StatDataset::loadData

(

)

Definition at line 275 of file StatDataset.php.

References $i, $rule, and SimpleSAML\Utils\Arrays\arrayize().

Referenced by __construct().

    {
        $statdir = $this->statconfig->getValue('statdir');
        $resarray = array();
        $rules = SimpleSAML\Utils\Arrays::arrayize($this->ruleid);
        foreach ($rules as $rule) {
            // Get file and extract results.
            $resultFileName = $statdir.'/'.$rule.'-'.$this->timeres.'-'.$this->fileslot.'.stat';
            if (!file_exists($resultFileName)) {
                throw new Exception('Aggregated statitics file ['.$resultFileName.'] not found.');
            }
            if (!is_readable($resultFileName)) {
                throw new Exception('Could not read statitics file ['.$resultFileName.']. Bad file permissions?');
            }
            $resultfile = file_get_contents($resultFileName);
            $newres = unserialize($resultfile);
            if (empty($newres)) {
                throw new Exception('Aggregated statistics in file ['.$resultFileName.'] was empty.');
            }
            $resarray[] = $newres;
        }

        $combined = $resarray[0];
        $count = count($resarray);
        if ($count > 1) {
            for ($i = 1; $i < $count; $i++) {
                $combined = $this->combine($combined, $resarray[$i]);
            }
        }
        $this->results = $combined;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDelimiter()

sspmod_statistics_StatDataset::setDelimiter

(

$delimiter = '_'

)

Definition at line 67 of file StatDataset.php.

References $delimiter.

    {
        if (empty($delimiter)) {
            $delimiter = '_';
        }
        $this->delimiter = $delimiter;
    }

Field Documentation

$datehandlerFile

sspmod_statistics_StatDataset::$datehandlerFile

protected

Definition at line 23 of file StatDataset.php.

$datehandlerTick

sspmod_statistics_StatDataset::$datehandlerTick

protected

Definition at line 24 of file StatDataset.php.

Referenced by __construct().

$delimiter

sspmod_statistics_StatDataset::$delimiter

protected

Definition at line 18 of file StatDataset.php.

Referenced by calculateMax(), getDebugData(), getDelimiter(), and setDelimiter().

$fileslot

sspmod_statistics_StatDataset::$fileslot

protected

Definition at line 15 of file StatDataset.php.

Referenced by __construct(), and getFileSlot().

$max

sspmod_statistics_StatDataset::$max

protected

Definition at line 21 of file StatDataset.php.

Referenced by getMax().

$results

sspmod_statistics_StatDataset::$results

protected

Definition at line 19 of file StatDataset.php.

Referenced by getResults().

$ruleconfig

sspmod_statistics_StatDataset::$ruleconfig

protected

Definition at line 11 of file StatDataset.php.

Referenced by __construct().

$ruleid

sspmod_statistics_StatDataset::$ruleid

protected

Definition at line 13 of file StatDataset.php.

Referenced by __construct().

$statconfig

sspmod_statistics_StatDataset::$statconfig

protected

Definition at line 10 of file StatDataset.php.

Referenced by __construct().

$summary

sspmod_statistics_StatDataset::$summary

protected

Definition at line 20 of file StatDataset.php.

Referenced by getSummary().

$timeres

sspmod_statistics_StatDataset::$timeres

protected

Definition at line 16 of file StatDataset.php.

Referenced by __construct(), and getTimeRes().

$timeresconfig

sspmod_statistics_StatDataset::$timeresconfig

protected

Definition at line 12 of file StatDataset.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/statistics/lib/StatDataset.php