sspmod_core_Auth_Process_StatisticsWithAttribute Class Reference

Inheritance diagram for sspmod_core_Auth_Process_StatisticsWithAttribute:

Collaboration diagram for sspmod_core_Auth_Process_StatisticsWithAttribute:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	process (&$state)
	Log line. More...
Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...
	process (&$request)
	Process a request. More...

Private Member Functions
	setIdentifier ($direction, $state)

Private Attributes
	$attribute = null
	$typeTag = 'saml20-idp-SSO'
	$skipPassive = false

Additional Inherited Members
Data Fields inherited from SimpleSAML_Auth_ProcessingFilter
	$priority = 50
	Priority of this filter. More...

Detailed Description

Definition at line 9 of file StatisticsWithAttribute.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_StatisticsWithAttribute::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

array	$config	Configuration information about this filter.
mixed	$reserved	For future use.

Definition at line 34 of file StatisticsWithAttribute.php.

References $config.

    {
        parent::__construct($config, $reserved);

        assert(is_array($config));

        if (array_key_exists('attributename', $config)) {
            $this->attribute = $config['attributename'];
            if (!is_string($this->attribute)) {
                throw new Exception('Invalid attribute name given to core:StatisticsWithAttribute filter.');
            }
        }

        if (array_key_exists('type', $config)) {
            $this->typeTag = $config['type'];
            if (!is_string($this->typeTag)) {
                throw new Exception('Invalid typeTag given to core:StatisticsWithAttribute filter.');
            }
        }

        if (array_key_exists('skipPassive', $config)) {
            $this->skipPassive = (bool) $config['skipPassive'];
        }
    }

Member Function Documentation

process()

sspmod_core_Auth_Process_StatisticsWithAttribute::process

(

&

$state

)

Log line.

Parameters

array

&$state

The current state.

Definition at line 65 of file StatisticsWithAttribute.php.

References $attribute, $source, $state, setIdentifier(), and SimpleSAML\Logger\stats().

    {
        assert(is_array($state));
        assert(array_key_exists('Attributes', $state));

        $logAttribute = 'NA';
        $isPassive = '';

        if (array_key_exists('isPassive', $state) && $state['isPassive'] === true) {
            if ($this->skipPassive === true) {
                // We have a passive request. Skip logging statistics
                return;
            }
            $isPassive = 'passive-';
        }

        if (array_key_exists($this->attribute, $state['Attributes'])) {
            $logAttribute = $state['Attributes'][$this->attribute][0];
        }

        $source = $this->setIdentifier('Source', $state);
        $dest = $this->setIdentifier('Destination', $state);

        if (!array_key_exists('PreviousSSOTimestamp', $state)) {
            // The user hasn't authenticated with this SP earlier in this session
            SimpleSAML\Logger::stats($isPassive.$this->typeTag.'-first '.$dest.' '.$source.' '. $logAttribute);
        }

        SimpleSAML\Logger::stats($isPassive.$this->typeTag.' '.$dest.' '.$source.' '.$logAttribute);
        }

Here is the call graph for this function:

setIdentifier()

sspmod_core_Auth_Process_StatisticsWithAttribute::setIdentifier (   $direction,   $state  )

private

Parameters

string	&$direction	Either 'Source' or 'Destination'.
array	$state	The current state.

Returns

string

Definition at line 102 of file StatisticsWithAttribute.php.

References $state.

Referenced by process().

    {
        if (array_key_exists($direction, $state)) {
            if (isset($state[$direction]['core:statistics-id'])) {
                return $state[$direction]['core:statistics-id'];
            } else {
                return $state[$direction]['entityid'];
            }
        }
        return 'NA';
    }

Here is the caller graph for this function:

Field Documentation

$attribute

sspmod_core_Auth_Process_StatisticsWithAttribute::$attribute = null

private

Definition at line 15 of file StatisticsWithAttribute.php.

Referenced by process().

$skipPassive

sspmod_core_Auth_Process_StatisticsWithAttribute::$skipPassive = false

private

Definition at line 25 of file StatisticsWithAttribute.php.

$typeTag

sspmod_core_Auth_Process_StatisticsWithAttribute::$typeTag = 'saml20-idp-SSO'

private

Definition at line 20 of file StatisticsWithAttribute.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/core/lib/Auth/Process/StatisticsWithAttribute.php