SimpleSAML_Stats Class Reference

Collaboration diagram for SimpleSAML_Stats:

Static Public Member Functions
static	log ($event, array $data=array())
	Notify about an event. More...

Static Private Member Functions
static	createOutput (SimpleSAML_Configuration $config)
	Create an output from a configuration object. More...
static	initOutputs ()
	Initialize the outputs. More...

Static Private Attributes
static	$initialized = false
static	$outputs = null

Detailed Description

Definition at line 11 of file Stats.php.

Member Function Documentation

createOutput()

static SimpleSAML_Stats::createOutput ( SimpleSAML_Configuration  $config )

staticprivate

Create an output from a configuration object.

Parameters

SimpleSAML_Configuration

$config

The configuration object.

Returns

mixed A new instance of the configured class.

Definition at line 37 of file Stats.php.

References Sabre\VObject\$output, SimpleSAML_Configuration\getString(), and SimpleSAML\Module\resolveClass().

    {
        $cls = $config->getString('class');
        $cls = SimpleSAML\Module::resolveClass($cls, 'Stats_Output', 'SimpleSAML_Stats_Output');

        $output = new $cls($config);
        return $output;
    }

Here is the call graph for this function:

initOutputs()

static SimpleSAML_Stats::initOutputs ( )

staticprivate

Initialize the outputs.

Definition at line 50 of file Stats.php.

References $cfg, $config, and SimpleSAML_Configuration\getInstance().

    {

        $config = SimpleSAML_Configuration::getInstance();
        $outputCfgs = $config->getConfigList('statistics.out', array());

        self::$outputs = array();
        foreach ($outputCfgs as $cfg) {
            self::$outputs[] = self::createOutput($cfg);
        }
    }

Here is the call graph for this function:

log()

static SimpleSAML_Stats::log (   $event, array  $data = array()  )

static

Notify about an event.

Parameters

string	$event	The event.
array	$data	Event data. Optional.

Returns

void|boolean False if output is not enabled, void otherwise.

Definition at line 71 of file Stats.php.

References $data, and $out.

Referenced by sspmod_saml_IdP_SAML2\handleAuthError(), sspmod_consent_Auth_Process_Consent\process(), sspmod_saml_IdP_SAML1\receiveAuthnRequest(), sspmod_saml_IdP_SAML2\receiveAuthnRequest(), sspmod_saml_IdP_SAML2\receiveLogoutMessage(), sspmod_saml_IdP_SAML2\sendLogoutRequest(), sspmod_saml_IdP_SAML2\sendLogoutResponse(), sspmod_saml_IdP_SAML1\sendResponse(), and sspmod_saml_IdP_SAML2\sendResponse().

    {
        assert(is_string($event));
        assert(!isset($data['op']));
        assert(!isset($data['time']));
        assert(!isset($data['_id']));

        if (!self::$initialized) {
            self::initOutputs();
            self::$initialized = true;
        }

        if (empty(self::$outputs)) {
            // not enabled
            return;
        }

        $data['op'] = $event;
        $data['time'] = microtime(true);

        // the ID generation is designed to cluster IDs related in time close together
        $int_t = (int) $data['time'];
        $hd = openssl_random_pseudo_bytes(16);
        $data['_id'] = sprintf('%016x%s', $int_t, bin2hex($hd));

        foreach (self::$outputs as $out) {
            $out->emit($data);
        }
    }

Here is the caller graph for this function:

Field Documentation

$initialized

SimpleSAML_Stats::$initialized = false

staticprivate

Definition at line 19 of file Stats.php.

$outputs

SimpleSAML_Stats::$outputs = null

staticprivate

Definition at line 27 of file Stats.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Stats.php