Inheritance diagram for sspmod_saml_Auth_Process_AttributeNameID:

Collaboration diagram for sspmod_saml_Auth_Process_AttributeNameID:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...

Public Member Functions inherited from sspmod_saml_BaseNameIDGenerator
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...

	process (&$state)
	Generate transient NameID. More...

Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...

	process (&$request)
	Process a request. More...

Protected Member Functions
	getValue (array &$state)
	Get the NameID value. More...

Protected Member Functions inherited from sspmod_saml_BaseNameIDGenerator
	getValue (array &$state)
	Get the NameID value. More...

Private Attributes
	$attribute

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

Protected Attributes inherited from sspmod_saml_BaseNameIDGenerator
	$format

Detailed Description

Definition at line 9 of file AttributeNameID.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_saml_Auth_Process_AttributeNameID::__construct	(	$config,
		$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Exceptions

SimpleSAML_Error_Exception If the required options 'Format' or 'attribute' are missing.

Definition at line 28 of file AttributeNameID.php.

References $config.

     {
         parent::__construct($config, $reserved);
         assert(is_array($config));
 
         if (!isset($config['Format'])) {
             throw new SimpleSAML_Error_Exception("AttributeNameID: Missing required option 'Format'.");
         }
         $this->format = (string) $config['Format'];
 
         if (!isset($config['attribute'])) {
             throw new SimpleSAML_Error_Exception("AttributeNameID: Missing required option 'attribute'.");
         }
         $this->attribute = (string) $config['attribute'];
     }

Member Function Documentation

◆ getValue()

sspmod_saml_Auth_Process_AttributeNameID::getValue ( array & $state )

protected

Get the NameID value.

Parameters

array $state The state array.

Returns: string|null The NameID value.

Definition at line 51 of file AttributeNameID.php.

References SimpleSAML\Logger\warning().

     {
 
         if (!isset($state['Attributes'][$this->attribute]) || count($state['Attributes'][$this->attribute]) === 0) {
             SimpleSAML\Logger::warning(
                 'Missing attribute '.var_export($this->attribute, true).
                 ' on user - not generating attribute NameID.'
             );
             return null;
         }
         if (count($state['Attributes'][$this->attribute]) > 1) {
             SimpleSAML\Logger::warning(
                 'More than one value in attribute '.var_export($this->attribute, true).
                 ' on user - not generating attribute NameID.'
             );
             return null;
         }
         $value = array_values($state['Attributes'][$this->attribute]); // just in case the first index is no longer 0
         $value = $value[0];
 
         if (empty($value)) {
             SimpleSAML\Logger::warning(
                 'Empty value in attribute '.var_export($this->attribute, true).
                 ' on user - not generating persistent NameID.'
             );
             return null;
         }
 
         return $value;
     }

Here is the call graph for this function:

Field Documentation

◆ $attribute

sspmod_saml_Auth_Process_AttributeNameID::$attribute

private

Definition at line 17 of file AttributeNameID.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/saml/lib/Auth/Process/AttributeNameID.php

Public Member Functions

Protected Member Functions

Private Attributes