This class stores the settings that define the mapping between LDAP attribute and user profile fields. More...

Collaboration diagram for ilLDAPAttributeMapping:

Public Member Functions
	setRule (string $a_field_name, string $a_ldap_attribute, bool $a_perform_update)

	getRulesForUpdate ()
	Get all mapping rules with option 'update'. More...

	getFieldsForUpdate ()
	Get field names of all mapping rules with option 'update'. More...

	getFields ()
	Get all mapping fields. More...

	getRules (bool $onlyApplicable=false)
	Get all rules. More...

	clearRules ()
	Clear rules => Does not perform an update. More...

	save ()
	Save mapping rules to db. More...

	delete ()
	Delete all entries. More...

	enabledUpdate (string $a_field_name)
	Check whether an update should be performed on a specific user attribute or not. More...

	getValue (string $a_field_name)
	Get LDAP attribute name by given ILIAS profile field. More...

Static Public Member Functions
static	_getInstanceByServerId (int $a_server_id)

static	_delete (int $a_server_id)

static	_lookupGlobalRole (int $a_server_id)

static	hasRulesForUpdate (int $a_server_id)
	Check if there is ldap attribute -> user data mapping which which is updated on login. More...

Private Member Functions
	__construct (int $a_server_id)

	read ()
	Read mapping settings from db. More...

Static Private Member Functions
static	getMappedFields (array $rules)

Private Attributes
int	$server_id

ilDBInterface	$db

array	$mapping_rules = []

array	$rules_for_update = []

Static Private Attributes
static array	$instances = []

Detailed Description

This class stores the settings that define the mapping between LDAP attribute and user profile fields.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilLDAPAttributeMapping.php.

Constructor & Destructor Documentation

◆ __construct()

ilLDAPAttributeMapping::__construct ( int $a_server_id )

private

Definition at line 35 of file class.ilLDAPAttributeMapping.php.

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
 
         $this->server_id = $a_server_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _delete()

static ilLDAPAttributeMapping::_delete ( int $a_server_id )

static

Definition at line 54 of file class.ilLDAPAttributeMapping.php.

References $DIC, $ilDB, and $query.

Referenced by ilLDAPServer\delete().

                                                     : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "DELETE FROM ldap_attribute_mapping " .
             "WHERE server_id =" . $ilDB->quote($a_server_id, 'integer');
         $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ _getInstanceByServerId()

static ilLDAPAttributeMapping::_getInstanceByServerId ( int $a_server_id )

static

Definition at line 45 of file class.ilLDAPAttributeMapping.php.

Referenced by ilLDAPQuery\__construct(), ilLDAPServer\getPearAtributeArray(), ilLDAPSettingsGUI\initAttributeMapping(), and ilLDAPAttributeToUser\initLDAPAttributeMapping().

                                                                    : ilLDAPAttributeMapping
     {
         if (array_key_exists($a_server_id, self::$instances) && is_object(self::$instances[$a_server_id])) {
             return self::$instances[$a_server_id];
         }
 
         return self::$instances[$a_server_id] = new ilLDAPAttributeMapping($a_server_id);
     }

Here is the caller graph for this function:

◆ _lookupGlobalRole()

static ilLDAPAttributeMapping::_lookupGlobalRole ( int $a_server_id )

static

Definition at line 65 of file class.ilLDAPAttributeMapping.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilLDAPRoleAssignmentRules\getDefaultRole(), and ilLDAPSettingsGUI\setServerFormValues().

                                                               : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT value FROM ldap_attribute_mapping " .
             "WHERE server_id =" . $ilDB->quote($a_server_id, 'integer') . " " .
             "AND keyword = " . $ilDB->quote('global_role', 'text');
 
         $res = $ilDB->query($query);
         if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (int) $row->value;
         }
 
         return 0;
     }

Here is the caller graph for this function:

◆ clearRules()

ilLDAPAttributeMapping::clearRules ( )

