ilCourseReferenceLP Class Reference

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

Inheritance diagram for ilCourseReferenceLP:

Collaboration diagram for ilCourseReferenceLP:

Public Member Functions
	getMembers (bool $search=true)
	getDefaultMode ()
	getValidModes ()
	Returns int[] More...
Public Member Functions inherited from ilObjectLP
	resetCaches ()
	isAnonymized ()
	getDefaultMode ()
	getValidModes ()
	getCurrentMode ()
	isActive ()
	getModeText (int $mode)
	getModeInfoText (int $mode)
	getSettingsInfo ()
	getCollectionInstance ()
	getMembers (bool $search=true)
	resetLPDataForCompleteObject (bool $recursive=true)
	resetLPDataForUserIds (array $user_ids, bool $recursive=true)
	handleToTrash ()
	handleDelete ()
	getMailTemplateId ()
	hasIndividualModeOptions ()
	initInvidualModeOptions ()
	Post vars for input groups is taken from array keys. More...
	shouldFetchIndividualModeFromFormSubmission ()
	fetchIndividualModeFromFormSubmission (string $selected_group, array $group_data)
	appendModeConfiguration (int $mode)
	saveModeConfiguration (string $selected_group, array $group_data, bool &$modeChanged)

Static Public Member Functions
static	getDefaultModes (bool $lp_active)
	Get available type-specific default modes (no administration needed) More...
Static Public Member Functions inherited from ilObjectLP
static	getInstance (int $obj_id)
static	getTypeClass (string $type)
static	getSupportedObjectTypes ()
static	isSupportedObjectType (string $type)
static	handleMove (int $source_ref_id)
static	getLPMemberships (int $usr_id, array $obj_ids, ?int $parent_ref_id=null, bool $mapped_ref_ids=false)
	Get all objects where given user is member (from LP POV) More...
static	supportsSpentSeconds (string $obj_type)
static	supportsMark (string $obj_type)
static	supportsMatrixView (string $obj_type)
static	getDefaultModes (bool $lp_active)
	Get available type-specific default modes (no administration needed) More...
static	saveTypeDefaults (array $data)
static	getTypeDefault (string $type)

Protected Member Functions
	__construct ($a_obj_id)
Protected Member Functions inherited from ilObjectLP
	__construct (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Private Attributes
	$logger = null

Additional Inherited Members
Static Protected Member Functions inherited from ilObjectLP
static	isLPMember (array &$res, int $usr_id, array $obj_ids)
	Find (lp-relevant) members for given object ids. More...
static	findMembershipsByPath (array &$res, int $usr_id, int $parent_ref_id, array $obj_ids, bool $mapped_ref_ids=false)
	Find (lp-relevant) memberships by path. More...
static	getTypeDefaultFromDB (string $type)
Protected Attributes inherited from ilObjectLP
ilTree	$tree
ilDBInterface	$db
ilObjectDefinition	$objectDefinition
int	$obj_id
ilLPCollection	$collection_instance = null
int	$mode = null
Static Protected Attributes inherited from ilObjectLP
static array	$type_defaults = 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 ilCourseReferenceLP

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

Constructor & Destructor Documentation

__construct()

ilCourseReferenceLP::__construct (   $a_obj_id )

protected

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

    {
        global $DIC;
 
        parent::__construct($a_obj_id);
 
        $this->logger = $DIC->logger()->crsr();
    }

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

Here is the call graph for this function:

Member Function Documentation

getDefaultMode()

ilCourseReferenceLP::getDefaultMode

(

)

Reimplemented from ilObjectLP.

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

                                    : int
    {
        return \ilLPObjSettings::LP_MODE_DEACTIVATED;
    }

getDefaultModes()

static ilCourseReferenceLP::getDefaultModes ( bool  $lp_active )

static

Get available type-specific default modes (no administration needed)

Returns

int[]

Reimplemented from ilObjectLP.

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

                                                           : array
    {
        return [\ilLPObjSettings::LP_MODE_DEACTIVATED];
    }

References ilLPObjSettings\LP_MODE_DEACTIVATED.

getMembers()

ilCourseReferenceLP::getMembers

(

bool

$search = true

)

Parameters

bool

$a_search

Returns

array

Reimplemented from ilObjectLP.

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

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

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

Here is the call graph for this function:

getValidModes()

ilCourseReferenceLP::getValidModes

(

)

Returns

int[]

Reimplemented from ilObjectLP.

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

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

References ilLPObjSettings\LP_MODE_COURSE_REFERENCE, and ilLPObjSettings\LP_MODE_DEACTIVATED.

Field Documentation

$logger

ilCourseReferenceLP::$logger = null

private

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

---

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

• components/ILIAS/CourseReference/classes/class.ilCourseReferenceLP.php