ilCourseReferenceLP Class Reference

Class ilCourseReferenceLP. More...

Inheritance diagram for ilCourseReferenceLP:

Collaboration diagram for ilCourseReferenceLP:

Public Member Functions
	getMembers ($a_search=true)
	getDefaultMode ()
	getValidModes ()
Public Member Functions inherited from ilObjectLP
	resetCaches ()
	isAnonymized ()
	getDefaultMode ()
	getValidModes ()
	getCurrentMode ()
	isActive ()
	getModeText ($a_mode)
	getModeInfoText ($a_mode)
	getSettingsInfo ()
	getCollectionInstance ()
	getMembers ($a_search=true)
	resetLPDataForCompleteObject ($a_recursive=true)
	resetLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	handleToTrash ()
	handleDelete ()
	getMailTemplateId ()

Static Public Member Functions
static	getDefaultModes ($a_lp_active)
Static Public Member Functions inherited from ilObjectLP
static	getInstance ($a_obj_id)
static	getTypeClass ($a_type)
static	isSupportedObjectType ($a_type)
static	handleMove ($a_source_ref_id)
static	getLPMemberships ($a_usr_id, array $a_obj_ids, $a_parent_ref_id=null, $a_mapped_ref_ids=false)
	Get all objects where given user is member (from LP POV) More...
static	supportsSpentSeconds ($a_obj_type)
static	supportsMark ($a_obj_type)
static	supportsMatrixView ($a_obj_type)
static	getDefaultModes ($a_lp_active)
	Get available type-specific default modes (no administration needed) More...
static	saveTypeDefaults (array $a_data)
static	getTypeDefault ($a_type)
	Get current type default. More...

Protected Member Functions
	__construct ($a_obj_id)
Protected Member Functions inherited from ilObjectLP
	__construct ($a_obj_id)
	resetCustomLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Private Attributes
	$logger = null

Additional Inherited Members
Static Protected Member Functions inherited from ilObjectLP
static	isLPMember (array &$a_res, $a_usr_id, $a_obj_ids)
	Find (lp-relevant) members for given object ids. More...
static	findMembershipsByPath (array &$a_res, $a_usr_id, $a_parent_ref_id, array $a_obj_ids, $a_mapped_ref_ids=false)
	Find (lp-relevant) memberships by path. More...
static	getTypeDefaultFromDB ($a_type)
Protected Attributes inherited from ilObjectLP
	$tree
	$db
	$obj_id
	$collection_instance
	$mode
Static Protected Attributes inherited from ilObjectLP
static	$type_defaults

Detailed Description

Class ilCourseReferenceLP.

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

Constructor & Destructor Documentation

__construct()

ilCourseReferenceLP::__construct (   $a_obj_id )

protected

Definition at line 15 of file class.ilCourseReferenceLP.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        parent::__construct($a_obj_id);

        $this->logger = $DIC->logger()->crsr();
    }

Here is the call graph for this function:

Member Function Documentation

getDefaultMode()

ilCourseReferenceLP::getDefaultMode

(

)

Definition at line 45 of file class.ilCourseReferenceLP.php.

    {
        return \ilLPObjSettings::LP_MODE_DEACTIVATED;
    }

getDefaultModes()

static ilCourseReferenceLP::getDefaultModes (   $a_lp_active )

static

Parameters

bool

$a_lp_active

Returns

array

Definition at line 54 of file class.ilCourseReferenceLP.php.

References ilLPObjSettings\LP_MODE_COURSE_REFERENCE, and ilLPObjSettings\LP_MODE_DEACTIVATED.

    {
        return [
            \ilLPObjSettings::LP_MODE_DEACTIVATED,
            \ilLPObjSettings::LP_MODE_COURSE_REFERENCE
        ];
    }

getMembers()

ilCourseReferenceLP::getMembers

(

$a_search = true

)

Parameters

bool

$a_search

Returns

int[]

Definition at line 28 of file class.ilCourseReferenceLP.php.

References ilContainerReference\_lookupTargetRefId(), and ilParticipants\getInstance().

    {
        if (!$a_search) {
            return [];
        }
        $target_ref_id = \ilObjCourseReference::_lookupTargetRefId($this->obj_id);
        if (!$target_ref_id) {
            return [];
        }
        $participants = \ilParticipants::getInstance($target_ref_id);
        return $participants->getMembers();
    }

Here is the call graph for this function:

getValidModes()

ilCourseReferenceLP::getValidModes

(

)

Definition at line 65 of file class.ilCourseReferenceLP.php.

    {
        return self::getDefaultModes(true);
    }

Field Documentation

$logger

ilCourseReferenceLP::$logger = null

private

Definition at line 13 of file class.ilCourseReferenceLP.php.

---

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

• Modules/CourseReference/classes/class.ilCourseReferenceLP.php