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

Inheritance diagram for ilCourseReferenceAppEventListener:

Collaboration diagram for ilCourseReferenceAppEventListener:

Static Public Member Functions
static	handleEvent (string $a_component, string $a_event, array $a_parameter)
	Handle an event in a listener. More...

static	handleEvent (string $a_component, string $a_event, array $a_parameter)
	Handle an event in a listener. More...

Protected Member Functions
	handleUserAssignments ($a_event, $a_parameter)

	handleReferences ($a_course_obj_id, $a_usr_id, $a_role_id)

Private Member Functions
	__construct ()
	ilCourseReferenceAppEventHandler constructor. More...

Private Attributes
	$logger = null

	$tree = null

Static Private Attributes
static	$instance = null

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 Class ilCourseReferencePathInfo

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

Constructor & Destructor Documentation

◆ __construct()

ilCourseReferenceAppEventListener::__construct ( )

private

ilCourseReferenceAppEventHandler constructor.

Definition at line 37 of file class.ilCourseReferenceAppEventListener.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->crsr();
        $this->tree = $DIC->repositoryTree();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ handleEvent()

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

static

Handle an event in a listener.

Parameters

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

Implements ilAppEventListener.

Definition at line 120 of file class.ilCourseReferenceAppEventListener.php.

                                                                                                : void
    {
        ilLoggerFactory::getLogger('crs')->warning($a_component);
        switch ($a_component) {
            case 'components/ILIAS/AccessControl':
                $self = new self();
                $self->handleUserAssignments($a_event, $a_parameter);
                break;
        }
    }

References ilLoggerFactory\getLogger().

Here is the call graph for this function:

◆ handleReferences()

ilCourseReferenceAppEventListener::handleReferences	(	$a_course_obj_id,
		$a_usr_id,
		$a_role_id
	)

protected

Parameters

$a_course_obj_id
$a_usr_id
$a_role_id

Definition at line 72 of file class.ilCourseReferenceAppEventListener.php.

    {
        $role_title = ilObject::_lookupTitle($a_role_id);
        if (substr($role_title, 0, 10) !== 'il_crs_mem') {
            $this->logger->debug('Ignoring non member role: ' . $role_title);
            return;
        }
 
 
        // find all crs references for course
        $course_ref_ids = ilObject::_getAllReferences($a_course_obj_id);
        $course_ref_id = end($course_ref_ids);
 
        $childs = $this->tree->getChildsByType($course_ref_id, 'crsr');
        $this->logger->dump($childs, ilLogLevel::DEBUG);
 
        foreach ($childs as $tree_node) {
            $this->logger->debug('Handling course reference: ' . $tree_node['title']);
            $path_info = ilCourseReferencePathInfo::getInstanceByRefId($tree_node['child']);
 
            // this also checks for structure crs -> grp -> crsr, which return false
            if (!$path_info->hasParentCourse()) {
                $this->logger->debug('No reference member update: no direct parent course');
                continue;
            }
 
            if (!$path_info->isMemberUpdateEnabled()) {
                $this->logger->debug('No reference member update: update disabled.');
                continue;
            }
 
            $this->logger->debug('Reference member update: adding user to course.');
            $target_course_ref_id = $path_info->getTargetId();
            $part = ilCourseParticipants::getInstance($target_course_ref_id);
            $part->add($a_usr_id, ilParticipants::IL_CRS_MEMBER);
        }
    }

References ilObject\_getAllReferences(), ilObject\_lookupTitle(), ilLogLevel\DEBUG, ilParticipants\getInstance(), ilCourseReferencePathInfo\getInstanceByRefId(), ilParticipants\IL_CRS_MEMBER, and ILIAS\Repository\logger().

Referenced by handleUserAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleUserAssignments()

ilCourseReferenceAppEventListener::handleUserAssignments	(	$a_event,
		$a_parameter
	)

protected

Parameters

$a_event
$a_parameter

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

    {
        if ($a_parameter['type'] != 'crs') {
            $this->logger->debug('Ignoring event for type ' . $a_parameter['type']);
            return true;
        }
 
        $this->logger->info('Current event is: ' . $a_event);
        if ($a_event == 'assignUser') {
            $this->logger->debug('Handling assign user event for type crs.');
            $this->handleReferences($a_parameter['obj_id'], $a_parameter['usr_id'], $a_parameter['role_id']);
        } else {
            $this->logger->debug('Ignoring event: ' . $a_event);
        }
    }