ilCourseAppEventListener Class Reference

Course Pool listener. More...

Collaboration diagram for ilCourseAppEventListener:

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

Static Public Member Functions
static	initializeTimings ($a_obj_id, $a_usr_id, $a_role_id)
	initialize timings More...
static	destroyTimings ($a_obj_id, $a_usr_id)
	Delete timings for user. More...
static	handleEvent ($a_component, $a_event, $a_parameter)
	Handle an event in a listener. More...
static	setBlockedForLP ($a_status)
	Toggle LP blocking property status. More...

Protected Member Functions
	handleUserAssignments ($a_event, $a_parameters)
	handle user assignments More...
	doAutoFill ($a_obj_id)
	Trigger autofill from waiting list. More...

Static Protected Attributes
static	$timings_mode = null
static	$course_mode = array()
static	$blocked_for_lp

Private Attributes
	$logger = null

Detailed Description

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 12 of file class.ilCourseAppEventListener.php.

Constructor & Destructor Documentation

__construct()

ilCourseAppEventListener::__construct

(

)

Constructor.

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

References ilLoggerFactory\getInstance().

    {
        $this->logger = ilLoggerFactory::getInstance()->getLogger('crs');
    }

Here is the call graph for this function:

Member Function Documentation

destroyTimings()

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

static

Delete timings for user.

Parameters

int	$a_obj_id
int	$a_usr_id

Returns

boolean

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

References ilTimingsUser\getInstanceByContainerId().

    {
        include_once './Modules/Course/classes/Timings/class.ilTimingsUser.php';
        $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 (   $a_obj_id )

protected

Trigger autofill from waiting list.

Parameters

int

$a_obj_id

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

References $factory, ilObject\_getAllReferences(), and getLogger().

    {
        $this->getLogger()->debug('Handling event deassign user -> waiting list auto fill');
        
        // #16694
        include_once("./Modules/Course/classes/class.ilObjCourse.php");
        $ref_id = array_pop(ilObject::_getAllReferences($a_obj_id));
        
        include_once './Services/Object/classes/class.ilObjectFactory.php';
        $factory = new ilObjectFactory();
        
        $course = $factory->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

(

)

Returns

ilLogger

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

References $logger.

Referenced by doAutoFill(), and handleUserAssignments().

    {
        return $this->logger;
    }

Here is the caller graph for this function:

handleEvent()

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

static

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "Modules/Forum" or "Services/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
array	$a_parameter	parameter array (assoc), array("name" => ..., "phone_office" => ...)

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

References ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupType(), 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.

    {
        if ($a_component == 'Services/AccessControl') {
            $listener = new self();
            $listener->handleUserAssignments($a_event, $a_parameter);
        }
    
        switch ($a_component) {
            case 'Modules/Course':
                if ($a_event == 'addParticipant') {
                    self::initializeTimings($a_parameter['obj_id'], $a_parameter['usr_id'], $a_parameter['role_id']);
                    return true;
                }
                if ($a_event == 'deleteParticipant') {
                    self::destroyTimings($a_parameter['obj_id'], $a_parameter['usr_id']);
                    return true;
                }
                break;
        }

        if ($a_component == "Services/Tracking" && $a_event == "updateStatus") {
            // see ilObjCourseGUI::updateLPFromStatus()
            if ((bool) self::$blocked_for_lp) {
                return;
            }
            
            // #13905
            include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
            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])) {
                    include_once("./Modules/Course/classes/class.ilObjCourse.php");
                    $crs = new ilObjCourse($obj_id, false);
                    if ($crs->getStatusDetermination() == ilObjCourse::STATUS_DETERMINATION_LP) {
                        include_once './Services/Object/classes/class.ilObjectLP.php';
                        $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
                        include_once "Modules/Course/classes/class.ilCourseParticipants.php";
                        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;
                        include_once "Modules/Course/classes/class.ilCourseParticipants.php";
                        if (!$do_update) {
                            $part = new ilCourseParticipants($obj_id);
                            $passed = $part->getPassedInfo($user_id);
                            if (!is_array($passed) ||
                                $passed["user_id"] == -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 (   $a_event,   $a_parameters  )

protected

handle user assignments

Parameters

type	$a_event
type	$a_parameters

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

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

    {
        if ($a_parameters['type'] != 'crs') {
            $this->getLogger()->debug('Ignoring event for type ' . $a_parameters['type']);
            return true;
        }
        
        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));
        
        include_once './Modules/Course/classes/class.ilCourseParticipant.php';
        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 (   $a_obj_id,   $a_usr_id,   $a_role_id  )

static

initialize timings

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

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

    {
        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) ?
                    true :
                    false
            );
        }
        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 (   $a_status )

static

Toggle LP blocking property status.

Parameters

bool

$a_status

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

Referenced by ilObjCourseGUI\updateLPFromStatus().

    {
        self::$blocked_for_lp = (bool) $a_status;
    }

Here is the caller graph for this function:

Field Documentation

$blocked_for_lp

ilCourseAppEventListener::$blocked_for_lp

staticprotected

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

$course_mode

ilCourseAppEventListener::$course_mode = array()

staticprotected

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

$logger

ilCourseAppEventListener::$logger = null

private

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

Referenced by getLogger().

$timings_mode

ilCourseAppEventListener::$timings_mode = null

staticprotected

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

---

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

• Modules/Course/classes/class.ilCourseAppEventListener.php