ilStudyProgrammeLP 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 ilStudyProgrammeLP:

Collaboration diagram for ilStudyProgrammeLP:

Public Member Functions
	getDefaultMode ()
	getValidModes ()
	getMembers (bool $search=true)
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 (ilRadioGroupInputGUI $modeRadio)
	shouldFetchIndividualModeFromFormSubmission ()
	fetchIndividualModeFromFormSubmission (ilPropertyFormGUI $form)
	appendModeConfiguration (int $mode, ilRadioOption $modeElement)
	saveModeConfiguration (ilPropertyFormGUI $form, bool &$modeChanged)

Static Public Member Functions
static	getDefaultModes (bool $lp_active)
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 Attributes
ilObjStudyProgramme	$prg = null
Protected Attributes inherited from ilObjectLP
ilTree	$tree
ilDBInterface	$db
ilObjectDefinition	$objectDefinition
int	$obj_id
ilLPCollection	$collection_instance = null
int	$mode = null

Additional Inherited Members
Protected Member Functions inherited from ilObjectLP
	__construct (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()
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)
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

Definition at line 21 of file class.ilStudyProgrammeLP.php.

Member Function Documentation

getDefaultMode()

ilStudyProgrammeLP::getDefaultMode

(

)

Definition at line 34 of file class.ilStudyProgrammeLP.php.

References ilLPObjSettings\LP_MODE_STUDY_PROGRAMME.

                                    : int
    {
        return ilLPObjSettings::LP_MODE_STUDY_PROGRAMME;
    }

getDefaultModes()

static ilStudyProgrammeLP::getDefaultModes ( bool  $lp_active )

static

Parameters

bool

$lp_active

Returns

int[]

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

References ilLPObjSettings\LP_MODE_DEACTIVATED.

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

getMembers()

ilStudyProgrammeLP::getMembers

(

bool

$search = true

)

Parameters

bool

$search

Returns

array

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

                                                   : array
    {
        if ($this->prg === null) {
            $this->prg = new ilObjStudyProgramme($this->obj_id, false);
        }
        return $this->prg->getIdsOfUsersWithRelevantProgress();
    }

getValidModes()

ilStudyProgrammeLP::getValidModes

(

)

Returns

array

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

References ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_STUDY_PROGRAMME.

                                   : array
    {
        return [
            ilLPObjSettings::LP_MODE_STUDY_PROGRAMME,
            ilLPObjSettings::LP_MODE_DEACTIVATED
        ];
    }

Field Documentation

$prg

ilObjStudyProgramme ilStudyProgrammeLP::$prg = null

protected

Definition at line 23 of file class.ilStudyProgrammeLP.php.

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeLP.php