Collaboration diagram for ilLDAPRoleGroupMappingSettings:

Public Member Functions
	getServerId ()

	getMappings ()
	Get already configured mappings. More...

	loadFromPost (array $a_mappings)

	validate ()
	Validate mappings. More...

	save ()
	Save mappings. More...

	delete ($a_mapping_id)
	Delete a mapping. More...

	getMappingInfoString (int $a_mapping_id)
	Create an info string for a role group mapping. More...

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

static	_deleteByRole (int $a_role_id)

static	_deleteByServerId (int $a_server_id)

Data Fields
const	MAPPING_INFO_ALL = 1

const	MAPPING_INFO_INFO_ONLY = 0

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

	read ()
	Read mappings. More...

Private Attributes
ilDBInterface	$db

ilLanguage	$lng

ilRbacReview	$rbacreview

ilErrorHandling	$ilErr

ilObjectDataCache	$ilObjDataCache

int	$server_id

array	$mappings = []

Static Private Attributes
static array	$instances = []

Detailed Description

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

Definition at line 24 of file class.ilLDAPRoleGroupMappingSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilLDAPRoleGroupMappingSettings::__construct ( $a_server_id )

private

Private constructor (Singleton for each server_id)

Definition at line 43 of file class.ilLDAPRoleGroupMappingSettings.php.

References $DIC, ILIAS\Repository\lng(), and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
         $this->rbacreview = $DIC->rbac()->review();
         $this->ilErr = $DIC['ilErr'];
         $this->ilObjDataCache = $DIC['ilObjDataCache'];
         $this->server_id = $a_server_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteByRole()

static ilLDAPRoleGroupMappingSettings::_deleteByRole ( int $a_role_id )

static

Definition at line 67 of file class.ilLDAPRoleGroupMappingSettings.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjRole\delete().

                                                         : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "DELETE FROM ldap_rg_mapping " .
             "WHERE role = " . $ilDB->quote($a_role_id, 'integer');
         $ilDB->manipulate($query);
 
         return true;
     }

Here is the caller graph for this function:

◆ _deleteByServerId()

static ilLDAPRoleGroupMappingSettings::_deleteByServerId ( int $a_server_id )

static

Definition at line 80 of file class.ilLDAPRoleGroupMappingSettings.php.

References $data, $DIC, $ilDB, $query, $res, and ilRbacReview\getObjectOfRole().

Referenced by ilLDAPServer\delete().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstanceByServerId()

static ilLDAPRoleGroupMappingSettings::_getInstanceByServerId ( int $a_server_id )

static

Get instance of class.

Definition at line 59 of file class.ilLDAPRoleGroupMappingSettings.php.

Referenced by ilLDAPRoleMappingTableGUI\getItems(), ilLDAPSettingsGUI\initRoleMapping(), and ilLDAPSettingsGUI\roleMapping().

                                                                    : ilLDAPRoleGroupMappingSettings
     {
         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 ilLDAPRoleGroupMappingSettings($a_server_id);
     }

Here is the caller graph for this function:

◆ delete()

ilLDAPRoleGroupMappingSettings::delete ( $a_mapping_id )

Delete a mapping.

Parameters

int	mapping_id

Definition at line 234 of file class.ilLDAPRoleGroupMappingSettings.php.

References $query, getServerId(), and read().

                                          : void
     {
         $query = "DELETE FROM ldap_rg_mapping " .
             "WHERE server_id = " . $this->db->quote($this->getServerId(), 'integer') . " " .
             "AND mapping_id = " . $this->db->quote($a_mapping_id, 'integer');
         $this->db->manipulate($query);
         $this->read();
     }

Here is the call graph for this function:

◆ getMappingInfoString()

ilLDAPRoleGroupMappingSettings::getMappingInfoString ( int $a_mapping_id )

Create an info string for a role group mapping.

Parameters

int $a_mapping_id mapping_id

Definition at line 250 of file class.ilLDAPRoleGroupMappingSettings.php.

                                                            : string
     {
         $dn_parts = explode(',', $this->mappings[$a_mapping_id]['dn']);
 
         return $dn_parts ? $dn_parts[0] : "''";
     }

◆ getMappings()

ilLDAPRoleGroupMappingSettings::getMappings ( )

Get already configured mappings.

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

References $mappings.

                                  : array
     {
         return $this->mappings;
     }

◆ getServerId()

ilLDAPRoleGroupMappingSettings::getServerId ( )

Definition at line 124 of file class.ilLDAPRoleGroupMappingSettings.php.

References $server_id.

Referenced by delete(), read(), and save().

                                  : int
     {
         return $this->server_id;
     }

Here is the caller graph for this function:

◆ loadFromPost()

ilLDAPRoleGroupMappingSettings::loadFromPost ( array $a_mappings )

Definition at line 137 of file class.ilLDAPRoleGroupMappingSettings.php.

