sspmod_statistics_Ruleset Class Reference

Collaboration diagram for sspmod_statistics_Ruleset:

Public Member Functions
	__construct ($statconfig)
	Constructor. More...
	availableRules ()
	availableRulesNames ()
	getRule ($preferRule)

Private Member Functions
	init ()
	resolveSelectedRule ($preferRule=null)
	Resolve which rule is selected. More...

Private Attributes
	$statconfig
	$availrulenames
	$availrules
	$available

Detailed Description

Definition at line 6 of file Ruleset.php.

Constructor & Destructor Documentation

__construct()

sspmod_statistics_Ruleset::__construct

(

$statconfig

)

Constructor.

Definition at line 16 of file Ruleset.php.

    {
        $this->statconfig = $statconfig;
        $this->init();
    }

References $statconfig, and init().

Here is the call graph for this function:

Member Function Documentation

availableRules()

sspmod_statistics_Ruleset::availableRules

(

)

Definition at line 59 of file Ruleset.php.

    {
        return $this->availrules;
    }

References $availrules.

availableRulesNames()

sspmod_statistics_Ruleset::availableRulesNames

(

)

Definition at line 64 of file Ruleset.php.

    {
        return $this->availrulenames;
    }

References $availrulenames.

getRule()

sspmod_statistics_Ruleset::getRule

(

$preferRule

)

Definition at line 83 of file Ruleset.php.

    {
        $rule = $this->resolveSelectedRule($preferRule);
        $statrulesConfig = $this->statconfig->getConfigItem('statrules');
        $statruleConfig = $statrulesConfig->getConfigItem($rule);
 
        $presenterClass = SimpleSAML\Module::resolveClass($statruleConfig->getValue('presenter', 'statistics:BaseRule'), 'Statistics_Rulesets');
        $statrule = new $presenterClass($this->statconfig, $statruleConfig, $rule, $this->available);
        return $statrule;
    }

References $preferRule, $rule, $statrule, SimpleSAML\Module\resolveClass(), and resolveSelectedRule().

Here is the call graph for this function:

init()

sspmod_statistics_Ruleset::init ( )

private

Definition at line 22 of file Ruleset.php.

    {
        $statdir = $this->statconfig->getValue('statdir');
        $statrules = $this->statconfig->getValue('statrules');
        $timeres = $this->statconfig->getValue('timeres');
 
        /*
         * Walk through file lists, and get available [rule][fileslot]...
         */
        if (!is_dir($statdir)) {
            throw new Exception('Statisics output directory [' . $statdir . '] does not exists.');
        }
        $filelist = scandir($statdir);
        $this->available = array();
        foreach ($filelist as $file) {
        if (preg_match('/([a-z0-9_]+)-([a-z0-9_]+)-([0-9]+)\.stat/', $file, $matches)) {
            if (array_key_exists($matches[1], $statrules)) {
                if (array_key_exists($matches[2], $timeres)) 
                    $this->available[$matches[1]][$matches[2]][] = $matches[3];
                }
            }
        }
        if (empty($this->available)) {
            throw new Exception('No aggregated statistics files found in [' . $statdir . ']');
        }
 
        /*
         * Create array with information about available rules..
         */
        $this->availrules = array_keys($statrules);
        $available_rules = array();
        foreach ($this->availrules as $key) {
            $available_rules[$key] = array('name' => $statrules[$key]['name'], 'descr' => $statrules[$key]['descr']);
        }
        $this->availrulenames = $available_rules;
    }

References $key, and $timeres.

Referenced by __construct().

Here is the caller graph for this function:

resolveSelectedRule()

sspmod_statistics_Ruleset::resolveSelectedRule (   $preferRule = null )

private

Resolve which rule is selected.

Taking user preference and checks if it exists.

Definition at line 72 of file Ruleset.php.

    {
        $rule = $this->statconfig->getString('default', $this->availrules[0]);
        if (!empty($preferRule)) {
            if (in_array($preferRule, $this->availrules, true)) {
                $rule = $preferRule;
            }
        }
        return $rule;
    }

References $preferRule, and $rule.

Referenced by getRule().

Here is the caller graph for this function:

Field Documentation

$available

sspmod_statistics_Ruleset::$available

private

Definition at line 11 of file Ruleset.php.

$availrulenames

sspmod_statistics_Ruleset::$availrulenames

private

Definition at line 9 of file Ruleset.php.

Referenced by availableRulesNames().

$availrules

sspmod_statistics_Ruleset::$availrules

private

Definition at line 10 of file Ruleset.php.

Referenced by availableRules().

$statconfig

sspmod_statistics_Ruleset::$statconfig

private

Definition at line 8 of file Ruleset.php.

Referenced by __construct().

---

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

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