Class ilCourseReferencePathInfo. More...

Collaboration diagram for ilCourseReferencePathInfo:

Public Member Functions
	__construct (int $ref_id, int $target_ref_id=0)
	ilCourseReferencePathInfo constructor. More...

	getParentCourseRefId ()

	hasParentCourse ()

	getTargetId ()

	isMemberUpdateEnabled ()

	checkManagmentAccess ()
	Check manage member for both target and parent course. More...

Static Public Member Functions
static	getInstanceByRefId (int $ref_id, int $target_ref_id=0)

static	isReferenceMemberUpdateConfirmationRequired (int $course_ref_id, array $participants)

Protected Member Functions
	init ()
	Init path info. More...

Private Attributes
	$logger = null

	$tree = null

	$access = null

	$ref_id = 0

	$target_ref_id = 0

	$has_parent_course = false

	$parent_course_ref_id = 0

	$member_update_enabled = false

Static Private Attributes
static	$instances = []

Detailed Description

Class ilCourseReferencePathInfo.

Definition at line 8 of file class.ilCourseReferencePathInfo.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseReferencePathInfo::__construct	(	int	$ref_id,
		int	$target_ref_id = `0`
	)

ilCourseReferencePathInfo constructor.

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->crsr();
        $this->tree = $DIC->repositoryTree();
        $this->access = $DIC->access();
 
        $this->ref_id = $ref_id;
        $this->target_ref_id = $target_ref_id;
        $this->init();
 
        $this->logger->info('ref_id: ' . $this->ref_id);
        $this->logger->info('target_ref_id: ' . $this->target_ref_id);
        $this->logger->info('parent course: ' . $this->parent_course_ref_id);
        $this->logger->info('has parent course: ' . $this->has_parent_course);
    }

References $DIC, $ref_id, $target_ref_id, and init().

Here is the call graph for this function:

Member Function Documentation

◆ checkManagmentAccess()

ilCourseReferencePathInfo::checkManagmentAccess ( )

Check manage member for both target and parent course.

Returns: bool

Definition at line 161 of file class.ilCourseReferencePathInfo.php.

    {
        if (!$this->hasParentCourse()) {
            $this->logger->dump('Access failed: no parent course');
            return false;
        }
        return
            $this->access->checkAccess('manage_members', '', $this->target_ref_id) &&
            $this->access->checkAccess('manage_members', '', $this->parent_course_ref_id);
    }

References hasParentCourse().

Here is the call graph for this function:

◆ getInstanceByRefId()

static ilCourseReferencePathInfo::getInstanceByRefId	(	int	$ref_id,
		int	$target_ref_id = `0`
	)

static

Parameters

int	$ref_id
int	$target_ref_id

Returns: \ilCourseReferencePathInfo

Definition at line 84 of file class.ilCourseReferencePathInfo.php.

                                                                                   : \ilCourseReferencePathInfo
    {
        if (!array_key_exists($ref_id, self::$instances)) {
            self::$instances[$ref_id] = new self($ref_id, $target_ref_id);
        }
        return self::$instances[$ref_id];
    }

References $ref_id, and $target_ref_id.

Referenced by ilCourseReferenceAppEventListener\handleReferences(), ilObjCourseReferenceGUI\initForm(), isReferenceMemberUpdateConfirmationRequired(), ilObjCourseReferenceGUI\loadPropertiesFromSettingsForm(), and ilCourseReferenceDeleteConfirmationTableGUI\readLinkedCourseAssignments().

Here is the caller graph for this function:

◆ getParentCourseRefId()

ilCourseReferencePathInfo::getParentCourseRefId ( )

Returns: int

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

                                           : int
    {
        return $this->parent_course_ref_id;
    }

References $parent_course_ref_id.

Referenced by init().

Here is the caller graph for this function:

◆ getTargetId()

ilCourseReferencePathInfo::getTargetId ( )

Returns: int

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

                                  : int
    {
        return $this->target_ref_id;
    }

References $target_ref_id.

◆ hasParentCourse()

ilCourseReferencePathInfo::hasParentCourse ( )

Returns: bool

Definition at line 136 of file class.ilCourseReferencePathInfo.php.

                                      : bool
    {
        return $this->has_parent_course;
    }

References $has_parent_course.

Referenced by checkManagmentAccess().

Here is the caller graph for this function:

◆ init()

ilCourseReferencePathInfo::init ( )

protected

Init path info.

Definition at line 176 of file class.ilCourseReferencePathInfo.php.

    {
        if (!$this->target_ref_id) {
            $target_obj_id = ilObjCourseReference::_lookupTargetId(ilObject::_lookupObjId($this->ref_id));
            $target_ref_ids = ilObject::_getAllReferences($target_obj_id);
            $this->target_ref_id = end($target_ref_ids);
        }
 
        $this->member_update_enabled = ilObjCourseReference::lookupMemberUpdateEnabled(ilObject::_lookupObjId($this->ref_id));
        $this->parent_course_ref_id = $this->tree->checkForParentType($this->ref_id, 'crs');
 
        if ($this->getParentCourseRefId() && !$this->tree->checkForParentType($this->ref_id, 'grp')) {
            $this->has_parent_course = true;
        }
    }

References ilObject\_getAllReferences(), ilObject\_lookupObjId(), ilContainerReference\_lookupTargetId(), getParentCourseRefId(), and ilObjCourseReference\lookupMemberUpdateEnabled().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMemberUpdateEnabled()

ilCourseReferencePathInfo::isMemberUpdateEnabled ( )

Returns: bool

Definition at line 152 of file class.ilCourseReferencePathInfo.php.

                                            : bool
    {
        return $this->member_update_enabled;
    }

References $member_update_enabled.

◆ isReferenceMemberUpdateConfirmationRequired()

static ilCourseReferencePathInfo::isReferenceMemberUpdateConfirmationRequired	(	int	$course_ref_id,
		array	$participants
	)

static

Parameters

int	$course_ref_id
int[]	$participants

Returns: bool

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

                                                                                                                : bool
    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        $childs = $tree->getChildsByType($course_ref_id, 'crsr');
        foreach ($childs as $tree_node) {
            $path_info = self::getInstanceByRefId($tree_node['child']);
            if (!$path_info->hasParentCourse()) {
                continue;
            }
            if (!$path_info->isMemberUpdateEnabled()) {
                continue;
            }
            if (!$path_info->checkManagmentAccess()) {
                continue;
            }
            $part = ilParticipants::getInstance($path_info->getTargetId());
            foreach ($participants as $part_id) {
                if ($part->isMember($part_id)) {
                    return true;
                }
            }
        }
        return false;
    }