ilCourseLP Class Reference

Inheritance diagram for ilCourseLP:

Collaboration diagram for ilCourseLP:

Public Member Functions
	getDefaultMode ()
	getValidModes ()
	getCurrentMode ()
	getSettingsInfo ()
	getMembers (bool $a_search=true)
	getMailTemplateId ()
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 $a_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 Member Functions
	checkObjectives ()
Protected Member Functions inherited from ilObjectLP
	__construct (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Static Protected Member Functions
static	isLPMember (array &$a_res, int $a_usr_id, array $a_obj_ids)
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)

Additional Inherited Members
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

Definition at line 26 of file class.ilCourseLP.php.

Member Function Documentation

checkObjectives()

ilCourseLP::checkObjectives ( )

protected

Definition at line 70 of file class.ilCourseLP.php.

References ilObjCourse\_lookupViewMode(), and ilCourseConstants\IL_CRS_VIEW_OBJECTIVE.

Referenced by getCurrentMode(), getDefaultMode(), and getValidModes().

                                        : bool
    {
        return ilObjCourse::_lookupViewMode($this->obj_id) == ilCourseConstants::IL_CRS_VIEW_OBJECTIVE;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentMode()

ilCourseLP::getCurrentMode

(

)

Definition at line 62 of file class.ilCourseLP.php.

References checkObjectives(), and ilLPObjSettings\LP_MODE_OBJECTIVES.

                                    : int
    {
        if ($this->checkObjectives()) {
            return ilLPObjSettings::LP_MODE_OBJECTIVES;
        }
        return parent::getCurrentMode();
    }

Here is the call graph for this function:

getDefaultMode()

ilCourseLP::getDefaultMode

(

)

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

References checkObjectives(), ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, and ilLPObjSettings\LP_MODE_OBJECTIVES.

                                    : int
    {
        if ($this->checkObjectives()) {
            return ilLPObjSettings::LP_MODE_OBJECTIVES;
        }
        return ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR;
    }

Here is the call graph for this function:

getDefaultModes()

static ilCourseLP::getDefaultModes ( bool  $a_lp_active )

static

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

References ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR.

                                                             : array
    {
        if (!$a_lp_active) {
            return array(
                ilLPObjSettings::LP_MODE_DEACTIVATED
            );
        } else {
            return array(
                ilLPObjSettings::LP_MODE_DEACTIVATED,
                ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR
            );
        }
    }

getMailTemplateId()

ilCourseLP::getMailTemplateId

(

)

Definition at line 127 of file class.ilCourseLP.php.

References ilCourseMailTemplateTutorContext\ID.

                                       : string
    {
        return ilCourseMailTemplateTutorContext::ID;
    }

getMembers()

ilCourseLP::getMembers

(

bool

$a_search = true

)

Returns

int[]

Definition at line 92 of file class.ilCourseLP.php.

References ilCourseParticipants\_getInstanceByObjId().

                                                     : array
    {
        $member_obj = ilCourseParticipants::_getInstanceByObjId($this->obj_id);
        return $member_obj->getMembers();
    }

Here is the call graph for this function:

getSettingsInfo()

ilCourseLP::getSettingsInfo

(

)

Definition at line 75 of file class.ilCourseLP.php.

References $DIC, $lng, and ilObjCourse\STATUS_DETERMINATION_LP.

                                     : string
    {
        global $DIC;

        $lng = $DIC['lng'];

        // #9004
        $crs = new ilObjCourse($this->obj_id, false);
        if ($crs->getStatusDetermination() == ilObjCourse::STATUS_DETERMINATION_LP) {
            return $lng->txt("crs_status_determination_lp_info");
        }
        return '';
    }

getValidModes()

ilCourseLP::getValidModes

(

)

Definition at line 50 of file class.ilCourseLP.php.

References checkObjectives(), ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_DEACTIVATED, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, and ilLPObjSettings\LP_MODE_OBJECTIVES.

                                   : array
    {
        if ($this->checkObjectives()) {
            return array(ilLPObjSettings::LP_MODE_OBJECTIVES);
        }
        return array(
            ilLPObjSettings::LP_MODE_DEACTIVATED,
            ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR,
            ilLPObjSettings::LP_MODE_COLLECTION
        );
    }

Here is the call graph for this function:

isLPMember()

static ilCourseLP::isLPMember ( array &  $a_res, int  $a_usr_id, array  $a_obj_ids  )

staticprotected

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

References $DIC, $ilDB, $query, and ILIAS\Repository\int().

                                                                                        : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        // will only find objects with roles for user!
        // see ilParticipants::_getMembershipByType()
        $query = " SELECT DISTINCT obd.obj_id, obd.type, obd2.title" .
            " FROM rbac_ua ua" .
            " JOIN rbac_fa fa ON (ua.rol_id = fa.rol_id)" .
            " JOIN object_reference obr ON (fa.parent = obr.ref_id)" .
            " JOIN object_data obd ON (obr.obj_id = obd.obj_id)" .
            " JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id)" .
            " WHERE obd.type = " . $ilDB->quote("crs", "text") .
            " AND fa.assign = " . $ilDB->quote("y", "text") .
            " AND ua.usr_id = " . $ilDB->quote($a_usr_id, "integer") .
            " AND " . $ilDB->in("obd.obj_id", $a_obj_ids, false, "integer");
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $role = $row["title"];
            if (!stristr($role, "il_" . $row["type"] . "_admin_") &&
                !stristr($role, "il_" . $row["type"] . "_tutor_")) {
                $a_res[(int) $row["obj_id"]] = true;
            }
        }
        return true;
    }

Here is the call graph for this function:

---

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

• Modules/Course/classes/class.ilCourseLP.php