ilECSCourseCreationHandler Class Reference

Collaboration diagram for ilECSCourseCreationHandler:

Public Member Functions
	__construct (ilECSSetting $server, int $a_mid)
	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 (bool $a_status)
	Set object created status. More...
	getMid ()
	Get mid of course event. More...
	handle (int $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 (int $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 (int $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, int $parent_obj)
	Update parallel group data. More...
	getImportId (int $a_content_id, string $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 (ilObjCourse $crs, int $a_parent_obj_id)
	Create course reference. More...
	setImported (int $a_content_id, $object, $a_ecs_id=0, $a_sub_id=null)
	Set new course object imported. More...
	addUrlEntry (int $a_obj_id)
	Add an url entry. More...
	handleCourseUrlUpdate ()
	Update course url. More...

Private Attributes
ilLogger	$logger
ilLanguage	$lng
ilTree	$tree
ilECSSetting	$server
ilECSNodeMappingSettings	$mapping
ilECSCourseUrl	$course_url = null
bool	$object_created = false
array	$courses_created = array()
int	$mid

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, $server, ilECSNodeMappingSettings\getInstanceByServerMid(), getMid(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

    {
        global $DIC;

        $this->logger = $DIC->logger()->wsrv();
        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();

        $this->server = $server;
        $this->mid = $a_mid;
        $this->mapping = ilECSNodeMappingSettings::getInstanceByServerMid($this->server->getServerId(), $this->getMid());

        $this->course_url = new ilECSCourseUrl();
    }

Here is the call graph for this function:

Member Function Documentation

addUrlEntry()

ilECSCourseCreationHandler::addUrlEntry ( int  $a_obj_id )

protected

Add an url entry.

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

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

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

                                                 : bool
    {
        $refs = ilObject::_getAllReferences($a_obj_id);
        $ref_id = end($refs);

        if (!$ref_id) {
            return false;
        }
        $lms_url = new ilECSCourseLmsUrl();
        $lms_url->setTitle(ilObject::_lookupTitle($a_obj_id));

        $lms_url->setUrl(ilLink::_getLink($ref_id));
        $this->course_url->addLmsCourseUrls($lms_url);
        return true;
    }

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.

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

References ILIAS\Repository\logger(), and SYSTEM_USER_ID.

Referenced by doSync().

                                                : \ilObjCourse
    {
        $course_obj = new ilObjCourse();
        $course_obj->setOwner(SYSTEM_USER_ID);
        $title = $course->title;
        $this->logger->debug('Creating new course instance from ecs : ' . $title);
        $course_obj->setTitle($title);
        $course_obj->setOfflineStatus(true);
        $course_obj->create();
        return $course_obj;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createCourseReference()

ilECSCourseCreationHandler::createCourseReference ( ilObjCourse  $crs, int  $a_parent_obj_id  )

protected

Create course reference.

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

References $ref_id, ilObject\_getAllReferences(), addUrlEntry(), ilObject\createReference(), ilObject\getId(), ilObject\getRefId(), ilContainer\putInTree(), setObjectCreated(), and ilObject\setPermissions().

Referenced by createParallelCourse(), and doSync().

                                                                                    : \ilObjCourse
    {
        $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 ( int  $a_parent_ref_id )

protected

Create course reference objects.

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

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), getCreatedCourses(), ILIAS\Repository\logger(), and SYSTEM_USER_ID.

Referenced by doAttributeMapping().

                                                                         : void
    {
        $this->logger->debug('Created new course reference in : ' . ilObject::_lookupTitle(ilObject::_lookupObjId($a_parent_ref_id)));
        foreach ($this->getCreatedCourses() as $ref_id) {
            $crsr = new ilObjCourseReference();
            $crsr->setOwner(SYSTEM_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->logger->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.

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

References ilObject\_lookupObjId(), createCourseReference(), getImportId(), ILIAS\Repository\logger(), setImported(), setObjectCreated(), and SYSTEM_USER_ID.

Referenced by createParallelCourses(), and updateParallelCourses().

                                                                                        : bool
    {
        if ($this->getImportId((int) $course->lectureID, (string) $group->id)) {
            $this->logger->debug('Parallel course already created');
            return false;
        }

        $course_obj = new ilObjCourse();
        $course_obj->setOwner(SYSTEM_USER_ID);
        $title = $course->title;
        if ($group->title !== '') {
            $title .= ' (' . $group->title . ')';
        }
        $this->logger->debug('Creating new parallel course instance from ecs : ' . $title);
        $course_obj->setTitle($title);
        $course_obj->setSubscriptionMaxMembers((int) $group->maxParticipants);
        $course_obj->setOfflineStatus(true);
        $course_obj->create();

        $this->createCourseReference($course_obj, ilObject::_lookupObjId($parent_ref));
        $this->setImported((int) $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 ( int  $a_content_id,   $course,   $parent_ref  )

protected

Create parallel courses.

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

References createParallelCourse().

Referenced by doSync().

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

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

References ilGroupConstants\GRP_TYPE_CLOSED, setImported(), setObjectCreated(), and SYSTEM_USER_ID.

Referenced by createParallelGroups(), and updateParallelGroups().

                                                                                       : void
    {
        $group_obj = new ilObjGroup();
        $group_obj->setOwner(SYSTEM_USER_ID);
        $title = $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->updateGroupType(ilGroupConstants::GRP_TYPE_CLOSED);
        $this->setImported((int) $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.

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

References createParallelGroup().

Referenced by doSync().

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

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

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

Referenced by handle().

                                                                 : bool
    {
        // Check if course is already created
        $course_id = $course->lectureID;
        $obj_id = $this->getImportId((int) $course_id);

        if ($obj_id) {
            // do update
            $this->logger->debug('Performing update of already imported course.');

            $refs = ilObject::_getAllReferences($obj_id);
            $ref = end($refs);

            $this->doSync(
                $a_content_id,
                $course,
                ilObject::_lookupObjId($this->tree->getParentId($ref))
            );
            return true;
        }

        // Get all rules
        $matching_rules = [];
        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->logger->dump($matching_rules);

        if (!count($matching_rules)) {
            // Put course in default category
            $this->logger->debug('No matching attribute mapping rule found.');
            $this->logger->info('Using course default category');
            $this->doSync($a_content_id, $course, ilObject::_lookupObjId($this->getMapping()->getDefaultCourseCategory()));
            return true;
        }

        $this->logger->debug('Matching rules:');
        $this->logger->dump($matching_rules, ilLogLevel::DEBUG);

        $all_parent_refs = [];
        foreach ($matching_rules as $matching_rule) {
            $this->logger->debug('Handling matching rule: ' . $matching_rule);
            $parent_refs = ilECSCourseMappingRule::doMappings(
                $course,
                $this->getServer()->getServerId(),
                $this->getMid(),
                $matching_rule
            );
            // map according mapping rules
            $this->logger->debug('Adding parent references: ' . print_r($parent_refs, true));
            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->logger->debug('Creating new course instance in: ' . $category_ref);
                $this->doSync($a_content_id, $course, ilObject::_lookupObjId($category_ref));
                $first = false;
                continue;
            }
            $this->logger->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.

Returns

bool created course reference references TODO fix

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

References ilObject\_getAllReferences(), createCourseData(), createCourseReference(), createParallelCourses(), createParallelGroups(), getImportId(), handleCourseUrlUpdate(), ILIAS\Repository\logger(), 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().

                                                                       : bool
    {
        // Check if course is already created
        $course_id = $course->lectureID;
        $this->course_url->setCmsLectureId((string) $course_id);

        $obj_id = $this->getImportId((int) $course_id);

        $this->logger->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->logger->debug('Group scenario ' . $course->groupScenario);
            switch ((int) $course->groupScenario) {
                case ilECSMappingUtils::PARALLEL_GROUPS_IN_COURSE:
                    $this->logger->debug('Performing update for parallel groups in course.');
                    $this->updateParallelGroups($a_content_id, $course, $obj_id);
                    break;

                case ilECSMappingUtils::PARALLEL_ALL_COURSES:
                    $this->logger->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 {
            switch ((int) $course->groupScenario) {
                case ilECSMappingUtils::PARALLEL_GROUPS_IN_COURSE:
                    $this->logger->debug('Parallel scenario "groups in courses".');
                    $crs = $this->createCourseData($course);
                    $crs = $this->createCourseReference($crs, $a_parent_obj_id);
                    $this->setImported((int) $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->logger->debug('Parallel scenario "Courses foreach Lecturer".');
                    // Import empty to store the ecs ressource id (used for course member update).
                    $this->setImported((int) $course_id, null, $a_content_id);
                    break;

                case ilECSMappingUtils::PARALLEL_ALL_COURSES:
                    $this->logger->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->logger->debug('Parallel scenario "One Course".');
                    $crs = $this->createCourseData($course);
                    $this->createCourseReference($crs, $a_parent_obj_id);
                    $this->setImported((int) $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 75 of file class.ilECSCourseCreationHandler.php.

References $course_url.

                                  : ?\ilECSCourseUrl
    {
        return $this->course_url;
    }

getCreatedCourses()

ilECSCourseCreationHandler::getCreatedCourses ( )

protected

get created courses

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

References $courses_created.

Referenced by createCourseReferenceObjects().

                                          : array
    {
        return $this->courses_created;
    }

Here is the caller graph for this function:

getImportId()

ilECSCourseCreationHandler::getImportId ( int  $a_content_id, string  $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

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

References ilECSImportManager\getInstance(), getMid(), and getServer().

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

                                                                              : int
    {
        return ilECSImportManager::getInstance()->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 66 of file class.ilECSCourseCreationHandler.php.

References $mapping.

Referenced by doAttributeMapping(), and handle().

                                : \ilECSNodeMappingSettings
    {
        return $this->mapping;
    }

Here is the caller graph for this function:

getMid()

ilECSCourseCreationHandler::getMid

(

)

Get mid of course event.

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

References $mid.

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

                            : int
    {
        return $this->mid;
    }

Here is the caller graph for this function:

getServer()

ilECSCourseCreationHandler::getServer

(

)

Get server settings.

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

References $server.

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

                               : ilECSSetting
    {
        return $this->server;
    }

Here is the caller graph for this function:

handle()

ilECSCourseCreationHandler::handle	(	int	$a_content_id,
			$course
	)

Handle sync request.

Parameters

int

$a_content_id

ecs content id

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

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), doAttributeMapping(), doSync(), getMapping(), ILIAS\Repository\logger(), setObjectCreated(), and syncParentContainer().

                                                      : bool
    {
        // 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->course_url->setECSId($a_content_id);


        if ($this->getMapping()->isAttributeMappingEnabled()) {
            $this->logger->debug('Handling advanced attribute mapping');
            return $this->doAttributeMapping($a_content_id, $course);
        }

        if ($this->getMapping()->isAllInOneCategoryEnabled()) {
            $this->logger->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->logger->info('Using already mapped category: ' . ilObject::_lookupTitle($parent_obj_id));
            $this->doSync($a_content_id, $course, $parent_obj_id);
            return true;
        }
        $this->logger->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 692 of file class.ilECSCourseCreationHandler.php.

References getMid(), getServer(), isObjectCreated(), and ILIAS\Repository\logger().

Referenced by doSync().

                                              : void
    {
        $this->logger->debug('Starting course url update');
        if ($this->isObjectCreated()) {
            $this->logger->debug('Sending new course group url');
            $this->course_url->send($this->getServer(), $this->getMid());
        } else {
            $this->logger->debug('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.

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

References $object_created.

Referenced by handleCourseUrlUpdate().

                                     : bool
    {
        return $this->object_created;
    }

Here is the caller graph for this function:

setImported()

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

protected

Set new course object imported.

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

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

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

                                                                                               : bool
    {
        $import = new ilECSImport(
            $this->getServer()->getServerId(),
            is_object($object) ? $object->getId() : 0
        );


        $import->setSubId((string) $a_sub_id);
        $import->setMID($this->getMid());
        $import->setEContentId((string) $a_ecs_id);
        $import->setContentId((string) $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

(

bool

$a_status

)

Set object created status.

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

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

                                                    : void
    {
        $this->object_created = $a_status;
    }

Here is the caller graph for this function:

syncCategory()

ilECSCourseCreationHandler::syncCategory (   $tobj_id,   $parent_ref_id  )

protected

Sync category.

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

References $data, getMid(), getServer(), ILIAS\Repository\lng(), ilECSImport\setMID(), and SYSTEM_USER_ID.

Referenced by syncNodeToTop().

                                                             : int
    {
        $data = new ilECSCmsData($tobj_id);

        $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($this->lng->getDefaultLanguage());
        $cat->addTranslation(
            $data->getTitle(),
            $cat->getLongDescription(),
            $this->lng->getDefaultLanguage(),
            $this->lng->getDefaultLanguage()
        );

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

Returns

int obj_id of container

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

References $ref_id, ilObject\_getAllReferences(), getImportId(), getMid(), getServer(), ILIAS\Repository\logger(), ilECSCmsData\lookupCmsIds(), ilECSCmsData\lookupObjId(), and syncCategory().

                                                       : int
    {
        $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
        $this->logger->debug('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
        $ass = new ilECSNodeMappingAssignment(
            $this->getServer()->getServerId(),
            $this->getMid(),
            $tree_id,
            $tobj_id
        );

        if ($ass->isMapped()) {
            $this->logger->debug('node is mapped');
            return $this->syncCategory($tobj_id, $ass->getRefId());
        }

        // Start recursion to top
        $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.

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

References getMid(), getServer(), ILIAS\Repository\logger(), and ilECSCmsData\lookupFirstTreeOfNode().

Referenced by handle().

                                                                  : int
    {
        if (!is_array($course->allocations)) {
            $this->logger->debug('No allocation in course defined.');
            return 0;
        }
        if (!$course->allocations[0]->parentID) {
            $this->logger->debug('No allocation parent in course defined.');
            return 0;
        }
        $parent_id = $course->allocations[0]->parentID;

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

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

References $ref_id, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), and ILIAS\Repository\logger().

Referenced by doSync().

                                                         : bool
    {
        // do update
        $refs = ilObject::_getAllReferences($obj_id);
        $ref_id = end($refs);
        $crs_obj = ilObjectFactory::getInstanceByRefId($ref_id, false);
        if (!$crs_obj instanceof ilObject) {
            $this->logger->debug('Cannot instantiate course instance');
            return true;
        }

        // Update title
        $title = $course->title;
        $this->logger->debug('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.

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

References ilObject\_getAllReferences(), addUrlEntry(), createParallelCourse(), getImportId(), ilObjectFactory\getInstanceByObjId(), and ILIAS\Repository\logger().

Referenced by doSync().

                                                                                 : bool
    {
        $parent_refs = ilObject::_getAllReferences($parent_obj);
        $parent_ref = end($parent_refs);

        foreach ((array) $course->groups as $group) {
            $title = $course->title;
            if ($group->title !== '') {
                $title .= ' (' . $group->title . ')';
            }

            $obj_id = $this->getImportId((int) $course->lectureID, (string) $group->id);
            $this->logger->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->logger->debug('New title is ' . $title);
                    $course_obj->setTitle($title);
                    if(!is_null($group->maxParticipants)) {
                        $course_obj->setSubscriptionMaxMembers($group->maxParticipants);
                    }
                    $course_obj->update();
                }
            }
            $this->addUrlEntry($this->getImportId((int) $course->lectureID, (string) $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, int  $parent_obj  )

protected

Update parallel group data.

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

References ilObject\_getAllReferences(), addUrlEntry(), createParallelGroup(), getImportId(), ilObjectFactory\getInstanceByObjId(), and ILIAS\Repository\logger().

Referenced by doSync().

                                                                                    : void
    {
        $parent_refs = ilObject::_getAllReferences($parent_obj);
        $parent_ref = end($parent_refs);

        foreach ((array) $course->groups as $group) {
            $obj_id = $this->getImportId((int) $course->lectureID, (string) $group->id);
            $this->logger->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 = $group->title !== '' ? $group->title : $course->title;
                    $this->logger->debug('New title is ' . $title);
                    $group_obj->setTitle($title);
                    if(!is_null($group->maxParticipants)) {
                        $group_obj->setMaxMembers((int) $group->maxParticipants);
                    }
                    $group_obj->update();
                }
            }
            $this->addUrlEntry($this->getImportId((int) $course->lectureID, (string) $group->id));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$course_url

ilECSCourseUrl ilECSCourseCreationHandler::$course_url = null

private

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

Referenced by getCourseUrl().

$courses_created

array ilECSCourseCreationHandler::$courses_created = array()

private

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

Referenced by getCreatedCourses().

$lng

ilLanguage ilECSCourseCreationHandler::$lng

private

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

$logger

ilLogger ilECSCourseCreationHandler::$logger

private

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

$mapping

ilECSNodeMappingSettings ilECSCourseCreationHandler::$mapping

private

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

Referenced by getMapping().

$mid

int ilECSCourseCreationHandler::$mid

private

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

Referenced by getMid().

$object_created

bool ilECSCourseCreationHandler::$object_created = false

private

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

Referenced by isObjectCreated().

$server

ilECSSetting ilECSCourseCreationHandler::$server

private

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

Referenced by __construct(), and getServer().

$tree

ilTree ilECSCourseCreationHandler::$tree

private

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

---

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

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