Clear rules => Does not perform an update.

Definition at line 169 of file class.ilLDAPAttributeMapping.php.

                                 : void
     {
         $this->mapping_rules = array();
     }

◆ delete()

ilLDAPAttributeMapping::delete ( )

Delete all entries.

Definition at line 196 of file class.ilLDAPAttributeMapping.php.

                             : void
     {
         self::_delete($this->server_id);
     }

◆ enabledUpdate()

ilLDAPAttributeMapping::enabledUpdate ( string $a_field_name )

Check whether an update should be performed on a specific user attribute or not.

Parameters

string ILIAS user attribute

Definition at line 206 of file class.ilLDAPAttributeMapping.php.

                                                        : bool
     {
         if (array_key_exists($a_field_name, $this->mapping_rules)) {
             return (bool) $this->mapping_rules[$a_field_name]['performUpdate'];
         }
 
         return false;
     }

◆ getFields()

ilLDAPAttributeMapping::getFields ( )

Get all mapping fields.

Definition at line 127 of file class.ilLDAPAttributeMapping.php.

                                : array
     {
         return self::getMappedFields($this->mapping_rules);
     }

◆ getFieldsForUpdate()

ilLDAPAttributeMapping::getFieldsForUpdate ( )

Get field names of all mapping rules with option 'update'.

Definition at line 119 of file class.ilLDAPAttributeMapping.php.

                                         : array
     {
         return self::getMappedFields($this->rules_for_update);
     }

◆ getMappedFields()

static ilLDAPAttributeMapping::getMappedFields ( array $rules )

staticprivate

Definition at line 132 of file class.ilLDAPAttributeMapping.php.

                                                          : array
     {
         $fields = [];
         foreach ($rules as $rule) {
             if (!$rule['value']) {
                 continue;
             }
             if (strpos($rule['value'], ',') === false) {
                 $fields[] = strtolower($rule['value']);
                 continue;
             }
             $tmp_fields = explode(',', $rule['value']);
             foreach ($tmp_fields as $tmp_field) {
                 $fields[] = strtolower(trim($tmp_field));
             }
         }
         return $fields;
     }

◆ getRules()

ilLDAPAttributeMapping::getRules ( bool $onlyApplicable = false )

Get all rules.

Returns: array mapping rules. E.g. array('firstname' => 'name',...)

Definition at line 156 of file class.ilLDAPAttributeMapping.php.

References $mapping_rules.

                                                           : array
     {
         if (!$onlyApplicable) {
             return $this->mapping_rules;
         }
         return array_filter($this->mapping_rules, static function (array $rule): bool {
             return $rule['value'] !== '';
         });
     }

◆ getRulesForUpdate()

ilLDAPAttributeMapping::getRulesForUpdate ( )

Get all mapping rules with option 'update'.

Returns: array mapping rules. E.g. array('firstname' => 'name',...)

Definition at line 110 of file class.ilLDAPAttributeMapping.php.

References $rules_for_update.

                                        : array
     {
         return $this->rules_for_update;
     }

◆ getValue()

ilLDAPAttributeMapping::getValue ( string $a_field_name )

Get LDAP attribute name by given ILIAS profile field.

Parameters

string ILIAS user attribute

Returns: string LDAP attribute name

Definition at line 221 of file class.ilLDAPAttributeMapping.php.

                                                   : string
     {
         if (array_key_exists($a_field_name, $this->mapping_rules)) {
             return $this->mapping_rules[$a_field_name]['value'];
         }
 
         return '';
     }

◆ hasRulesForUpdate()

static ilLDAPAttributeMapping::hasRulesForUpdate ( int $a_server_id )

static

Check if there is ldap attribute -> user data mapping which which is updated on login.

Definition at line 87 of file class.ilLDAPAttributeMapping.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilLDAPUserSynchronisation\isUpdateRequired().

                                                               : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'SELECT perform_update FROM ldap_attribute_mapping ' .
             'WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer') . ' ' .
             'AND perform_update = 1';
         $res = $ilDB->query($query);
         return $res->numRows() > 0;
     }

