PHP Class sspmod_ldap_Auth_Process_BaseFilter, simplesamlphp

Author: Ryan Panning ([email protected])

Inheritance: extends SimpleSAML_Auth_ProcessingFilter

Mostra file Open project: simplesamlphp/simplesamlphp Class Usage Examples

Protected Properties

Property	Type	Description
$attribute_map	array	List of attribute "alias's" linked to the real attribute name. Used for abstraction / configuration of the LDAP attribute names, which may change between dir service.
$base_dn	string \| array	The base DN of the LDAP connection. Used when searching the LDAP server.
$config	SimpleSAML_Configuration	The construct method will change the filter config into a SimpleSAML_Configuration object and store it here for later use, if needed.
$product	string	Many times a LDAP product specific query can be used to speed up or reduce the filter process. This helps the child classes determine the product used to optimize those queries.
$title	string	This should be prepended to the beginning of the message.
$type_map	array	List of LDAP object types, used to determine the type of object that a DN references.

Public Methods

Method	Description
__construct ( array &$config, $reserved )	Checks the authsource, if defined, for configuration values to the LDAP server. Then sets up the LDAP connection for the instance/object and stores everything in class members.

Protected Methods

Method	Description
getLdap ( ) : sspmod_ldap_LdapConnection	Getter for the LDAP connection object. Created this getter rather than setting in the constructor to avoid unnecessarily connecting to LDAP when it might not be needed.
var_export ( mixed $value ) : string	Local utility function to get details about a variable, basically converting it to a string to be used in a log message. The var_export() function returns several lines so this will remove the new lines and trim each line.

Method Details

__construct() public method

Checks the authsource, if defined, for configuration values to the LDAP server. Then sets up the LDAP connection for the instance/object and stores everything in class members.

public __construct ( array &$config, $reserved )
$config	array
$reserved

getLdap() protected method

Getter for the LDAP connection object. Created this getter rather than setting in the constructor to avoid unnecessarily connecting to LDAP when it might not be needed.

protected getLdap ( ) : sspmod_ldap_LdapConnection
return	sspmod_ldap_LdapConnection

var_export() protected method

Local utility function to get details about a variable, basically converting it to a string to be used in a log message. The var_export() function returns several lines so this will remove the new lines and trim each line.

protected var_export ( mixed $value ) : string
$value	mixed
return	string

Property Details

$attribute_map protected_oe property

List of attribute "alias's" linked to the real attribute name. Used for abstraction / configuration of the LDAP attribute names, which may change between dir service.

protected array $attribute_map
return	array

$base_dn protected_oe property

The base DN of the LDAP connection. Used when searching the LDAP server.

protected string\|array $base_dn
return	string \| array

$config protected_oe property

The construct method will change the filter config into a SimpleSAML_Configuration object and store it here for later use, if needed.

protected SimpleSAML_Configuration $config
return	SimpleSAML_Configuration

$product protected_oe property

Many times a LDAP product specific query can be used to speed up or reduce the filter process. This helps the child classes determine the product used to optimize those queries.

protected string $product
return	string

$title protected_oe property

This should be prepended to the beginning of the message.

protected string $title
return	string

$type_map protected_oe property

List of LDAP object types, used to determine the type of object that a DN references.

protected array $type_map
return	array