Description of class. More...

Collaboration diagram for ilECSCourseCreationHandler:

Public Member Functions
	__construct (ilECSSetting $server, $a_mid)
	Constructor More...

	getServer ()
	Get server settings. More...

	getMapping ()
	Get mapping settings. More...

	getCourseUrl ()
	Get course url. More...

	isObjectCreated ()
	Check if an object (course / group) has been created. More...

	setObjectCreated ($a_status)
	Set object created status. More...

	getMid ()
	Get mid of course event. More...

	handle ($a_content_id, $course)
	Handle sync request. More...

Protected Member Functions
	getCreatedCourses ()
	get created courses More...

	doAttributeMapping ($a_content_id, $course)
	Sync attribute mapping. More...

	createCourseReferenceObjects ($a_parent_ref_id)
	Create course reference objects. More...

	syncParentContainer ($a_content_id, $course)
	Sync parent container. More...

	syncNodeToTop ($tree_id, $cms_id)
	Sync node to top. More...

	syncCategory ($tobj_id, $parent_ref_id)
	Sync category. More...

	doSync ($a_content_id, $course, $a_parent_obj_id)
	Handle all in one setting. More...

	createParallelCourses ($a_content_id, $course, $parent_ref)
	Create parallel courses. More...

	createParallelCourse ($a_content_id, $course, $group, $parent_ref)
	Create parallel course. More...

	updateParallelCourses ($a_content_id, $course, $parent_obj)
	Update parallel group data. More...

	createParallelGroups ($a_content_id, $course, $parent_ref)
	This create parallel groups. More...

	createParallelGroup ($a_content_id, $course, $group, $parent_ref)
	Create parallel group. More...

	updateParallelGroups ($a_content_id, $course, $parent_obj)
	Update parallel group data. More...

	getImportId ($a_content_id, $a_sub_id=NULL)
	Get import id of remote course Return 0 if object isn't imported. More...

	updateCourseData ($course, $obj_id)
	Update course data. More...

	createCourseData ($course)
	Create course data from json. More...

	createCourseReference ($crs, $a_parent_obj_id)
	Create course reference. More...

	setImported ($a_content_id, $object, $a_ecs_id=0, $a_sub_id=null)
	Set new course object imported. More...

	addUrlEntry ($a_obj_id)
	Add an url entry. More...

	handleCourseUrlUpdate ()
	Update course url. More...

Protected Attributes
	$log

Private Attributes
	$server = null

	$mapping = null

	$course_url = null

	$object_created = false

	$courses_created = array()

	$mid

Detailed Description

Description of class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilECSCourseCreationHandler::__construct	(	ilECSSetting	$server,
			$a_mid
	)

Constructor

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

References $GLOBALS, $server, ilECSNodeMappingSettings\getInstanceByServerMid(), getMid(), and getServer().

         {
                 $this->log = $GLOBALS['DIC']->logger()->wsrv();
                 
                 $this->server = $server;
                 $this->mid = $a_mid;
                 $this->mapping = ilECSNodeMappingSettings::getInstanceByServerMid($this->getServer()->getServerId(), $this->getMid());
                 
                 include_once './Services/WebServices/ECS/classes/Course/class.ilECSCourseUrl.php';
                 $this->course_url = new ilECSCourseUrl();
         }

Here is the call graph for this function:

Member Function Documentation

◆ addUrlEntry()

ilECSCourseCreationHandler::addUrlEntry ( $a_obj_id )

protected

Add an url entry.

Parameters

type $a_obj_id

Definition at line 751 of file class.ilECSCourseCreationHandler.php.

References $ref_id, ilObject\_getAllReferences(), ilLink\_getLink(), ilObject\_lookupTitle(), and getCourseUrl().