Here is the caller graph for this function:

◆ read()

ilLDAPAttributeMapping::read ( )

private

Read mapping settings from db.

Definition at line 233 of file class.ilLDAPAttributeMapping.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and if.

Referenced by __construct(), ilLDAPSettingsGUI\addRoleMapping(), ilLDAPSettingsGUI\confirmDeleteRoleMapping(), and ilLDAPSettingsGUI\editRoleMapping().

                            : void
     {
         $query = "SELECT * FROM ldap_attribute_mapping " .
             "WHERE server_id =" . $this->db->quote($this->server_id, 'integer');
 
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if (!is_null($row->value)) {
                 $this->mapping_rules[$row->keyword]['value'] = $row->value;
                 $this->mapping_rules[$row->keyword]['performUpdate'] = (bool) $row->perform_update;
 
                 if ($row->perform_update) {
                     $this->rules_for_update[$row->keyword]['value'] = $row->value;
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ save()

ilLDAPAttributeMapping::save ( )

Save mapping rules to db.

Definition at line 177 of file class.ilLDAPAttributeMapping.php.

References $query.

Referenced by ilLDAPSettingsGUI\createRoleMapping().

                           : void
     {
         $this->delete();
 
         foreach ($this->mapping_rules as $keyword => $options) {
             $query = "INSERT INTO ldap_attribute_mapping (server_id,keyword,value,perform_update) " .
                 "VALUES( " .
                 $this->db->quote($this->server_id, 'integer') . ", " .
                 $this->db->quote($keyword, 'text') . ", " .
                 $this->db->quote($options['value'], 'text') . ", " .
                 $this->db->quote($options['performUpdate'], 'integer') .
                 ')';
             $this->db->manipulate($query);
         }
     }

Here is the caller graph for this function:

◆ setRule()

ilLDAPAttributeMapping::setRule	(	string	$a_field_name,
		string	$a_ldap_attribute,
		bool	$a_perform_update
	)

Definition at line 100 of file class.ilLDAPAttributeMapping.php.

                                                                                                    : void
     {
         $this->mapping_rules[$a_field_name]['value'] = $a_ldap_attribute;
         $this->mapping_rules[$a_field_name]['performUpdate'] = $a_perform_update;
     }

Field Documentation

◆ $db

ilDBInterface ilLDAPAttributeMapping::$db

private

Definition at line 30 of file class.ilLDAPAttributeMapping.php.

◆ $instances

array ilLDAPAttributeMapping::$instances = []

staticprivate

Definition at line 28 of file class.ilLDAPAttributeMapping.php.

◆ $mapping_rules

array ilLDAPAttributeMapping::$mapping_rules = []

private

Definition at line 32 of file class.ilLDAPAttributeMapping.php.

Referenced by getRules().

◆ $rules_for_update

array ilLDAPAttributeMapping::$rules_for_update = []

private

Definition at line 33 of file class.ilLDAPAttributeMapping.php.

Referenced by getRulesForUpdate().

◆ $server_id

int ilLDAPAttributeMapping::$server_id

private

Definition at line 29 of file class.ilLDAPAttributeMapping.php.

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

Services/LDAP/classes/class.ilLDAPAttributeMapping.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _delete()

◆ _getInstanceByServerId()

◆ _lookupGlobalRole()

◆ clearRules()

◆ delete()

◆ enabledUpdate()

◆ getFields()

◆ getFieldsForUpdate()

◆ getMappedFields()

◆ getRules()

◆ getRulesForUpdate()

◆ getValue()

◆ hasRulesForUpdate()

◆ read()

◆ save()

◆ setRule()

Field Documentation

◆ $db

◆ $instances

◆ $mapping_rules

◆ $rules_for_update

◆ $server_id