ilCourseAppEventListener Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCourseAppEventListener:

Public Member Functions
	__construct ()
	Constructor PhpUndefinedMethodInspection. More...
	getLogger ()

Static Public Member Functions
static	initializeTimings (int $a_obj_id, int $a_usr_id, int $a_role_id)
static	destroyTimings (int $a_obj_id, int $a_usr_id)
	Delete timings for user. More...
static	handleEvent (string $a_component, string $a_event, array $a_parameter)
static	setBlockedForLP (bool $a_status)
	Toggle LP blocking property status. More...

Protected Member Functions
	handleUserAssignments (string $a_event, array $a_parameters)
	doAutoFill (int $a_obj_id)
	Trigger autofill from waiting list. More...

Static Protected Member Functions
static	awardCertificate (int $a_obj_id, int $a_usr_id)

Static Protected Attributes
static array	$course_mode = array()
static bool	$blocked_for_lp = false

Private Attributes
ilLogger	$logger

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Course Pool listener. Listens to events of other components.

Author

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

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$ \

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

Constructor & Destructor Documentation

__construct()

ilCourseAppEventListener::__construct

(

)

Constructor PhpUndefinedMethodInspection.

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

References $DIC, and ILIAS\Repository\logger().

    {
        global $DIC;
        $this->logger = $DIC->logger()->crs();
    }

Here is the call graph for this function:

Member Function Documentation

awardCertificate()

static ilCourseAppEventListener::awardCertificate ( int  $a_obj_id, int  $a_usr_id  )

staticprotected

Definition at line 125 of file class.ilCourseAppEventListener.php.

References $DIC, Vendor\Package\$e, ilLogLevel\DEBUG, ilLogger\logStack(), and ilLogger\warning().

                                                                            : void
    {
        global $DIC;

        $logger = $DIC->logger('crs');
        if (!$DIC->certificate()->userCertificates()->isActiveCertificateTemplateAvailableFor($a_obj_id)) {
            return;
        }
        try {
            $DIC->certificate()->userCertificates()->certificateCriteriaMet(
                $a_usr_id,
                $a_obj_id
            );
        } catch (Exception $e) {
            $logger->warning($e->getMessage());
            $logger->logStack(ilLogLevel::DEBUG);
        }
    }

Here is the call graph for this function:

destroyTimings()

static ilCourseAppEventListener::destroyTimings ( int  $a_obj_id, int  $a_usr_id  )

static

Delete timings for user.

Definition at line 117 of file class.ilCourseAppEventListener.php.

References ilTimingsUser\getInstanceByContainerId().

                                                                       : bool
    {
        $user_timings = ilTimingsUser::getInstanceByContainerId($a_obj_id);
        $user_timings->init();
        $user_timings->handleUnsubscribe($a_usr_id);
        return true;
    }

Here is the call graph for this function:

doAutoFill()

ilCourseAppEventListener::doAutoFill ( int  $a_obj_id )

protected

Trigger autofill from waiting list.

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

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

                                                : void
    {
        $this->getLogger()->debug('Handling event deassign user -> waiting list auto fill');

        // #16694
        $refs = ilObject::_getAllReferences($a_obj_id);
        $ref_id = array_pop($refs);

        $course = ilObjectFactory::getInstanceByRefId($ref_id, false);
        if (!$course instanceof ilObjCourse) {
            $this->getLogger()->warning('Cannot handle event deassign user since passed obj_id is not of type course: ' . $a_obj_id);
        }
        $course->handleAutoFill();
    }

Here is the call graph for this function:

getLogger()

ilCourseAppEventListener::getLogger

(

)

Definition at line 44 of file class.ilCourseAppEventListener.php.

References $logger.

Referenced by doAutoFill(), and handleUserAssignments().

                               : ilLogger
    {
        return $this->logger;
    }

Here is the caller graph for this function:

handleEvent()

static ilCourseAppEventListener::handleEvent ( string  $a_component, string  $a_event, array  $a_parameter  )

static

Definition at line 144 of file class.ilCourseAppEventListener.php.