Referenced by createCourseReference(), updateParallelCourses(), and updateParallelGroups().

         {
                 $refs = ilObject::_getAllReferences($a_obj_id);
                 $ref_id = end($refs);
                 
                 if(!$ref_id)
                 {
                         return false;
                 }
                 include_once './Services/WebServices/ECS/classes/Course/class.ilECSCourseLmsUrl.php';
                 $lms_url = new ilECSCourseLmsUrl();
                 $lms_url->setTitle(ilObject::_lookupTitle($a_obj_id));
                 
                 include_once './Services/Link/classes/class.ilLink.php';
                 $lms_url->setUrl(ilLink::_getLink($ref_id));
                 $this->getCourseUrl()->addLmsCourseUrls($lms_url);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCourseData()

ilECSCourseCreationHandler::createCourseData ( $course )

protected

Create course data from json.

Returns: ilObjCourse

Definition at line 689 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, and $title.

Referenced by doSync().

         {
                 include_once './Modules/Course/classes/class.ilObjCourse.php';
                 $course_obj = new ilObjCourse();
                 $course_obj->setOwner(SYSTEM_USER_ID);
                 $title = $course->title;
                 $GLOBALS['ilLog']->write(__METHOD__.': Creating new course instance from ecs : '. $title);
                 $course_obj->setTitle($title);
                 $course_obj->create();
                 return $course_obj;
         }

Here is the caller graph for this function:

◆ createCourseReference()

ilECSCourseCreationHandler::createCourseReference	(	$crs,
		$a_parent_obj_id
	)

protected

Create course reference.

Parameters

ilObjCourse	$crs_obj
int	$a_parent_obj_id

Returns: ilObjCourse

Definition at line 707 of file class.ilECSCourseCreationHandler.php.

References $ref_id, ilObject\_getAllReferences(), addUrlEntry(), and setObjectCreated().

Referenced by createParallelCourse(), and doSync().

         {
                 $ref_ids = ilObject::_getAllReferences($a_parent_obj_id);
                 $ref_id = end($ref_ids);
                 
                 $crs->createReference();
                 $crs->putInTree($ref_id);
                 $crs->setPermissions($ref_id);
                 
                 $this->setObjectCreated(true);
                 $this->addUrlEntry($crs->getId());
                 
                 $this->courses_created[] = $crs->getRefId();
                 
                 return $crs;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCourseReferenceObjects()

ilECSCourseCreationHandler::createCourseReferenceObjects ( $a_parent_ref_id )

protected

Create course reference objects.

Parameters

type $a_parent_ref_id

Definition at line 249 of file class.ilECSCourseCreationHandler.php.

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and getCreatedCourses().

Referenced by doAttributeMapping().

         {
                 foreach($this->getCreatedCourses() as $ref_id)
                 {
                         include_once './Modules/CourseReference/classes/class.ilObjCourseReference.php';
                         $crsr = new ilObjCourseReference();
                         $crsr->setOwner(SYTEM_USER_ID);
                         $crsr->setTargetRefId($ref_id);
                         $crsr->setTargetId(ilObject::_lookupObjId($ref_id));
                         $crsr->create();
                         $crsr->update();
                         $crsr->createReference();
                         $crsr->putInTree($a_parent_ref_id);
                         $crsr->setPermissions($a_parent_ref_id);
                         
                         $this->log->debug('Created new course reference in : ' . ilObject::_lookupTitle(ilObject::_lookupObjId($a_parent_ref_id)));
                         $this->log->debug('Created new course reference for : ' . ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createParallelCourse()

ilECSCourseCreationHandler::createParallelCourse	(	$a_content_id,
		$course,
		$group,
		$parent_ref
	)

protected

Create parallel course.

Parameters

type	$course
type	$group
type	$parent_ref

Definition at line 502 of file class.ilECSCourseCreationHandler.php.

References $title, ilObject\_lookupObjId(), createCourseReference(), getImportId(), setImported(), and setObjectCreated().

Referenced by createParallelCourses(), and updateParallelCourses().

         {
                 if($this->getImportId($course->lectureID, $group->id))
                 {
                         $this->log->debug('Parallel course already created');
                         return false;
                 }
                 
                 include_once './Modules/Course/classes/class.ilObjCourse.php';
                 $course_obj = new ilObjCourse();
                 $course_obj->setOwner(SYSTEM_USER_ID);
                 $title = $course->title;
                 if(strlen($group->title))
                 {
                         $title .= ' ('.$group->title.')';
                 }
                 $this->log->debug('Creating new parallel course instance from ecs : '. $title);
                 $course_obj->setTitle($title);
                 $course_obj->setSubscriptionMaxMembers((int) $group->maxParticipants);
                 $course_obj->create();
                 
                 $this->createCourseReference($course_obj, ilObject::_lookupObjId($parent_ref));
                 $this->setImported($course->lectureID, $course_obj,$a_content_id, $group->id);
                 $this->setObjectCreated(true);
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createParallelCourses()

ilECSCourseCreationHandler::createParallelCourses	(	$a_content_id,
		$course,
		$parent_ref
	)

protected

Create parallel courses.

Parameters

	int	econtent id
type	$course
type	$parent_ref

Definition at line 487 of file class.ilECSCourseCreationHandler.php.

References array, and createParallelCourse().

Referenced by doSync().

         {
                 foreach((array) $course->groups as $group)
                 {
                         $this->createParallelCourse($a_content_id,$course, $group, $parent_ref);
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createParallelGroup()

ilECSCourseCreationHandler::createParallelGroup	(	$a_content_id,
		$course,
		$group,
		$parent_ref
	)

protected

Create parallel group.

Parameters

type	$course
type	$group

Definition at line 590 of file class.ilECSCourseCreationHandler.php.

References $title, GRP_TYPE_CLOSED, setImported(), and setObjectCreated().

Referenced by createParallelGroups(), and updateParallelGroups().

         {
                 include_once './Modules/Group/classes/class.ilObjGroup.php';
                 $group_obj = new ilObjGroup();
                 $group_obj->setOwner(SYSTEM_USER_ID);
                 $title = strlen($group->title) ? $group->title : $course->title;
                 $group_obj->setTitle($title);
                 $group_obj->setMaxMembers((int) $group->maxParticipants);
                 $group_obj->create();
                 $group_obj->createReference();
                 $group_obj->putInTree($parent_ref);
                 $group_obj->setPermissions($parent_ref);
                 $group_obj->initGroupStatus(GRP_TYPE_CLOSED);
                 $this->setImported($course->lectureID, $group_obj, $a_content_id, $group->id);
                 $this->setObjectCreated(true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createParallelGroups()

ilECSCourseCreationHandler::createParallelGroups	(	$a_content_id,
		$course,
		$parent_ref
	)

protected

This create parallel groups.

Parameters

type	$course
	ilObjCourse

Definition at line 576 of file class.ilECSCourseCreationHandler.php.

References array, and createParallelGroup().

Referenced by doSync().

         {
                 foreach((array) $course->groups as $group)
                 {
                         $this->createParallelGroup($a_content_id,$course, $group, $parent_ref);
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doAttributeMapping()

ilECSCourseCreationHandler::doAttributeMapping	(	$a_content_id,
		$course
	)

protected

Sync attribute mapping.

Parameters

type	$a_content_id
type	$course

Definition at line 155 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupObjId(), createCourseReferenceObjects(), ilLogLevel\DEBUG, ilECSCourseMappingRule\doMappings(), doSync(), getImportId(), getMapping(), getMid(), ilECSCourseMappingRule\getRuleRefIds(), getServer(), and ilECSCourseMappingRule\isMatching().

Referenced by handle().

         {
                 // Check if course is already created
                 $course_id = $course->lectureID;
                 $obj_id = $this->getImportId($course_id);
                 
                 if($obj_id)
                 {
                         // do update
                         $this->log->debug('Performing update of already imported course.');
                         
                         $refs = ilObject::_getAllReferences($obj_id);
                         $ref = end($refs);
                         
                         $this->doSync(
                                 $a_content_id, 
                                 $course,
                                 ilObject::_lookupObjId($GLOBALS['tree']->getParentId($ref))
                         );
                         return true;
                 }
                 
                 // Get all rules
                 $matching_rules =  [];
                 include_once './Services/WebServices/ECS/classes/Course/class.ilECSCourseMappingRule.php';
                 foreach(ilECSCourseMappingRule::getRuleRefIds($this->getServer()->getServerId(), $this->getMid()) as $ref_id)
                 {
                         $matching_index = ilECSCourseMappingRule::isMatching(
                                         $course,
                                         $this->getServer()->getServerId(),
                                         $this->getMid(),
                                         $ref_id);
                         if(strcmp($matching_index, '0') !== 0)
                         {
                                 $matching_rules[$matching_index] = $ref_id;
                         }
                 }
                 ksort($matching_rules);
                 
                 $this->log->dump($matching_rules);
                 
                 if(!count($matching_rules))
                 {
                         // Put course in default category
                         $this->log->debug('No matching attribute mapping rule found.');
                         $this->log->info('Using course default category');
                         $this->doSync($a_content_id,$course,ilObject::_lookupObjId($this->getMapping()->getDefaultCourseCategory()));
                         return true;
                 }
                 
                 $this->log->debug('Matching rules:');
                 $this->log->dump($matching_rules,  ilLogLevel::DEBUG);
                 
                 $all_parent_refs = [];
                 foreach($matching_rules as $matching_rule)
                 {
                         $this->log->debug('Handling matching rule: '. $matching_rule);
                         $parent_refs = ilECSCourseMappingRule::doMappings($course,$this->getServer()->getServerId(),$this->getMid(),$matching_rule);
                         // map according mapping rules
                         $this->log->debug('Adding parent references: ');
                         $this->log->dump($parent_refs);
                         
                         if(count($parent_refs))
                         {
                                 $all_parent_refs = array_unique(array_merge($all_parent_refs,$parent_refs));
                         }
                 }
                 
                 // parent refs are an array of created categories
                 // the first ref should contain the main course or parallel courses.
                 // all other refs wil contain course references.
                 $first = true;
                 foreach($all_parent_refs as $category_ref)
                 {
                         if($first)
                         {
                                 $this->log->debug('Creating new course instance in: ' . $category_ref);
                                 $this->doSync($a_content_id, $course, ilObject::_lookupObjId($category_ref));
                                 $first = false;
                                 continue;
                         }
                         else
                         {
                                 $this->log->debug('Creating new course reference instance in: ' . $category_ref);
                                 $this->createCourseReferenceObjects($category_ref);
                         }
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doSync()

ilECSCourseCreationHandler::doSync	(	$a_content_id,
		$course,
		$a_parent_obj_id
	)

protected

Handle all in one setting.

Parameters

type	$a_content_id
type	$course

Returns: array created course reference references

Definition at line 395 of file class.ilECSCourseCreationHandler.php.

References ilObject\_getAllReferences(), createCourseData(), createCourseReference(), createParallelCourses(), createParallelGroups(), getCourseUrl(), getImportId(), handleCourseUrlUpdate(), ilECSMappingUtils\PARALLEL_ALL_COURSES, ilECSMappingUtils\PARALLEL_COURSES_FOR_LECTURERS, ilECSMappingUtils\PARALLEL_GROUPS_IN_COURSE, ilECSMappingUtils\PARALLEL_ONE_COURSE, setImported(), updateCourseData(), updateParallelCourses(), and updateParallelGroups().

Referenced by doAttributeMapping(), and handle().

         {
                 // Check if course is already created
                 $course_id = $course->lectureID;
                 $this->getCourseUrl()->setCmsLectureId($course_id);
                 
                 $obj_id = $this->getImportId($course_id);
                 
                 $this->log->debug('Found obj_id '.$obj_id. ' for course_id '. $course_id );
                 
                 // Handle parallel groups
                 if($obj_id)
                 {
                         // update multiple courses/groups according to parallel scenario
                         $this->log->debug('Group scenario '.$course->groupScenario);
                         include_once './Services/WebServices/ECS/classes/Mapping/class.ilECSMappingUtils.php';
                         switch((int) $course->groupScenario)
                         {
                                 case ilECSMappingUtils::PARALLEL_GROUPS_IN_COURSE:
                                         $this->log->debug('Performing update for parallel groups in course.');
                                         $this->updateParallelGroups($a_content_id,$course, $obj_id);
                                         break;
                                 
                                 case ilECSMappingUtils::PARALLEL_ALL_COURSES:
                                         $this->log->debug('Performing update for parallel courses.');
                                         $this->updateParallelCourses($a_content_id,$course, $a_parent_obj_id);
                                         break;
                                 
                                 case ilECSMappingUtils::PARALLEL_ONE_COURSE:
                                 default:
                                         // nothing to do
                                         break;
                                 
                         }
                         
                         // do update
                         $this->updateCourseData($course,$obj_id);
                 }
                 else
                 {
                         include_once './Services/WebServices/ECS/classes/Mapping/class.ilECSMappingUtils.php';
                         switch((int) $course->groupScenario)
                         {
                                 case ilECSMappingUtils::PARALLEL_GROUPS_IN_COURSE:
                                         $this->log->debug('Parallel scenario "groups in courses".');
                                         $crs = $this->createCourseData($course);
                                         $crs = $this->createCourseReference($crs, $a_parent_obj_id);
                                         $this->setImported($course_id, $crs, $a_content_id);
 
                                         // Create parallel groups under crs
                                         $this->createParallelGroups($a_content_id,$course,$crs->getRefId());
                                         break;
                                 
                                 case ilECSMappingUtils::PARALLEL_COURSES_FOR_LECTURERS:
                                         $this->log->debug('Parallel scenario "Courses foreach Lecturer".');
                                         // Import empty to store the ecs ressource id (used for course member update).
                                         $this->setImported($course_id,NULL,$a_content_id);
                                         break;
 
                                 case ilECSMappingUtils::PARALLEL_ALL_COURSES:
                                         $this->log->debug('Parallel scenario "Many courses".');
                                         $refs = ilObject::_getAllReferences($a_parent_obj_id);
                                         $ref = end($refs);
                                         // do not create master course for this scenario
                                         //$crs = $this->createCourseData($course);
                                         //$this->createCourseReference($crs, $a_parent_obj_id);
                                         //$this->setImported($course_id, $crs, $a_content_id);
                                         $this->createParallelCourses($a_content_id,$course, $ref);
                                         break;
                                         
                                 default:
                                 case ilECSMappingUtils::PARALLEL_ONE_COURSE:
                                         $this->log->debug('Parallel scenario "One Course".');
                                         $crs = $this->createCourseData($course);
                                         $this->createCourseReference($crs, $a_parent_obj_id);
                                         $this->setImported($course_id, $crs, $a_content_id);
                                         break;
                                 
                                         
                         }
                 }
                 // finally update course urls
                 $this->handleCourseUrlUpdate();
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCourseUrl()

ilECSCourseCreationHandler::getCourseUrl ( )

Get course url.

Returns: ilECSCourseUrl Description

Definition at line 70 of file class.ilECSCourseCreationHandler.php.

References $course_url.

Referenced by addUrlEntry(), doSync(), handle(), and handleCourseUrlUpdate().

         {
                 return $this->course_url;
         }

Here is the caller graph for this function:

◆ getCreatedCourses()

ilECSCourseCreationHandler::getCreatedCourses ( )

protected

get created courses

Returns: array

Definition at line 97 of file class.ilECSCourseCreationHandler.php.

References $courses_created.

Referenced by createCourseReferenceObjects().

         {
                 return $this->courses_created;
         }

Here is the caller graph for this function:

◆ getImportId()

ilECSCourseCreationHandler::getImportId	(	$a_content_id,
		$a_sub_id = `NULL`
	)

protected

Get import id of remote course Return 0 if object isn't imported.

Searches for the (hopefully) unique content id of an imported object

Parameters

type $a_content_id

Returns: type

Definition at line 649 of file class.ilECSCourseCreationHandler.php.

References getMid(), getServer(), and ilECSImport\lookupObjIdByContentId().

Referenced by createParallelCourse(), doAttributeMapping(), doSync(), syncNodeToTop(), updateParallelCourses(), and updateParallelGroups().

         {
                 include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
                 return ilECSImport::lookupObjIdByContentId(
                                 $this->getServer()->getServerId(),
                                 $this->getMid(),
                                 $a_content_id,
                                 $a_sub_id
                 );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMapping()

ilECSCourseCreationHandler::getMapping ( )

Get mapping settings.

Returns: ilECSNodeMappingSettings

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

References $mapping.

Referenced by doAttributeMapping(), and handle().

         {
                 return $this->mapping;
         }

Here is the caller graph for this function:

◆ getMid()

ilECSCourseCreationHandler::getMid ( )

Get mid of course event.

Returns: type

Definition at line 106 of file class.ilECSCourseCreationHandler.php.

References $mid.

Referenced by __construct(), doAttributeMapping(), getImportId(), handleCourseUrlUpdate(), setImported(), syncCategory(), syncNodeToTop(), and syncParentContainer().

         {
                 return $this->mid;
         }

Here is the caller graph for this function:

◆ getServer()

ilECSCourseCreationHandler::getServer ( )

Get server settings.

Returns: ilECSSetting

Definition at line 52 of file class.ilECSCourseCreationHandler.php.

References $server.

Referenced by __construct(), doAttributeMapping(), getImportId(), handleCourseUrlUpdate(), setImported(), syncCategory(), syncNodeToTop(), and syncParentContainer().

         {
                 return $this->server;
         }

Here is the caller graph for this function:

◆ handle()

ilECSCourseCreationHandler::handle	(	$a_content_id,
		$course
	)

Handle sync request.

Parameters

	int	ecs content id
type	$course

Definition at line 116 of file class.ilECSCourseCreationHandler.php.

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), doAttributeMapping(), doSync(), getCourseUrl(), getMapping(), setObjectCreated(), and syncParentContainer().

         {
                 // prepare course url
                 // if any object (course group) will be created, a list of all course urls
                 // will be sent to ecs.
                 $this->setObjectCreated(false);
                 $this->getCourseUrl()->setECSId($a_content_id);
                 
                 
                 if($this->getMapping()->isAttributeMappingEnabled())
                 {
                         $this->log->debug('Handling advanced attribute mapping');
                         return $this->doAttributeMapping($a_content_id,$course);
                 }
                 
                 if($this->getMapping()->isAllInOneCategoryEnabled())
                 {
                         $this->log->debug('Handling course all in one category setting');
                         $this->doSync($a_content_id, $course,ilObject::_lookupObjId($this->getMapping()->getAllInOneCategory()));
                         return true;
                 }
 
                 $parent_obj_id = $this->syncParentContainer($a_content_id,$course);
                 if($parent_obj_id)
                 {
                         $this->log->info('Using already mapped category: '. ilObject::_lookupTitle($parent_obj_id));
                         $this->doSync($a_content_id,$course,$parent_obj_id);
                         return true;
                 }
                 $this->log->info('Using course default category');
                 $this->doSync($a_content_id,$course,ilObject::_lookupObjId($this->getMapping()->getDefaultCourseCategory()));
                 return true;
         }

Here is the call graph for this function:

◆ handleCourseUrlUpdate()

ilECSCourseCreationHandler::handleCourseUrlUpdate ( )

protected

Update course url.

Definition at line 772 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, getCourseUrl(), getMid(), getServer(), and isObjectCreated().

Referenced by doSync().

         {
                 $GLOBALS['ilLog']->write(__METHOD__.': Starting course url update');
                 if($this->isObjectCreated())
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': Sending new course group url');
                         $this->getCourseUrl()->send($this->getServer(), $this->getMid());
                 }
                 else
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': No courses groups created. Aborting');
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isObjectCreated()

ilECSCourseCreationHandler::isObjectCreated ( )

Check if an object (course / group) has been created.

Returns: bool

Definition at line 79 of file class.ilECSCourseCreationHandler.php.

References $object_created.

Referenced by handleCourseUrlUpdate().

         {
                 return $this->object_created;
         }

Here is the caller graph for this function:

◆ setImported()

ilECSCourseCreationHandler::setImported	(	$a_content_id,
		$object,
		$a_ecs_id = `0`,
		$a_sub_id = `null`
	)

protected

Set new course object imported.

Parameters

int	$a_content_id
ilObjCourse	$crs

Definition at line 729 of file class.ilECSCourseCreationHandler.php.

References getMid(), getServer(), and ilECSImport\setSubId().

Referenced by createParallelCourse(), createParallelGroup(), and doSync().

         {
                 include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
                 $import = new ilECSImport(
                                 $this->getServer()->getServerId(),
                                 is_object($object) ? $object->getId() : 0
                 );
 
                 
                 $import->setSubId($a_sub_id);
                 $import->setMID($this->getMid());
                 $import->setEContentId($a_ecs_id);
                 $import->setContentId($a_content_id);
                 $import->setImported(true);
                 $import->save();
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjectCreated()

ilECSCourseCreationHandler::setObjectCreated ( $a_status )

Set object created status.

Parameters

bool $a_status

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

Referenced by createCourseReference(), createParallelCourse(), createParallelGroup(), and handle().

         {
                 $this->object_created = $a_status;
         }

Here is the caller graph for this function:

◆ syncCategory()

ilECSCourseCreationHandler::syncCategory	(	$tobj_id,
		$parent_ref_id
	)

protected

Sync category.

Parameters

type	$tobj_id
type	$parent_ref_id

Definition at line 355 of file class.ilECSCourseCreationHandler.php.

References $data, $GLOBALS, getMid(), getServer(), and ilECSImport\setMID().

Referenced by syncNodeToTop().

         {
                 include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsData.php';
                 $data = new ilECSCmsData($tobj_id);
                 
                 include_once './Modules/Category/classes/class.ilObjCategory.php';
                 $cat = new ilObjCategory();
                 $cat->setOwner(SYSTEM_USER_ID);
                 $cat->setTitle($data->getTitle());
                 $cat->create(); // true for upload
                 $cat->createReference();
                 $cat->putInTree($parent_ref_id);
                 $cat->setPermissions($parent_ref_id);
                 $cat->deleteTranslation($GLOBALS['lng']->getDefaultLanguage());
                 $cat->addTranslation(
                                 $data->getTitle(),
                                 $cat->getLongDescription(),
                                 $GLOBALS['lng']->getDefaultLanguage(),
                                 1
                 );
                         
                 // set imported
                 $import = new ilECSImport(
                         $this->getServer()->getServerId(),
                         $cat->getId()
                 );
                 $import->setMID($this->getMid());
                 $import->setContentId($data->getCmsId());
                 $import->setImported(true);
                 $import->save();
                 
                 return $cat->getId();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ syncNodeToTop()

ilECSCourseCreationHandler::syncNodeToTop	(	$tree_id,
		$cms_id
	)

protected

Sync node to top.

Parameters

type	$tree_id
type	$parent_id

Returns: int obj_id of container

Definition at line 299 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, $ref_id, ilObject\_getAllReferences(), array, getImportId(), getMid(), getServer(), ilECSCmsData\lookupCmsIds(), ilECSCmsData\lookupObjId(), and syncCategory().

         {
                 $obj_id = $this->getImportId($cms_id);
                 if($obj_id)
                 {
                         // node already imported
                         return $obj_id;
                 }
 
                 $tobj_id = ilECSCmsData::lookupObjId(
                                 $this->getServer()->getServerId(), 
                                 $this->getMid(), 
                                 $tree_id, 
                                 $cms_id);
                 
                 // node is not imported
                 $GLOBALS['ilLog']->write(__METHOD__.': ecs node with id '. $cms_id. ' is not imported for mid ' . $this->getMid().' tree_id '.$tree_id);
                 
                 // check for mapping: if mapping is available create category
                 include_once './Services/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingAssignment.php';
                 $ass = new ilECSNodeMappingAssignment(
                                 $this->getServer()->getServerId(),
                                 $this->getMid(),
                                 $tree_id,
                                 $tobj_id);
                 
                 if($ass->isMapped())
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': node is mapped');
                         return $this->syncCategory($tobj_id,$ass->getRefId());
                 }
                 
                 // Start recursion to top
                 include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsTree.php';
                 $tree = new ilECSCmsTree($tree_id);
                 $parent_tobj_id = $tree->getParentId($tobj_id);
                 if($parent_tobj_id)
                 {
                         $cms_ids = ilECSCmsData::lookupCmsIds(array($parent_tobj_id));
                         $obj_id = $this->syncNodeToTop($tree_id, $cms_ids[0]);
                 }
                 
                 if($obj_id)
                 {
                         $refs = ilObject::_getAllReferences($obj_id);
                         $ref_id = end($refs);
                         return $this->syncCategory($tobj_id, $ref_id);
                 }
                 return 0;
         }

Here is the call graph for this function:

◆ syncParentContainer()

ilECSCourseCreationHandler::syncParentContainer	(	$a_content_id,
		$course
	)

protected

Sync parent container.

Parameters

type	$a_content_id
type	$course

Definition at line 274 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, getMid(), getServer(), and ilECSCmsData\lookupFirstTreeOfNode().

Referenced by handle().

         {
                 if(!is_array($course->allocations))
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': No allocation in course defined.');
                         return 0;
                 }
                 if(!$course->allocations[0]->parentID)
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': No allocation parent in course defined.');
                         return 0;
                 }
                 $parent_id = $course->allocations[0]->parentID;
                 
                 include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsData.php';
                 $parent_tid = ilECSCmsData::lookupFirstTreeOfNode($this->getServer()->getServerId(), $this->getMid(), $parent_id);
                 return $this->syncNodetoTop($parent_tid, $parent_id);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCourseData()

ilECSCourseCreationHandler::updateCourseData	(	$course,
		$obj_id
	)

protected

Update course data.

Parameters

type $course

Definition at line 664 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, $ref_id, $title, ilObject\_getAllReferences(), and ilObjectFactory\getInstanceByRefId().

Referenced by doSync().

         {
                 // do update
                 $refs = ilObject::_getAllReferences($obj_id);
                 $ref_id = end($refs);
                 $crs_obj = ilObjectFactory::getInstanceByRefId($ref_id,false);
                 if(!$crs_obj instanceof ilObject)
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': Cannot instantiate course instance');
                         return true;
                 }
                         
                 // Update title
                 $title = $course->title;
                 $GLOBALS['ilLog']->write(__METHOD__.': new title is : '. $title);
                         
                 $crs_obj->setTitle($title);
                 $crs_obj->update();
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateParallelCourses()

ilECSCourseCreationHandler::updateParallelCourses	(	$a_content_id,
		$course,
		$parent_obj
	)

protected

Update parallel group data.

Parameters

type	$course
type	$parent_obj

Definition at line 534 of file class.ilECSCourseCreationHandler.php.

References $title, ilObject\_getAllReferences(), addUrlEntry(), array, createParallelCourse(), getImportId(), and ilObjectFactory\getInstanceByObjId().

Referenced by doSync().

         {
                 $parent_refs = ilObject::_getAllReferences($parent_obj);
                 $parent_ref = end($parent_refs);
                 
                 foreach((array) $course->groups as $group)
                 {
                         $title = $course->title;
                         if(strlen($group->title))
                         {
                                 $title .= ' ('.$group->title.')';
                         }
                         
                         $obj_id = $this->getImportId($course->lectureID, $group->id);
                         $this->log->debug('Imported obj id is ' .$obj_id);
                         if(!$obj_id)
                         {
                                 $this->createParallelCourse($a_content_id, $course, $group, $parent_ref);
                         }
                         else
                         {
                                 $course_obj = ilObjectFactory::getInstanceByObjId($obj_id,false);
                                 if($course_obj instanceof ilObjCourse)
                                 {
                                         $this->log->debug('New title is '. $title);
                                         $course_obj->setTitle($title);
                                         $course_obj->setSubscriptionMaxMembers($group->maxParticipants);
                                         $course_obj->update();
                                 }
                         }
                         $this->addUrlEntry($this->getImportId($course->lectureID, $group->ID));
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateParallelGroups()

ilECSCourseCreationHandler::updateParallelGroups	(	$a_content_id,
		$course,
		$parent_obj
	)

protected

Update parallel group data.

Parameters

type	$course
type	$parent_obj

Definition at line 613 of file class.ilECSCourseCreationHandler.php.

References $GLOBALS, $title, ilObject\_getAllReferences(), addUrlEntry(), array, createParallelGroup(), getImportId(), and ilObjectFactory\getInstanceByObjId().

Referenced by doSync().

         {
                 $parent_refs = ilObject::_getAllReferences($parent_obj);
                 $parent_ref = end($parent_refs);
                 
                 foreach((array) $course->groups as $group)
                 {
                         $obj_id = $this->getImportId($course->lectureID, $group->id);
                         $this->log->debug('Imported obj id is ' .$obj_id);
                         if(!$obj_id)
                         {
                                 $this->createParallelGroup($a_content_id,$course, $group, $parent_ref);
                         }
                         else
                         {
                                 $group_obj = ilObjectFactory::getInstanceByObjId($obj_id,false);
                                 if($group_obj instanceof ilObjGroup)
                                 {
                                         $title = strlen($group->title) ? $group->title : $course->title;
                                         $GLOBALS['ilLog']->write(__METHOD__.': New title is '. $title);
                                         $group_obj->setTitle($title);
                                         $group_obj->setMaxMembers((int) $group->maxParticipants);
                                         $group_obj->update();
                                 }
                         }
                         $this->addUrlEntry($this->getImportId($course->lectureID, $group->id));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $course_url

ilECSCourseCreationHandler::$course_url = null

private

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

Referenced by getCourseUrl().

◆ $courses_created

ilECSCourseCreationHandler::$courses_created = array()

private

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

Referenced by getCreatedCourses().

◆ $log

ilECSCourseCreationHandler::$log

protected

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

◆ $mapping

ilECSCourseCreationHandler::$mapping = null

private

Definition at line 23 of file class.ilECSCourseCreationHandler.php.

Referenced by getMapping().

◆ $mid

ilECSCourseCreationHandler::$mid

private

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

Referenced by getMid().

◆ $object_created

ilECSCourseCreationHandler::$object_created = false

private

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

Referenced by isObjectCreated().

◆ $server

ilECSCourseCreationHandler::$server = null

private

Definition at line 22 of file class.ilECSCourseCreationHandler.php.

Referenced by __construct(), and getServer().

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

Services/WebServices/ECS/classes/Course/class.ilECSCourseCreationHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUrlEntry()

◆ createCourseData()

◆ createCourseReference()

◆ createCourseReferenceObjects()

◆ createParallelCourse()

◆ createParallelCourses()

◆ createParallelGroup()

◆ createParallelGroups()

◆ doAttributeMapping()

◆ doSync()

◆ getCourseUrl()

◆ getCreatedCourses()

◆ getImportId()

◆ getMapping()

◆ getMid()

◆ getServer()

◆ handle()

◆ handleCourseUrlUpdate()

◆ isObjectCreated()

◆ setImported()

◆ setObjectCreated()

◆ syncCategory()

◆ syncNodeToTop()

◆ syncParentContainer()

◆ updateCourseData()

◆ updateParallelCourses()

◆ updateParallelGroups()

Field Documentation

◆ $course_url

◆ $courses_created

◆ $log

◆ $mapping

◆ $mid

◆ $object_created

◆ $server