Mapping utils. More...

Collaboration diagram for ilECSMappingUtils:

Static Public Member Functions
static	lookupMappingStatus (int $a_server_id, int $a_mid, int $a_tree_id)
	Lookup mapping status. More...

static	mappingStatusToString (int $a_status)
	Get mapping status as string. More...

static	getCourseMappingFieldInfo ()

static	getCourseMappingFieldSelectOptions ()

static	getCourseValueByMappingAttribute ($course, $a_field)
	Get course value by mapping. More...

static	getRoleMappingInfo ($a_role_type_info=0)
	Get role mapping info. More...

static	getAuthModeSelection ()
	Get auth mode selection with active authentication modes. More...

Data Fields
const	MAPPED_WHOLE_TREE = 1

const	MAPPED_MANUAL = 2

const	MAPPED_UNMAPPED = 3

const	PARALLEL_ONE_COURSE = 0

const	PARALLEL_GROUPS_IN_COURSE = 1

const	PARALLEL_ALL_COURSES = 2

const	PARALLEL_COURSES_FOR_LECTURERS = 3

Detailed Description

Mapping utils.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilECSMappingUtils.php.

Member Function Documentation

◆ getAuthModeSelection()

static ilECSMappingUtils::getAuthModeSelection ( )

static

Get auth mode selection with active authentication modes.

Returns: array<string, string>

Definition at line 211 of file class.ilECSMappingUtils.php.

References $DIC, $lng, ilAuthUtils\_getActiveAuthModes(), and ilAuthUtils\getAuthModeTranslation().

