Mapping utils. More...

Collaboration diagram for ilECSMappingUtils:

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

static	mappingStatusToString ($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. 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 $Id$

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

Member Function Documentation

◆ getAuthModeSelection()

static ilECSMappingUtils::getAuthModeSelection ( )

static

Get auth mode selection.

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

References $DIC, $GLOBALS, $ilSetting, $lng, $options, $server, ilAuthUtils\_getAuthModeName(), AUTH_SHIBBOLETH, ilLDAPServer\getInstanceByServerId(), and ilLDAPServer\getServerIds().

Referenced by ilECSMappingSettingsGUI\initFormCSettings().

         {
                 global $DIC;
                 global $ilSetting;
 
                 $lng = $DIC->language();
 
 
                 $options[0] = $GLOBALS['lng']->txt('select_one');
                 $options['local'] = $GLOBALS['lng']->txt('auth_local');
                 
                 include_once './Services/LDAP/classes/class.ilLDAPServer.php';
                 foreach(ilLDAPServer::getServerIds() as $sid)
                 {
                         $server = ilLDAPServer::getInstanceByServerId($sid);
                         $options['ldap_'.$server->getServerId()] = 'LDAP (' . $server->getName().')';
                 }
 
                 if($ilSetting->get('shib_active', 0))
                 {
                         $options[ilAuthUtils::_getAuthModeName(AUTH_SHIBBOLETH)] =
                                 $lng->txt('auth_shibboleth');
                 }
 
                 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 54 of file class.ilECSMappingUtils.php.

References $counter, $lng, and array.

         {
                 global $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 80 of file class.ilECSMappingUtils.php.

References $info, $lng, and $options.

Referenced by ilECSMappingSettingsGUI\initFormCSettings().

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

Parameters

type	$course
type	$a_field

Returns: array

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

References array, and string.

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

         {
                 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[] =  (string) ($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[] = array();
                                 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 167 of file class.ilECSMappingUtils.php.

References array, IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, and IL_GRP_MEMBER.

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

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

Here is the caller graph for this function:

◆ lookupMappingStatus()

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

static

Lookup mapping status.

Parameters

int	$a_server_id
int	$a_tree_id

Returns: int

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

References ilECSNodeMappingAssignments\hasAssignments(), and ilECSNodeMappingAssignments\isWholeTreeMapped().

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

         {
                 include_once './Services/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingAssignments.php';
 
                 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 ( $a_status )

static

Get mapping status as string.

Parameters

int $a_status

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

References $lng.

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

         {
                 global $lng;
                 
                 return $lng->txt('ecs_node_mapping_status_'.$a_status);
         }

Here is the caller graph for this function:

Field Documentation

◆ MAPPED_MANUAL

const ilECSMappingUtils::MAPPED_MANUAL = 2

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

Referenced by ilECSMappingSettingsGUI\dInitFormTreeSettings().

◆ MAPPED_UNMAPPED

const ilECSMappingUtils::MAPPED_UNMAPPED = 3

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

Referenced by ilECSNodeMappingTreeTableGUI\fillRow().

◆ MAPPED_WHOLE_TREE

const ilECSMappingUtils::MAPPED_WHOLE_TREE = 1

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

◆ PARALLEL_ALL_COURSES

const ilECSMappingUtils::PARALLEL_ALL_COURSES = 2

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

Referenced by ilECSCourseCreationHandler\doSync(), and ilECSCmsCourseMemberCommandQueueHandler\readAssignments().

◆ PARALLEL_COURSES_FOR_LECTURERS

const ilECSMappingUtils::PARALLEL_COURSES_FOR_LECTURERS = 3

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

Referenced by ilECSCourseCreationHandler\doSync().

◆ PARALLEL_GROUPS_IN_COURSE

const ilECSMappingUtils::PARALLEL_GROUPS_IN_COURSE = 1

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

Referenced by ilECSCourseCreationHandler\doSync(), and ilECSCmsCourseMemberCommandQueueHandler\readAssignments().

◆ PARALLEL_ONE_COURSE

const ilECSMappingUtils::PARALLEL_ONE_COURSE = 0

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

Referenced by ilECSCourseCreationHandler\doSync(), and ilECSCmsCourseMemberCommandQueueHandler\readAssignments().

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

Services/WebServices/ECS/classes/Mapping/class.ilECSMappingUtils.php

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ getAuthModeSelection()

◆ getCourseMappingFieldInfo()

◆ getCourseMappingFieldSelectOptions()

◆ getCourseValueByMappingAttribute()

◆ getRoleMappingInfo()

◆ lookupMappingStatus()

◆ mappingStatusToString()

Field Documentation

◆ MAPPED_MANUAL

◆ MAPPED_UNMAPPED

◆ MAPPED_WHOLE_TREE

◆ PARALLEL_ALL_COURSES

◆ PARALLEL_COURSES_FOR_LECTURERS

◆ PARALLEL_GROUPS_IN_COURSE

◆ PARALLEL_ONE_COURSE