References $data, and ilUtil\stripSlashes().

                                                    : void
     {
         if (!$a_mappings) {
             return;
         }
 
         $this->mappings = [];
         foreach ($a_mappings as $mapping_id => $data) {
             if ($mapping_id === 0 && !$data['dn'] && !$data['member'] && !$data['memberisdn'] && !$data['role']) {
                 continue;
             }
             $this->mappings[$mapping_id]['dn'] = ilUtil::stripSlashes($data['dn']);
             $this->mappings[$mapping_id]['url'] = ilUtil::stripSlashes($data['url']);
             $this->mappings[$mapping_id]['member_attribute'] = ilUtil::stripSlashes($data['member']);
             $this->mappings[$mapping_id]['member_isdn'] = ilUtil::stripSlashes($data['memberisdn']);
             $this->mappings[$mapping_id]['role_name'] = ilUtil::stripSlashes($data['role']);
             $this->mappings[$mapping_id]['role'] = $this->rbacreview->roleExists(ilUtil::stripSlashes($data['role']));
             $this->mappings[$mapping_id]['info'] = ilUtil::stripSlashes($data['info']);
             $this->mappings[$mapping_id]['info_type'] = ilUtil::stripSlashes($data['info_type']);
         }
     }

Here is the call graph for this function:

◆ read()

ilLDAPRoleGroupMappingSettings::read ( )

private

Read mappings.

Definition at line 261 of file class.ilLDAPRoleGroupMappingSettings.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and getServerId().

Referenced by __construct(), delete(), and save().

                            : void
     {
         $this->mappings = array();
         $query = "SELECT * FROM ldap_rg_mapping LEFT JOIN object_data " .
             "ON role = obj_id " .
             "WHERE server_id =" . $this->db->quote($this->getServerId(), 'integer') . ' ' .
             "ORDER BY title,dn";
 
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->mappings[$row->mapping_id]['mapping_id'] = $row->mapping_id;
             $this->mappings[$row->mapping_id]['dn'] = $row->dn;
             $this->mappings[$row->mapping_id]['url'] = $row->url;
             $this->mappings[$row->mapping_id]['member_attribute'] = $row->member_attribute;
             $this->mappings[$row->mapping_id]['member_isdn'] = $row->member_isdn;
             $this->mappings[$row->mapping_id]['role'] = $row->role;
             $this->mappings[$row->mapping_id]['info'] = $row->mapping_info;
             $this->mappings[$row->mapping_id]['info_type'] = $row->mapping_info_type;
             if ($this->ilObjDataCache->lookupType((int) $row->role) === 'role') {
                 $this->mappings[$row->mapping_id]['role_name'] = $this->ilObjDataCache->lookupTitle((int) $row->role);
             } else {
                 $this->mappings[$row->mapping_id]['role_name'] = $row->role;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilLDAPRoleGroupMappingSettings::save ( )

Save mappings.

public

Parameters

Definition at line 193 of file class.ilLDAPRoleGroupMappingSettings.php.

References $data, $query, getServerId(), and read().

                           : void
     {
         foreach ($this->mappings as $mapping_id => $data) {
             if (!$mapping_id) {
                 $next_id = $this->db->nextId('ldap_rg_mapping');
                 $query = "INSERT INTO ldap_rg_mapping (mapping_id,server_id,url,dn,member_attribute,member_isdn,role,mapping_info,mapping_info_type) " .
                     "VALUES ( " .
                     $this->db->quote($next_id, 'integer') . ", " .
                     $this->db->quote($this->getServerId(), 'integer') . ", " .
                     $this->db->quote($data['url'], 'text') . ", " .
                     $this->db->quote($data['dn'], 'text') . ", " .
                     $this->db->quote($data['member_attribute'], 'text') . ", " .
                     $this->db->quote($data['member_isdn'], 'integer') . ", " .
                     $this->db->quote($data['role'], 'integer') . ", " .
                     $this->db->quote($data['info'], 'text') . ", " .
                     $this->db->quote($data['info_type'], 'integer') .
                     ")";
             } else {
                 $query = "UPDATE ldap_rg_mapping " .
                     "SET server_id = " . $this->db->quote($this->getServerId(), 'integer') . ", " .
                     "url = " . $this->db->quote($data['url'], 'text') . ", " .
                     "dn =" . $this->db->quote($data['dn'], 'text') . ", " .
                     "member_attribute = " . $this->db->quote($data['member_attribute'], 'text') . ", " .
                     "member_isdn = " . $this->db->quote($data['member_isdn'], 'integer') . ", " .
                     "role = " . $this->db->quote($data['role'], 'integer') . ", " .
                     "mapping_info = " . $this->db->quote($data['info'], 'text') . ", " .
                     "mapping_info_type = " . $this->db->quote($data['info_type'], 'integer') . " " .
                     "WHERE mapping_id = " . $this->db->quote($mapping_id, 'integer');
             }
             $this->db->manipulate($query);
         }
         $this->read();
     }

Here is the call graph for this function:

◆ validate()

ilLDAPRoleGroupMappingSettings::validate ( )

Validate mappings.

public

Definition at line 165 of file class.ilLDAPRoleGroupMappingSettings.php.

References $data, and ILIAS\Repository\lng().

                               : bool
     {
         $this->ilErr->setMessage('');
         $found_missing = false;
         foreach ($this->mappings as $data) {
             // Check if all required fields are available
             if ($data['dn'] === '' || $data['member_attribute'] === '' || $data['role_name'] === '') {
                 if (!$found_missing) {
                     $found_missing = true;
                     $this->ilErr->appendMessage($this->lng->txt('fill_out_all_required_fields'));
                 }
             }
             // Check role valid
             if ($data['role_name'] !== '' && !$this->rbacreview->roleExists($data['role_name'])) {
                 $this->ilErr->appendMessage($this->lng->txt('ldap_role_not_exists') . ' ' . $data['role_name']);
             }
         }
 
         return $this->ilErr->getMessage() === '';
     }