sspmod_statistics_Statistics_Rulesets_BaseRule Class Reference

Inheritance diagram for sspmod_statistics_Statistics_Rulesets_BaseRule:

Collaboration diagram for sspmod_statistics_Statistics_Rulesets_BaseRule:

Public Member Functions
	__construct ($statconfig, $ruleconfig, $ruleid, $available)
	Constructor. More...
	getRuleID ()
	availableTimeRes ()
	availableFileSlots ($timeres)
	getTimeNavigation ($timeres, $preferTime)
	getDataSet ($preferTimeRes, $preferTime)

Protected Member Functions
	resolveTimeRes ($preferTimeRes)
	resolveFileSlot ($timeres, $preferTime)

Protected Attributes
	$statconfig
	$ruleconfig
	$ruleid
	$available

Detailed Description

Definition at line 6 of file BaseRule.php.

Constructor & Destructor Documentation

__construct()

sspmod_statistics_Statistics_Rulesets_BaseRule::__construct	(		$statconfig,
			$ruleconfig,
			$ruleid,
			$available
	)

Constructor.

Definition at line 16 of file BaseRule.php.

References $available, $ruleconfig, $ruleid, and $statconfig.

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

        $this->available = null;
        if (array_key_exists($ruleid, $available)) {
            $this->available = $available[$ruleid];     
        }
    }

Member Function Documentation

availableFileSlots()

sspmod_statistics_Statistics_Rulesets_BaseRule::availableFileSlots

(

$timeres

)

Definition at line 46 of file BaseRule.php.

References $timeres, and sspmod_statistics_DateHandler\prettyHeader().

    {
        $timeresConfigs = $this->statconfig->getValue('timeres');
        $timeresConfig = $timeresConfigs[$timeres];

        if (isset($timeresConfig['customDateHandler']) && $timeresConfig['customDateHandler'] == 'month') {
            $datehandler = new sspmod_statistics_DateHandlerMonth(0);
        } else {
            $datehandler = new sspmod_statistics_DateHandler($this->statconfig->getValue('offset', 0));
        }

        /*
         * Get list of avaiable times in current file (rule)
         */
        $available_times = array(); 
        foreach ($this->available[$timeres] as $slot) {
            $available_times[$slot] = $datehandler->prettyHeader($slot, $slot + 1, $timeresConfig['fileslot'], $timeresConfig['dateformat-period']);
        }
        return $available_times;
    }

Here is the call graph for this function:

availableTimeRes()

sspmod_statistics_Statistics_Rulesets_BaseRule::availableTimeRes

(

)

Definition at line 35 of file BaseRule.php.

                                       {
        $timeresConfigs = $this->statconfig->getValue('timeres');
        $available_times = array(); 
        foreach ($timeresConfigs as $tres => $tresconfig) {
            if (array_key_exists($tres, $this->available)) {
                $available_times[$tres] = $tresconfig['name'];
            }
        }
        return $available_times;
    }

getDataSet()

sspmod_statistics_Statistics_Rulesets_BaseRule::getDataSet	(		$preferTimeRes,
			$preferTime
	)

Definition at line 111 of file BaseRule.php.

References $fileslot, $preferTime, $preferTimeRes, $timeres, resolveFileSlot(), and resolveTimeRes().

    {
        $timeres = $this->resolveTimeRes($preferTimeRes);
        $fileslot = $this->resolveFileSlot($timeres, $preferTime);
        $dataset = new sspmod_statistics_StatDataset($this->statconfig, $this->ruleconfig, $this->ruleid, $timeres, $fileslot);
        return $dataset;
    }

Here is the call graph for this function:

getRuleID()

sspmod_statistics_Statistics_Rulesets_BaseRule::getRuleID

(

)

Definition at line 30 of file BaseRule.php.

References $ruleid.

    {
        return $this->ruleid;
    }

getTimeNavigation()

sspmod_statistics_Statistics_Rulesets_BaseRule::getTimeNavigation	(		$timeres,
			$preferTime
	)

Definition at line 90 of file BaseRule.php.

References $fileslot, $preferTime, $timeres, and resolveFileSlot().

    {
        $fileslot = $this->resolveFileSlot($timeres, $preferTime);

        // Extract previous and next time slots...
        $available_times_prev = null;
        $available_times_next = null;

        $timeslots = array_values($this->available[$timeres]);
        sort($timeslots, SORT_NUMERIC);
        $timeslotindex = array_flip($timeslots);

        if ($timeslotindex[$fileslot] > 0) {
            $available_times_prev = $timeslots[$timeslotindex[$fileslot] - 1];
        }
        if ($timeslotindex[$fileslot] < (count($timeslotindex) - 1)) {
            $available_times_next = $timeslots[$timeslotindex[$fileslot] + 1];
        }
        return array('prev' => $available_times_prev, 'next' => $available_times_next);
    }

Here is the call graph for this function:

resolveFileSlot()

sspmod_statistics_Statistics_Rulesets_BaseRule::resolveFileSlot (   $timeres,   $preferTime  )

protected

Definition at line 79 of file BaseRule.php.

References $fileslot, $preferTime, and $timeres.

Referenced by getDataSet(), and getTimeNavigation().

    {
        // Get which time (fileslot) to use.. First get a default, which is the most recent one.
        $fileslot = $this->available[$timeres][count($this->available[$timeres]) - 1];
        // Then check if the user have provided one.
        if (in_array($preferTime, $this->available[$timeres], true)) {
            $fileslot = $preferTime;
        }
        return $fileslot;
    }

Here is the caller graph for this function:

resolveTimeRes()

sspmod_statistics_Statistics_Rulesets_BaseRule::resolveTimeRes (   $preferTimeRes )

protected

Definition at line 67 of file BaseRule.php.

References $preferTimeRes, and $timeres.

Referenced by getDataSet().

    {
        $timeresavailable = array_keys($this->available);
        $timeres = $timeresavailable[0];

        // Then check if the user have provided one that is valid
        if (in_array($preferTimeRes, $timeresavailable, true)) {
            $timeres = $preferTimeRes;
        }
        return $timeres;
    }

Here is the caller graph for this function:

Field Documentation

$available

sspmod_statistics_Statistics_Rulesets_BaseRule::$available

protected

Definition at line 11 of file BaseRule.php.

Referenced by sspmod_statistics_Statistics_Rulesets_Ratio\__construct(), and __construct().

$ruleconfig

sspmod_statistics_Statistics_Rulesets_BaseRule::$ruleconfig

protected

Definition at line 9 of file BaseRule.php.

Referenced by sspmod_statistics_Statistics_Rulesets_Ratio\__construct(), and __construct().

$ruleid

sspmod_statistics_Statistics_Rulesets_BaseRule::$ruleid

protected

Definition at line 10 of file BaseRule.php.

Referenced by sspmod_statistics_Statistics_Rulesets_Ratio\__construct(), __construct(), and getRuleID().

$statconfig

sspmod_statistics_Statistics_Rulesets_BaseRule::$statconfig

protected

Definition at line 8 of file BaseRule.php.

Referenced by sspmod_statistics_Statistics_Rulesets_Ratio\__construct(), and __construct().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/statistics/lib/Statistics/Rulesets/BaseRule.php