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 ($a_field_name, $a_ldap_attribute, $a_perform_update)
	Set mapping rule. More...

	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 ()
	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 ($a_field_name)
	Check whether an update should be performed on a specific user attribute or not. More...

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

Static Public Member Functions
static	_getInstanceByServerId ($a_server_id)
	Get instance of class. More...

static	_delete ($a_server_id)
	Delete mapping rules by server id. More...

static	_lookupGlobalRole ($a_server_id)
	Lookup global role assignment. More...

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

Private Member Functions
	__construct ($a_server_id)
	Private constructor (Singleton for each server_id) More...

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

Private Attributes
	$server_id = null

	$db = null

	$mapping_rules = array()

	$rules_for_update = array()

	$lng

Static Private Attributes
static	$instances = array()

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLDAPAttributeMapping::__construct ( $a_server_id )

private

Private constructor (Singleton for each server_id)

private

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

References $DIC, $ilDB, $lng, and read().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $lng = $DIC['lng'];
         
         $this->db = $ilDB;
         $this->lng = $lng;
         $this->server_id = $a_server_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _delete()

static ilLDAPAttributeMapping::_delete ( $a_server_id )

static

Delete mapping rules by server id.

public

Parameters

int server id

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

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

Referenced by ilLDAPServer\delete().

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

Here is the caller graph for this function:

◆ _getInstanceByServerId()

static ilLDAPAttributeMapping::_getInstanceByServerId ( $a_server_id )

static

Get instance of class.

public

Parameters

int server_id

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

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

     {
         if (array_key_exists($a_server_id, self::$instances) and 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 ( $a_server_id )

static

Lookup global role assignment.

public

Parameters

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

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

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

     {
         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);
         while ($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.

public

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

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

◆ delete()

ilLDAPAttributeMapping::delete ( )

Delete all entries.

public

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

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

◆ enabledUpdate()

ilLDAPAttributeMapping::enabledUpdate ( $a_field_name )

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

public

Parameters

string ILIAS user attribute

Returns: bool

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

     {
         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.

public

Parameters

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

References $rule.

     {
         foreach ($this->mapping_rules as $field => $rule) {
             if (!strlen($rule['value'])) {
                 continue;
             }
             if (strpos($rule['value'], ',') === false) {
                 $fields[] = strtolower($rule['value']);
                 continue;
             }
             $tmp_fields = explode(',', $rule['value']);
             $value = '';
             foreach ($tmp_fields as $tmp_field) {
                 $fields[] = trim(strtolower($tmp_field));
             }
         }
         return $fields ? $fields : array();
     }

◆ getFieldsForUpdate()

ilLDAPAttributeMapping::getFieldsForUpdate ( )

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

public

Parameters

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

References $rule.

     {
         foreach ($this->rules_for_update as $field => $rule) {
             if (!strlen($rule['value'])) {
                 continue;
             }
             if (strpos($rule['value'], ',') === false) {
                 $fields[] = strtolower($rule['value']);
                 continue;
             }
             $tmp_fields = explode(',', $rule['value']);
             $value = '';
             foreach ($tmp_fields as $tmp_field) {
                 $fields[] = trim(strtolower($tmp_field));
             }
         }
         return $fields ? $fields : array();
     }

◆ getRules()

ilLDAPAttributeMapping::getRules ( )

Get all rules.

public

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

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

References $mapping_rules.

     {
         return $this->mapping_rules;
     }

◆ getRulesForUpdate()

ilLDAPAttributeMapping::getRulesForUpdate ( )

Get all mapping rules with option 'update'.

public

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

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

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

◆ getValue()

ilLDAPAttributeMapping::getValue ( $a_field_name )

Get LDAP attribute name by given ILIAS profile field.

public

Parameters

string ILIAS user attribute

Returns: string LDAP attribute name

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

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

◆ hasRulesForUpdate()

static ilLDAPAttributeMapping::hasRulesForUpdate ( $a_server_id )

static

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

Returns

Parameters

int $a_server_id

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

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

Referenced by ilLDAPUserSynchronisation\isUpdateRequired().

     {
         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() ? true : false;
     }

Here is the caller graph for this function:

◆ read()

ilLDAPAttributeMapping::read ( )

private

Read mapping setttings from db.

private

Parameters

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

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

Referenced by __construct().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $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)) {
             $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.

public

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

References $DIC, $ilDB, PHPMailer\PHPMailer\$options, $query, and $res.

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $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') .
                 ')';
             $res = $ilDB->manipulate($query);
         }
     }

◆ setRule()

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

Set mapping rule.

public

Parameters

string	ILIAS user attribute
string	ldap attribute
bool	perform update

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

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

Field Documentation

◆ $db

ilLDAPAttributeMapping::$db = null

private

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

◆ $instances

ilLDAPAttributeMapping::$instances = array()

staticprivate

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

◆ $lng

ilLDAPAttributeMapping::$lng

private

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

Referenced by __construct().

◆ $mapping_rules

ilLDAPAttributeMapping::$mapping_rules = array()

private

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

Referenced by getRules().

◆ $rules_for_update

ilLDAPAttributeMapping::$rules_for_update = array()

private

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

◆ $server_id

ilLDAPAttributeMapping::$server_id = null

private

Definition at line 36 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

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _delete()

◆ _getInstanceByServerId()

◆ _lookupGlobalRole()

◆ clearRules()

◆ delete()

◆ enabledUpdate()

◆ getFields()

◆ getFieldsForUpdate()

◆ getRules()

◆ getRulesForUpdate()

◆ getValue()

◆ hasRulesForUpdate()

◆ read()

◆ save()

◆ setRule()

Field Documentation

◆ $db

◆ $instances

◆ $lng

◆ $mapping_rules

◆ $rules_for_update

◆ $server_id