Referenced by ilECSMappingSettingsGUI\initFormCSettings().

                                                  : array
     {
         global $DIC;
 
         $lng = $DIC->language();
         $active_auth_modes = ilAuthUtils::_getActiveAuthModes();
         $options = [];
         $options["0"] = $lng->txt('select_one');
         foreach ($active_auth_modes as $auth_string => $auth_int) {
             if (
                 $auth_string === 'default' ||
                 $auth_string === 'ecs' ||
                 substr($auth_string, 0, 3) === 'lti'
             ) {
                 continue;
             }
             $options[$auth_string] = ilAuthUtils::getAuthModeTranslation((string) $auth_int);
         }
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCourseMappingFieldInfo()

static ilECSMappingUtils::getCourseMappingFieldInfo ( )

static

Definition at line 61 of file class.ilECSMappingUtils.php.

References $DIC, and $lng.

                                                       : array
     {
         global $DIC;
 
         $lng = $DIC['lng'];
 
         $field_info = array();
         $counter = 0;
         foreach (
             array(
                 'organisation',
                 'orgunit',
                 'term',
                 'title',
                 'lecturer',
                 'courseType',
                 'degreeProgramme',
                 'module',
                 'venue'
                 ) as $field) {
             $field_info[$counter]['name'] = $field;
             $field_info[$counter]['translation'] = $lng->txt('ecs_cmap_att_' . $field);
             $counter++;
         }
         return $field_info;
     }

◆ getCourseMappingFieldSelectOptions()

static ilECSMappingUtils::getCourseMappingFieldSelectOptions ( )

static

Definition at line 88 of file class.ilECSMappingUtils.php.

References $DIC, and $lng.

Referenced by ilECSMappingSettingsGUI\initFormCSettings().

                                                                : array
     {
         global $DIC;
 
         $lng = $DIC['lng'];
 
         $options[''] = $lng->txt('select_one');
         foreach (self::getCourseMappingFieldInfo() as $info) {
             $options[$info['name']] = $info['translation'];
         }
         return $options;
     }

Here is the caller graph for this function:

◆ getCourseValueByMappingAttribute()

static ilECSMappingUtils::getCourseValueByMappingAttribute	(	$course,
		$a_field
	)

static

Get course value by mapping.

Definition at line 104 of file class.ilECSMappingUtils.php.

Referenced by ilECSCourseMappingRule\doMapping(), and ilECSCourseMappingRule\matches().

                                                                               : array
     {
         switch ($a_field) {
             case 'organisation':
                 return array((string) $course->organisation);
 
             case 'term':
                 return array((string) $course->term);
 
             case 'title':
                 return array((string) $course->title);
 
             case 'orgunit':
                 $units = array();
                 foreach ((array) $course->organisationalUnits as $unit) {
                     $units[] = (string) $unit->title;
                 }
                 return $units;
 
             case 'lecturer':
                 $lecturers = array();
                 foreach ((array) $course->groups as $group) {
                     foreach ((array) $group->lecturers as $lecturer) {
                         $lecturers[] = $lecturer->lastName . ', ' . $lecturer->firstName;
                     }
                 }
                 return $lecturers;
 
             case 'courseType':
                 return array((string) $course->lectureType);
 
             case 'degreeProgramme':
                 $degree_programmes = array();
                 foreach ((array) $course->degreeProgrammes as $prog) {
                     $degree_programmes[] = (string) $prog->title;
                 }
                 return $degree_programmes;
 
             case 'module':
                 $modules = array();
                 foreach ((array) $course->modules as $mod) {
                     $modules[] = (string) $mod->title;
                 }
                 return $modules;
 
             case 'venue':
                 $venues = [];
                 foreach ((array) $course->groups as $group) {
                     foreach ((array) $group->datesAndVenues as $venue) {
                         $venues[] = (string) $venue->venue;
                     }
                 }
                 return $venues;
         }
         return array();
     }

Here is the caller graph for this function:

◆ getRoleMappingInfo()

static ilECSMappingUtils::getRoleMappingInfo ( $a_role_type_info = 0 )

static

Get role mapping info.

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

References ilParticipants\IL_CRS_ADMIN, ilParticipants\IL_CRS_MEMBER, ilParticipants\IL_CRS_TUTOR, ilParticipants\IL_GRP_ADMIN, and ilParticipants\IL_GRP_MEMBER.

Referenced by ilECSMappingSettingsGUI\cUpdateSettings(), ilECSMappingSettingsGUI\initFormCSettings(), and ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus().

                                                                     : array
     {
         //KEEP!!! until the defines are turned into proper constants
         include_once './Services/Membership/classes/class.ilParticipants.php';
         $roles = array(
             ilParticipants::IL_CRS_ADMIN => array(
                 'role' => ilParticipants::IL_CRS_ADMIN,
                 'lang' => 'il_crs_admin',
                 'create' => true,
                 'required' => true,
                 'type' => 'crs'),
             ilParticipants::IL_CRS_TUTOR => array(
                 'role' => ilParticipants::IL_CRS_TUTOR,
                 'lang' => 'il_crs_tutor',
                 'create' => true,
                 'required' => false,
                 'type' => 'crs'),
             ilParticipants::IL_CRS_MEMBER => array(
                 'role' => ilParticipants::IL_CRS_MEMBER,
                 'lang' => 'il_crs_member',
                 'create' => false,
                 'required' => true,
                 'type' => 'crs'),
             ilParticipants::IL_GRP_ADMIN => array(
                 'role' => ilParticipants::IL_GRP_ADMIN,
                 'lang' => 'il_grp_admin',
                 'create' => true,
                 'required' => false,
                 'type' => 'grp'),
             ilParticipants::IL_GRP_MEMBER => array(
                 'role' => ilParticipants::IL_GRP_MEMBER,
                 'lang' => 'il_grp_member',
                 'create' => false,
                 'required' => false,
                 'type' => 'grp')
         );
         if (!$a_role_type_info) {
             return $roles;
         }
         return $roles[$a_role_type_info];
     }

Here is the caller graph for this function:

◆ lookupMappingStatus()

static ilECSMappingUtils::lookupMappingStatus	(	int	$a_server_id,
		int	$a_mid,
		int	$a_tree_id
	)

static

Lookup mapping status.

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

References ilECSNodeMappingAssignments\isWholeTreeMapped().

Referenced by ilECSMappingSettingsGUI\dInitFormTreeSettings(), and ilECSNodeMappingTreeTableGUI\parse().

                                                                                             : int
     {
         if (ilECSNodeMappingAssignments::hasAssignments($a_server_id, $a_mid, $a_tree_id)) {
             if (ilECSNodeMappingAssignments::isWholeTreeMapped($a_server_id, $a_mid, $a_tree_id)) {
                 return self::MAPPED_WHOLE_TREE;
             }
             return self::MAPPED_MANUAL;
         }
         return self::MAPPED_UNMAPPED;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mappingStatusToString()

static ilECSMappingUtils::mappingStatusToString ( int $a_status )

static

Get mapping status as string.

Definition at line 53 of file class.ilECSMappingUtils.php.

References $DIC.

Referenced by ilECSMappingSettingsGUI\dInitFormTreeSettings(), and ilECSNodeMappingTreeTableGUI\fillRow().

                                                                : string
     {
         global $DIC;
 
         return $DIC->language()->txt('ecs_node_mapping_status_' . $a_status);
     }