References $user_id, ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupType(), ilCourseParticipants\_updatePassed(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_OBJECTIVES, ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilObjCourse\STATUS_DETERMINATION_LP.

                                                                                                : void
    {
        if ($a_component == 'components/ILIAS/AccessControl') {
            $listener = new self();
            $listener->handleUserAssignments($a_event, $a_parameter);
        }

        switch ($a_component) {
            case 'components/ILIAS/Course':
                if ($a_event == 'addParticipant') {
                    self::initializeTimings($a_parameter['obj_id'], $a_parameter['usr_id'], $a_parameter['role_id']);
                    return;
                }
                if ($a_event == 'deleteParticipant') {
                    self::destroyTimings($a_parameter['obj_id'], $a_parameter['usr_id']);
                    return;
                }
                if ($a_event === 'participantHasPassedCourse' && !ilObjUserTracking::_enabledLearningProgress()) {
                    self::awardCertificate($a_parameter['obj_id'], $a_parameter['usr_id']);
                }
                break;
        }

        if ($a_component == "components/ILIAS/Tracking" && $a_event == "updateStatus") {
            // see ilObjCourseGUI::updateLPFromStatus()
            if (self::$blocked_for_lp) {
                return;
            }

            // #13905
            if (!ilObjUserTracking::_enabledLearningProgress()) {
                return;
            }

            $obj_id = $a_parameter["obj_id"];
            $user_id = $a_parameter["usr_id"];
            $status = $a_parameter["status"];

            if ($obj_id && $user_id) {
                if (ilObject::_lookupType($obj_id) != "crs") {
                    return;
                }

                // determine couse setting only once
                if (!isset(self::$course_mode[$obj_id])) {
                    $crs = new ilObjCourse($obj_id, false);
                    if ($crs->getStatusDetermination() == ilObjCourse::STATUS_DETERMINATION_LP) {
                        $olp = ilObjectLP::getInstance($obj_id);
                        $mode = $olp->getCurrentMode();
                    } else {
                        $mode = false;
                    }
                    self::$course_mode[$obj_id] = $mode;
                }

                $is_completed = ($status == ilLPStatus::LP_STATUS_COMPLETED_NUM);

                // we are NOT using the members object because of performance issues
                switch (self::$course_mode[$obj_id]) {
                    case ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR:
                        // #11600
                        ilCourseParticipants::_updatePassed($obj_id, $user_id, $is_completed, true);
                        break;

                    case ilLPObjSettings::LP_MODE_COLLECTION:
                    case ilLPObjSettings::LP_MODE_OBJECTIVES:
                        // overwrites course passed status if it was set automatically (full sync)
                        // or toggle manually set passed status to completed (1-way-sync)
                        $do_update = $is_completed;
                        if (!$do_update) {
                            $part = new ilCourseParticipants($obj_id);
                            $passed = $part->getPassedInfo($user_id);
                            if (
                                !is_array($passed) ||
                                ((int) ($passed["user_id"] ?? 0)) === -1) {
                                $do_update = true;
                            }
                        }
                        if ($do_update) {
                            ilCourseParticipants::_updatePassed($obj_id, $user_id, $is_completed);
                        }
                        break;
                }
            }
        }
    }

Here is the call graph for this function:

handleUserAssignments()

ilCourseAppEventListener::handleUserAssignments ( string  $a_event, array  $a_parameters  )

protected

Definition at line 49 of file class.ilCourseAppEventListener.php.

References ilLoggerFactory\getInstance(), getLogger(), and ilParticipant\updateMemberRoles().

                                                                                  : void
    {
        if ($a_parameters['type'] != 'crs') {
            $this->getLogger()->debug('Ignoring event for type ' . $a_parameters['type']);
            return;
        }
        $new_status = 0;
        if ($a_event == 'assignUser') {
            $this->getLogger()->debug('Handling assign user event for type crs.');
            $new_status = 1;
        } elseif ($a_event == 'deassignUser') {
            $this->getLogger()->debug('Handling assign user event for type crs.');
            $new_status = 0;
        }

        ilLoggerFactory::getInstance()->getLogger('crs')->debug(print_r($a_parameters, true));
        ilLoggerFactory::getInstance()->getLogger('crs')->debug(print_r($new_status, true));

        ilCourseParticipant::updateMemberRoles(
            $a_parameters['obj_id'],
            $a_parameters['usr_id'],
            $a_parameters['role_id'],
            $new_status
        );

        if ($a_event == 'deassignUser') {
            $self = new self();
            $self->doAutoFill($a_parameters['obj_id']);
        }
    }

Here is the call graph for this function:

initializeTimings()

static ilCourseAppEventListener::initializeTimings ( int  $a_obj_id, int  $a_usr_id, int  $a_role_id  )

static

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

References ilTimingsUser\getInstanceByContainerId(), IL_CAL_UNIX, ilCourseConstants\IL_CRS_VIEW_TIMING_RELATIVE, and ilObjCourse\lookupTimingMode().

                                                                                          : bool
    {
        static $timing_mode = array();

        if (!array_key_exists($a_obj_id, $timing_mode)) {
            $timing_mode[$a_obj_id] = ilObjCourse::lookupTimingMode($a_obj_id) == ilCourseConstants::IL_CRS_VIEW_TIMING_RELATIVE;
        }
        if (!$timing_mode[$a_obj_id]) {
            return true;
        }
        $user_timings = ilTimingsUser::getInstanceByContainerId($a_obj_id);
        $user_timings->init();
        $user_timings->handleNewMembership($a_usr_id, new ilDateTime(time(), IL_CAL_UNIX));
        return true;
    }

Here is the call graph for this function:

setBlockedForLP()

static ilCourseAppEventListener::setBlockedForLP ( bool  $a_status )

static

Toggle LP blocking property status.

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

Referenced by ilObjCourseGUI\updateLPFromStatus().

                                                          : void
    {
        self::$blocked_for_lp = $a_status;
    }

Here is the caller graph for this function:

Field Documentation

$blocked_for_lp

bool ilCourseAppEventListener::$blocked_for_lp = false

staticprotected

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

$course_mode

array ilCourseAppEventListener::$course_mode = array()

staticprotected

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

$logger

ilLogger ilCourseAppEventListener::$logger

private

Definition at line 29 of file class.ilCourseAppEventListener.php.

Referenced by getLogger().

---

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

• components/ILIAS/Course/classes/class.ilCourseAppEventListener.php