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

Collaboration diagram for ilObjectLP:

Public Member Functions
	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	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 (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Static Protected Member Functions
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
ilTree	$tree
ilDBInterface	$db
ilObjectDefinition	$objectDefinition
int	$obj_id
ilLPCollection	$collection_instance = null
int	$mode = null

Static Protected Attributes
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 Base class for object lp connectors

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilObjectLP::__construct ( int  $obj_id )

protected

Definition at line 39 of file class.ilObjectLP.php.

References $DIC, $obj_id, and ILIAS\Repository\objectDefinition().

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->db = $DIC->database();
        $this->objectDefinition = $DIC['objDefinition'];

        $this->obj_id = $obj_id;
    }

Here is the call graph for this function:

Member Function Documentation

appendModeConfiguration()

ilObjectLP::appendModeConfiguration	(	int	$mode,
		ilRadioOption	$modeElement
	)

Definition at line 712 of file class.ilObjectLP.php.

                                                                                  : void
    {
    }

fetchIndividualModeFromFormSubmission()

ilObjectLP::fetchIndividualModeFromFormSubmission

(

ilPropertyFormGUI

$form

)

Definition at line 707 of file class.ilObjectLP.php.

                                                                                  : int
    {
        return 0;
    }

findMembershipsByPath()

static ilObjectLP::findMembershipsByPath ( array &  $res, int  $usr_id, int  $parent_ref_id, array  $obj_ids, bool  $mapped_ref_ids = false  )

staticprotected

Find (lp-relevant) memberships by path.

Definition at line 450 of file class.ilObjectLP.php.

References $DIC, $obj_id, $path, $ref_id, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTree\getPathId(), and ilTree\isGrandChild().

     : array {
        global $DIC;

        $tree = $DIC->repositoryTree();

        $found = array();

        // walk path to find course or group object and check members of that object
        $path = $tree->getPathId($parent_ref_id);
        foreach (array_reverse($path) as $path_ref_id) {
            $type = ilObject::_lookupType($path_ref_id, true);
            if ($type == "crs" || $type == "grp") {
                $class = self::getTypeClass($type);
                $path_ob_id = ilObject::_lookupObjId($path_ref_id);
                $chk = array();
                $class::isLPMember($chk, $usr_id, array($path_ob_id));
                if (!$mapped_ref_ids) {
                    // we found a grp/crs in path of (single) parent - mark all objects
                    foreach ($obj_ids as $obj_id) {
                        $found[] = $obj_id;
                        if ($chk[$path_ob_id] ?? false) {
                            $res[$obj_id] = true;
                        }
                    }
                } else {
                    // all children from current node are "lp-valid"
                    foreach ($obj_ids as $obj_id => $ref_ids) {
                        foreach ($ref_ids as $ref_id) {
                            if ($tree->isGrandChild($path_ref_id, $ref_id)) {
                                $found[$obj_id][] = $ref_id;
                                if ($chk[$path_ob_id] ?? false) {
                                    $res[$obj_id] = true;
                                }
                                break;
                            }
                        }
                    }
                }
                break;
            }
        }

        return $found;
    }

Here is the call graph for this function:

gatherLPUsers()

ilObjectLP::gatherLPUsers ( )

protected

Definition at line 328 of file class.ilObjectLP.php.

References ilLPMarks\_getAllUserIds(), and ilChangeEvent\_getAllUserIds().

Referenced by resetLPDataForCompleteObject().

                                      : array
    {
        $user_ids = ilLPMarks::_getAllUserIds($this->obj_id);
        return array_merge($user_ids, ilChangeEvent::_getAllUserIds($this->obj_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCollectionInstance()

ilObjectLP::getCollectionInstance

(

)

Definition at line 261 of file class.ilObjectLP.php.

References $collection_instance, getCurrentMode(), and ilLPCollection\getInstanceByMode().

Referenced by ilTrSummaryTableGUI\getItems(), and handleDelete().

                                           : ?ilLPCollection
    {
        if ($this->collection_instance === null) {
            $this->collection_instance = ilLPCollection::getInstanceByMode($this->obj_id, $this->getCurrentMode());
        }
        return $this->collection_instance;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentMode()

ilObjectLP::getCurrentMode

(

)

Definition at line 207 of file class.ilObjectLP.php.

References $mode, ilObjUserTracking\_enabledLearningProgress(), ilLPObjSettings\_lookupDBMode(), ilObject\_lookupType(), getDefaultMode(), ILIAS\Repository\int(), and ilLPObjSettings\LP_MODE_DEACTIVATED.

Referenced by getCollectionInstance(), ilTrSummaryTableGUI\getItems(), ilCmiXapiLP\initModeOptions(), isActive(), and ilCertificateSettingsCourseFormRepository\save().

                                    : int
    {
        if ($this->mode === null) {
            // using global type default if LP is inactive
            if (!ilObjUserTracking::_enabledLearningProgress()) {
                $mode = self::getTypeDefaultFromDB(ilObject::_lookupType($this->obj_id));
                if ($mode === null) {
                    // fallback: inactive as type default may not be suitable
                    $mode = ilLPObjSettings::LP_MODE_DEACTIVATED;
                }
            }
            // use object LP setting
            else {
                $mode = ilLPObjSettings::_lookupDBMode($this->obj_id);
                if ($mode === null) {
                    // fallback: object type default
                    $mode = $this->getDefaultMode();
                }
            }
            $this->mode = (int) $mode;
        }

        return $this->mode;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultMode()

ilObjectLP::getDefaultMode

(

)

Definition at line 194 of file class.ilObjectLP.php.

References ilLPObjSettings\LP_MODE_UNDEFINED.

Referenced by getCurrentMode().

                                    : int
    {
        return ilLPObjSettings::LP_MODE_UNDEFINED;
    }

Here is the caller graph for this function:

getDefaultModes()

static ilObjectLP::getDefaultModes ( bool  $lp_active )

static

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

Returns

int[]

Definition at line 647 of file class.ilObjectLP.php.

References ilLPObjSettings\LP_MODE_UNDEFINED.

                                                           : array
    {
        return array(ilLPObjSettings::LP_MODE_UNDEFINED);
    }

getInstance()

static ilObjectLP::getInstance ( int  $obj_id )

static

Parameters

int

$obj_id

Returns

ilObjectLP|mixed

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

References $obj_id, $type, and ilObject\_lookupType().

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilScormPlaceholderDescription\__construct(), ilLPListOfSettingsGUI\__construct(), ilForumStatisticsTableGUI\__construct(), ilCertificateSettingsCourseFormRepository\__construct(), ilLPProgressTableGUI\__construct(), ilTrSummaryTableGUI\__construct(), ilLPTableBaseGUI\__construct(), ilXapiStatementEvaluation\__construct(), ilLearningProgressBaseGUI\__construct(), ilLPObjSettings\__construct(), ilLearningProgressGUI\__getNextClass(), ilLPListOfProgressGUI\__initDetails(), ilLPListOfObjectsGUI\__initDetails(), ilLearningProgressBaseGUI\__setSubTabs(), ilLearningProgressBaseGUI\__showObjectDetails(), ilLPStatusFactory\_getClassById(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilLPStatusCollection\_getInProgress(), ilLPStatusFactory\_getInstance(), ilLPStatusSCORM\_getNotAttempted(), ilLPStatusCollectionManual\_getStatusInfo(), ilLPStatusCollectionTLT\_getStatusInfo(), ilLPStatusSCORM\_getStatusInfo(), ilLPStatusCollection\_getStatusInfo(), ilLPStatusCollectionManual\_setObjectStatus(), ILIAS\MediaCast\LearningProgress\LearningProgressManager\addItemToLP(), ilConditionHandlerGUI\assign(), ilContentPageKioskModeView\buildLearningProgressToggleControl(), ilLearningProgressAccess\checkAccess(), ilLMExplorerGUI\checkLPIcon(), ilLPStatus\checkLPModesForObjects(), ilContainer\cloneDependencies(), ilObjMediaCast\copyOrder(), ilObjSurvey\deleteAllUserData(), ilLPListOfProgressGUI\details(), ilLPStatusSCORM\determinePercentage(), ilLPStatusSCORM\determineStatus(), ilLPStatusCollection\determineStatus(), ilObjContentObject\doMDUpdateListener(), ilLearningProgressGUI\editManual(), ilLPProgressTableGUI\fillRow(), ilLPCronObjectStatistics\gatherCourseLPData(), ilLPStatusCollectionMobs\getCollectionItems(), ilScormMailTemplateLPContext\getDescription(), ilCertificateObjectLPHelper\getInstance(), ilTrSummaryTableGUI\getItems(), ilObjCmiXapi\getLPMode(), ilLPListOfSettingsGUI\getLPPathInfo(), ilTrQuery\getObjectIds(), ilTrQuery\getObjectsStatusForUser(), ilTimingsUser\getObjectsWithInactiveLP(), ilTrQuery\getParticipantsForObject(), ilCourseMembershipGUI\getPrintMemberData(), ilLPTableBaseGUI\getSelectableUserColumns(), ilObjSCORMInitData\getStatus(), ilTrQuery\getSubItemsStatusForUser(), ilTrQuery\getSubTree(), ilTrackingAppEventListener\handleEvent(), ilCourseAppEventListener\handleEvent(), ilLTIAppEventListener\handleOutcomeWithoutLP(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilMembershipGUI\initAttendanceList(), ilLearningProgressGUI\initCollectionManualForm(), ilCourseLPBadgeGUI\initConfigForm(), ilObjCourseGUI\initEditForm(), ilLearningProgressBaseGUI\initEditUserForm(), ilTrUserObjectsPropsTableGUI\initFilter(), ilConditionHandlerGUI\initFormCondition(), ilGroupMembershipGUI\initParticipantTableGUI(), ilCourseMembershipGUI\initParticipantTableGUI(), ilLPStatusPlugin\initPluginObj(), ilIndividualAssessmentLPInterface\isActiveLP(), ILIAS\MediaCast\LearningProgress\LearningProgressManager\isCollectionMode(), ilLPTableBaseGUI\isPercentageAvailable(), ilSCORMTrackingItems\markedLearningStatusForExportSelected(), ilLearningModuleKioskModeView\maybeBuildLearningProgressToggleControl(), ilLMObject\MDUpdateListener(), ilLPCollectionOfRepositoryObjects\parseTableGUIItem(), ilLPTableBaseGUI\parseTitle(), ilObjSAHSLearningModule\populateByDirectoy(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), ilObjCourseGUI\readMemberData(), ilTimingCache\readObjectInformation(), ilObjSurvey\removeSelectedSurveyResults(), ilObjTest\removeTestResults(), ilLMMenuRendererGUI\render(), ilCourseObjectiveResult\resetTestForUser(), ilCertificateSettingsCourseFormRepository\save(), ilLPTableBaseGUI\searchFilterListener(), ilLPTableBaseGUI\sendMail(), ilInfoScreenGUI\showLearningProgress(), ilLearningProgressGUI\showtlt(), ilContentPageKioskModeView\toggleLearningProgress(), ilLearningModuleKioskModeView\toggleLearningProgress(), ilConditionHandlerGUI\updateCondition(), ilObjCourseGUI\updateLPFromStatus(), ilLearningProgressGUI\updateManual(), ilLPCollectionOfRepositoryObjects\validateEntry(), and ilCourseLPBadgeGUI\validateForm().

    {
        static $instances = array();

        if (!isset($instances[$obj_id])) {
            $type = ilObject::_lookupType($obj_id);
            $class = self::getTypeClass($type);
            if ($class) {
                $instance = new $class($obj_id);
            } else {
                // :TODO: should we return anything?
                $instance = new self($obj_id);
            }
            $instances[$obj_id] = $instance;
        }
        return $instances[$obj_id];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLPMemberships()

static ilObjectLP::getLPMemberships ( int  $usr_id, array  $obj_ids, ?int  $parent_ref_id = null, bool  $mapped_ref_ids = false  )

static

Get all objects where given user is member (from LP POV)

Definition at line 504 of file class.ilObjectLP.php.

References $DIC, $ilDB, $ref_id, $res, $type, ilTree\getParentId(), ILIAS\Repository\int(), and ROOT_FOLDER_ID.

Referenced by ilLPProgressTableGUI\getItems(), and ilLPStatus\validateLPForObjects().

     : array {
        global $DIC;

        $ilDB = $DIC->database();
        $tree = $DIC->repositoryTree();

        // see ilTrQuery::getParticipantsForObject() [single object only]
        // this is optimized for larger number of objects, e.g. list GUIs

        $ref_map = [];
        if ($mapped_ref_ids) {
            $ref_map = $obj_ids;
            $obj_ids = array_keys($obj_ids);
        }

        $res = [];

        // get object types
        $types_map = [];
        $sql =
            "SELECT obj_id, type" . PHP_EOL
            . "FROM object_data" . PHP_EOL
            . "WHERE " . $ilDB->in("obj_id", $obj_ids, false, "integer") . PHP_EOL
        ;
        $result = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($result)) {
            $types_map[$row["type"]][] = (int) $row["obj_id"];
            $res[(int) $row["obj_id"]] = false;
        }

        $find_by_parent = [];
        foreach ($types_map as $type => $type_obj_ids) {
            $class = self::getTypeClass($type);
            if ($class) {
                // lp-supported type?
                if (!$class::isLPMember($res, $usr_id, $type_obj_ids)) {
                    $find_by_parent = array_merge($find_by_parent, $type_obj_ids);
                }
            }
        }

        if (sizeof($find_by_parent)) {
            // single parent for all objects (repository/ilObjectListGUI)
            if ($parent_ref_id) {
                if (self::findMembershipsByPath($res, $usr_id, $parent_ref_id, $find_by_parent)) {
                    // we found a crs/grp in path, so no need to check read_events
                    $find_by_parent = null;
                }
            }
            // different parents (PD > LP)
            elseif (is_array($ref_map) && count($ref_map) > 0) {
                foreach ($find_by_parent as $obj_id) {
                    // maybe already found by path search from other object/reference
                    if ($res[$obj_id] === false) {
                        if (isset($ref_map[$obj_id]) && is_array($ref_map[$obj_id])) {
                            // check all references
                            foreach ($ref_map[$obj_id] as $ref_id) {
                                $parent_ref_id = $tree->getParentId($ref_id);
                                if ($parent_ref_id == ROOT_FOLDER_ID) {
                                    continue;
                                }

                                // we are checking the complete ref_map
                                // to find all relevant objects in subtree of current ref_id
                                $found = self::findMembershipsByPath($res, $usr_id, $parent_ref_id, $ref_map, true);
                                if (is_array($found) && count($found) > 0) {
                                    // if any references were found in a crs/grp-subtree
                                    // remove from "read-event"-last-resort-pool
                                    foreach ($found as $found_obj_id => $found_ref_ids) {
                                        $diff = array_diff($ref_map[$found_obj_id], $found_ref_ids);
                                        if ($diff) {
                                            // 1-n refs are in another subtree
                                            // have to be checked separately
                                            $ref_map[$found_obj_id] = $diff;
                                        } else {
                                            // all references found in subtree
                                            // no need to check again
                                            unset($ref_map[$found_obj_id]);
                                        }
                                    }
                                    break;
                                }
                            }
                        }
                    }
                }

                $find_by_parent = array_keys($ref_map);
            }

            // last resort: use read_event?
            if (is_array($find_by_parent) && count($find_by_parent) > 0) {
                $sql =
                    "SELECT obj_id" . PHP_EOL
                    . "FROM read_event" . PHP_EOL
                    . "WHERE " . $ilDB->in("obj_id", $find_by_parent, false, "integer") . PHP_EOL
                    . "AND usr_id = " . $ilDB->quote($usr_id, "integer") . PHP_EOL
                ;
                $result = $ilDB->query($sql);
                while ($row = $ilDB->fetchAssoc($result)) {
                    $res[(int) $row["obj_id"]] = true;
                }
            }
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMailTemplateId()

ilObjectLP::getMailTemplateId

(

)

Definition at line 617 of file class.ilObjectLP.php.

                                       : string
    {
        return '';
    }

getMembers()

ilObjectLP::getMembers

(

bool

$search = true

)

Definition at line 269 of file class.ilObjectLP.php.

References $path, $ref_id, ilObject\_getAllReferences(), and ilObject\_lookupObjId().

                                                   : array
    {
        if (!$search) {
            return [];
        }

        $ref_ids = ilObject::_getAllReferences($this->obj_id);
        $ref_id = current($ref_ids);

        // walk path to find parent with specific members
        $path = $this->tree->getPathId($ref_id);
        array_pop($path);
        foreach (array_reverse($path) as $path_ref_id) {
            $olp = self::getInstance(ilObject::_lookupObjId($path_ref_id));
            $all = $olp->getMembers(false);
            if (is_array($all)) {
                return $all;
            }
        }
        return [];
    }

Here is the call graph for this function:

getModeInfoText()

ilObjectLP::getModeInfoText

(

int

$mode

)

Definition at line 249 of file class.ilObjectLP.php.

References ilLPObjSettings\_mode2InfoText().

                                              : string
    {
        return ilLPObjSettings::_mode2InfoText($mode);
    }

Here is the call graph for this function:

getModeText()

ilObjectLP::getModeText

(

int

$mode

)

Definition at line 244 of file class.ilObjectLP.php.

References ilLPObjSettings\_mode2Text().

                                          : string
    {
        return ilLPObjSettings::_mode2Text($mode);
    }

Here is the call graph for this function:

getSettingsInfo()

ilObjectLP::getSettingsInfo

(

)

Definition at line 254 of file class.ilObjectLP.php.

                                     : string
    {
        // type-specific
        return "";
    }

getSupportedObjectTypes()

static ilObjectLP::getSupportedObjectTypes ( )

static

Definition at line 131 of file class.ilObjectLP.php.

References $DIC, XapiProxy\$plugin, $type, $valid, and ilRepositoryObjectPluginSlot\isTypePluginWithLP().

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\getActualMaxLevels().

                                                    : array
    {
        global $DIC;
        $component_repository = $DIC["component.repository"];

        $valid = [
            "crs",
            "grp",
            "fold",
            "lm",
            "htlm",
            "sahs",
            "tst",
            "exc",
            "sess",
            "svy",
            "file",
            "mcst",
            "prg",
            "iass",
            "copa",
            "lso",
            'cmix',
            'lti',
            'crsr',
            'frm'
        ];

        $plugins = $component_repository->getPluginSlotById("robj")->getActivePlugins();
        foreach ($plugins as $plugin) {
            $type = $plugin->getId();
            if (ilRepositoryObjectPluginSlot::isTypePluginWithLP($type)) {
                $valid[] = $type;
            }
        }


        return $valid;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeClass()

static ilObjectLP::getTypeClass ( string  $type )

static

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

References $DIC.

Referenced by ilCourseLPBadgeGUI\getLPTypes(), ilCertificateObjectLPHelper\getTypeClass(), and ilObjUserTrackingGUI\initLPDefaultsForm().

                                                     : string
    {
        global $DIC;
        $objDefinition = $DIC["objDefinition"];
        if (self::isSupportedObjectType($type)) {
            switch ($type) {
                // container
                case "crs":
                    return "ilCourseLP";
                case 'crsr':
                    return 'ilCourseReferenceLP';
                case "grp":
                    return "ilGroupLP";
                case "fold":
                    return "ilFolderLP";
                case "lso":
                    return "ilLSLP";

                    // learning resources
                case "lm":
                    return "ilLearningModuleLP";
                case "htlm":
                    return "ilHTMLLearningModuleLP";
                case "sahs":
                    return "ilScormLP";

                    // misc
                case "tst":
                    return "ilTestLP";
                case "exc":
                    return "ilExerciseLP";
                case 'file':
                    return 'ilFileLP';
                case "mcst":
                    return "ilMediaCastLP";
                case "sess":
                    return  "ilSessionLP";
                case "svy":
                    return  "ilSurveyLP";
                case "prg":
                    return "ilStudyProgrammeLP";
                case "iass":
                    return "ilIndividualAssessmentLP";
                case "copa":
                    return "ilContentPageLP";
                case 'cmix':
                    return ilCmiXapiLP::class;
                case 'lti':
                    return ilLTIConsumerLP::class;
                case 'frm':
                    return ilForumLP::class;
            }
            if ($objDefinition->isPluginTypeName($type)) {
                return "ilPluginLP";
            }
        }
        return "";
    }

Here is the caller graph for this function:

getTypeDefault()

static ilObjectLP::getTypeDefault ( string  $type )

static

Definition at line 681 of file class.ilObjectLP.php.

References $db.

Referenced by ilObjUserTrackingGUI\initLPDefaultsForm().

                                                       : int
    {
        $db = self::getTypeDefaultFromDB($type);
        if ($db !== null) {
            return $db;
        }

        $class = self::getTypeClass($type);
        $olp = new $class(0);
        return $olp->getDefaultMode();
    }

Here is the caller graph for this function:

getTypeDefaultFromDB()

static ilObjectLP::getTypeDefaultFromDB ( string  $type )

staticprotected

Definition at line 652 of file class.ilObjectLP.php.

References $DIC, $ilDB, and $type.

                                                                : ?int
    {
        global $DIC;
        $ilDB = $DIC->database();

        if (is_null(self::$type_defaults)) {
            self::$type_defaults = [];
            $result = $ilDB->query("SELECT type_id, lp_mode FROM ut_lp_defaults");
            while ($row = $ilDB->fetchAssoc($result)) {
                self::$type_defaults[(string) $row["type_id"]] = (int) $row["lp_mode"];
            }
        }
        return self::$type_defaults[$type] ?? null;
    }

getValidModes()

ilObjectLP::getValidModes

(

)

Returns

int[]

Definition at line 202 of file class.ilObjectLP.php.

                                   : array
    {
        return [];
    }

handleDelete()

ilObjectLP::handleDelete ( )

final

Definition at line 398 of file class.ilObjectLP.php.

References ilChangeEvent\_delete(), ilLPMarks\deleteObject(), getCollectionInstance(), and updateParentCollections().

                                        : void
    {
        ilLPMarks::deleteObject($this->obj_id);

        ilChangeEvent::_delete($this->obj_id);

        $collection = $this->getCollectionInstance();
        if ($collection) {
            $collection->delete();
        }

        $this->updateParentCollections();
    }

Here is the call graph for this function:

handleMove()

static ilObjectLP::handleMove ( int  $source_ref_id )

staticfinal

Definition at line 334 of file class.ilObjectLP.php.

References $DIC, $ilDB, ilObject\_getAllReferences(), ilObject\_lookupType(), ilLPStatusWrapper\_refreshStatus(), ilTree\getPathId(), ilTree\getSubTreeIds(), and ilTree\isGrandChild().

Referenced by ilTrackingAppEventListener\handleEvent().

                                                               : void
    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilDB = $DIC->database();

        $ref_ids = $tree->getSubTreeIds($source_ref_id);
        $ref_ids[] = $source_ref_id;

        // get "parent" path to source node (not including source node)
        $new_path = $tree->getPathId($source_ref_id);
        array_pop($new_path);
        $new_path = implode("/", $new_path);

        // find collections with ref_ids
        $sql =
            "SELECT DISTINCT(ut_lp_collections.obj_id) obj_id" . PHP_EOL
            . "FROM object_reference" . PHP_EOL
            . "JOIN ut_lp_collections ON" . PHP_EOL
            . "(" . $ilDB->in("object_reference.ref_id", $ref_ids, false, "integer") . PHP_EOL
            . "AND object_reference.ref_id = ut_lp_collections.item_id)" . PHP_EOL
        ;
        $result = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($result)) {
            if (in_array(ilObject::_lookupType((int) $row["obj_id"]), ["crs", "grp", "fold"])) {
                $coll_ref_id = ilObject::_getAllReferences((int) $row["obj_id"]);
                $coll_ref_id = array_pop($coll_ref_id);

                // #13402
                if ($coll_ref_id == $source_ref_id) {
                    continue;
                }

                // #17703 - collection has also been moved - nothing todo
                if ($tree->isGrandChild($source_ref_id, $coll_ref_id)) {
                    continue;
                }

                // get path to collection (including collection "parent")
                $coll_path = $tree->getPathId($coll_ref_id);
                $coll_path = implode("/", $coll_path);

                // collection path is not inside new path
                if (!stristr($new_path, $coll_path)) {
                    // delete all items of moved (sub-)tree
                    $sql =
                        "DELETE FROM ut_lp_collections" . PHP_EOL
                        . "WHERE obj_id = " . $ilDB->quote($row["obj_id"], "integer") . PHP_EOL
                        . "AND " . $ilDB->in("item_id", $ref_ids, false, "integer") . PHP_EOL
                    ;
                    $ilDB->manipulate($sql);

                    ilLPStatusWrapper::_refreshStatus((int) $row["obj_id"]);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleToTrash()

ilObjectLP::handleToTrash ( )

final

Definition at line 393 of file class.ilObjectLP.php.

References updateParentCollections().

                                         : void
    {
        $this->updateParentCollections();
    }

Here is the call graph for this function:

hasIndividualModeOptions()

ilObjectLP::hasIndividualModeOptions

(

)

Definition at line 693 of file class.ilObjectLP.php.

                                              : bool
    {
        return false;
    }

initInvidualModeOptions()

ilObjectLP::initInvidualModeOptions

(

ilRadioGroupInputGUI

$modeRadio

)

Definition at line 698 of file class.ilObjectLP.php.

                                                                            : void
    {
    }

isActive()

ilObjectLP::isActive

(

)

Definition at line 232 of file class.ilObjectLP.php.

References getCurrentMode(), ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_UNDEFINED.

                              : bool
    {
        // :TODO: check LP activation?

        $mode = $this->getCurrentMode();
        if ($mode == ilLPObjSettings::LP_MODE_DEACTIVATED ||
            $mode == ilLPObjSettings::LP_MODE_UNDEFINED) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

isAnonymized()

ilObjectLP::isAnonymized

(

)

Definition at line 188 of file class.ilObjectLP.php.

                                  : bool
    {
        // see ilLPCollectionOfRepositoryObjects::validateEntry()
        return false;
    }

isLPMember()

static ilObjectLP::isLPMember ( array &  $res, int  $usr_id, array  $obj_ids  )

staticprotected

Find (lp-relevant) members for given object ids.

Definition at line 441 of file class.ilObjectLP.php.

                                                                                  : bool
    {
        // should be overwritten by object-type-specific class
        return false;
    }

isSupportedObjectType()

static ilObjectLP::isSupportedObjectType ( string  $type )

static

Definition at line 171 of file class.ilObjectLP.php.

References $valid.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilSkillLevelResourcesTableGUI\fillRow(), ilObjLearningSequenceLPPollingGUI\getCurrentItemLearningProgress(), ilLearnerProgressDB\getLearningProgressFor(), ilLPListOfSettingsGUI\getLPPathInfo(), ilCourseLPBadgeGUI\getLPTypes(), ilTimingsUser\getObjectsWithInactiveLP(), ilConditionHandler\getOperatorsByTriggerType(), ilConditionHandler\getTriggerTypes(), ilObjUserTrackingGUI\initLPDefaultsForm(), ilCertificateObjectLPHelper\isSupportedObjectType(), and ilObjUserTrackingGUI\saveLPDefaultsObject().

                                                              : bool
    {
        $valid = self::getSupportedObjectTypes();

        if (in_array($type, $valid)) {
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

resetCaches()

ilObjectLP::resetCaches

(

)

Definition at line 182 of file class.ilObjectLP.php.

                                 : void
    {
        $this->mode = null;
        $this->collection_instance = null;
    }

resetCustomLPDataForUserIds()

ilObjectLP::resetCustomLPDataForUserIds ( array  $user_ids, bool  $recursive = true  )

protected

Definition at line 323 of file class.ilObjectLP.php.

Referenced by resetLPDataForUserIds().

                                                                                           : void
    {
        // this should delete all data that is relevant for the supported LP modes
    }

Here is the caller graph for this function:

resetLPDataForCompleteObject()

ilObjectLP::resetLPDataForCompleteObject ( bool  $recursive = true )

final

Definition at line 291 of file class.ilObjectLP.php.

References gatherLPUsers(), and resetLPDataForUserIds().

                                                                              : void
    {
        $user_ids = $this->gatherLPUsers();
        if (sizeof($user_ids)) {
            $this->resetLPDataForUserIds(array_unique($user_ids), $recursive);
        }
    }

Here is the call graph for this function:

resetLPDataForUserIds()

ilObjectLP::resetLPDataForUserIds ( array  $user_ids, bool  $recursive = true  )

final

Definition at line 299 of file class.ilObjectLP.php.

References ilLPMarks\_deleteForUsers(), ilChangeEvent\_deleteReadEventsForUsers(), ilObject\_lookupObjId(), ilLPStatusWrapper\_updateStatus(), and resetCustomLPDataForUserIds().

Referenced by resetLPDataForCompleteObject().

                                                                                        : void
    {
        if ($recursive && method_exists($this, "getPossibleCollectionItems")) { // #15203
            $subitems = $this->getPossibleCollectionItems();
            if (is_array($subitems)) {
                foreach ($subitems as $sub_ref_id) {
                    $olp = self::getInstance(ilObject::_lookupObjId($sub_ref_id));
                    $olp->resetLPDataForUserIds($user_ids, false);
                }
            }
        }

        $this->resetCustomLPDataForUserIds($user_ids, $recursive);

        ilLPMarks::_deleteForUsers($this->obj_id, $user_ids);

        ilChangeEvent::_deleteReadEventsForUsers($this->obj_id, $user_ids);

        // update LP status to get collections up-to-date
        foreach ($user_ids as $user_id) {
            ilLPStatusWrapper::_updateStatus($this->obj_id, $user_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveModeConfiguration()

ilObjectLP::saveModeConfiguration	(	ilPropertyFormGUI	$form,
		bool &	$modeChanged
	)

Definition at line 716 of file class.ilObjectLP.php.

                                                                                      : void
    {
    }

saveTypeDefaults()

static ilObjectLP::saveTypeDefaults ( array  $data )

static

Definition at line 667 of file class.ilObjectLP.php.

References $DIC, $ilDB, and $type.

Referenced by ilObjUserTrackingGUI\saveLPDefaultsObject().

                                                        : void
    {
        global $DIC;
        $ilDB = $DIC->database();

        $ilDB->manipulate("DELETE FROM ut_lp_defaults");
        foreach ($data as $type => $mode) {
            $ilDB->insert("ut_lp_defaults", [
                "type_id" => ["text", $type],
                "lp_mode" => ["integer", $mode]
            ]);
        }
    }

Here is the caller graph for this function:

shouldFetchIndividualModeFromFormSubmission()

ilObjectLP::shouldFetchIndividualModeFromFormSubmission

(

)

Definition at line 702 of file class.ilObjectLP.php.

                                                                 : bool
    {
        return false;
    }

supportsMark()

static ilObjectLP::supportsMark ( string  $obj_type )

static

Definition at line 632 of file class.ilObjectLP.php.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilTrUserObjectsPropsTableGUI\fillRow(), ilTrSummaryTableGUI\getSelectableColumns(), ilLPTableBaseGUI\getSelectableUserColumns(), ilLearningProgressBaseGUI\initEditUserForm(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilLPTableBaseGUI\parseValue(), and ilTrSummaryTableGUI\parseValue().

                                                         : bool
    {
        return !in_array($obj_type, ["lm", "dbk"]);
    }

Here is the caller graph for this function:

supportsMatrixView()

static ilObjectLP::supportsMatrixView ( string  $obj_type )

static

Definition at line 637 of file class.ilObjectLP.php.

Referenced by ilLearningProgressBaseGUI\__setSubTabs().

                                                               : bool
    {
        $types = ['svy', 'tst', 'htlm', 'exc', 'sess', 'file', 'frm', 'prg', 'copa', 'cmix', 'lti','crsr'];
        return !in_array($obj_type, $types);
    }

Here is the caller graph for this function:

supportsSpentSeconds()

static ilObjectLP::supportsSpentSeconds ( string  $obj_type )

static

Definition at line 627 of file class.ilObjectLP.php.

Referenced by ilTrUserObjectsPropsTableGUI\fillRow(), ilTrSummaryTableGUI\getSelectableColumns(), ilLPTableBaseGUI\getSelectableUserColumns(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilLPTableBaseGUI\parseValue(), and ilTrSummaryTableGUI\parseValue().

                                                                 : bool
    {
        return !in_array($obj_type, ["exc", "file", "mcst", "mob", "htlm", "copa", 'cmix', 'lti', 'frm']);
    }

Here is the caller graph for this function:

updateParentCollections()

ilObjectLP::updateParentCollections ( )

finalprotected

Definition at line 412 of file class.ilObjectLP.php.

References ilObject\_lookupType(), and ilLPStatusWrapper\_refreshStatus().

Referenced by handleDelete(), and handleToTrash().

                                                      : void
    {
        // update parent collections?
        $sql =
            "SELECT ut_lp_collections.obj_id obj_id" . PHP_EOL
            . "FROM object_reference" . PHP_EOL
            . "JOIN ut_lp_collections ON" . PHP_EOL
            . "(object_reference.obj_id = " . $this->db->quote($this->obj_id, "integer") . PHP_EOL
            . "AND object_reference.ref_id = ut_lp_collections.item_id)" . PHP_EOL
        ;
        $result = $this->db->query($sql);
        while ($row = $this->db->fetchAssoc($result)) {
            if (in_array(ilObject::_lookupType((int) $row["obj_id"]), array("crs", "grp", "fold"))) {
                // remove from parent collection
                $sql =
                    "DELETE FROM ut_lp_collections" . PHP_EOL
                    . "WHERE obj_id = " . $this->db->quote($row["obj_id"], "integer") . PHP_EOL
                    . "AND item_id = " . $this->db->quote($this->obj_id, "integer") . PHP_EOL
                ;
                $this->db->manipulate($sql);

                ilLPStatusWrapper::_refreshStatus((int) $row["obj_id"]);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$collection_instance

ilLPCollection ilObjectLP::$collection_instance = null

protected

Definition at line 36 of file class.ilObjectLP.php.

Referenced by getCollectionInstance().

$db

ilDBInterface ilObjectLP::$db

protected

Definition at line 31 of file class.ilObjectLP.php.

Referenced by getTypeDefault().

$mode

int ilObjectLP::$mode = null

protected

Definition at line 37 of file class.ilObjectLP.php.

Referenced by getCurrentMode().

$obj_id

int ilObjectLP::$obj_id

protected

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

Referenced by __construct(), findMembershipsByPath(), and getInstance().

$objectDefinition

ilObjectDefinition ilObjectLP::$objectDefinition

protected

Definition at line 32 of file class.ilObjectLP.php.

$tree

ilTree ilObjectLP::$tree

protected

Definition at line 30 of file class.ilObjectLP.php.

$type_defaults

array ilObjectLP::$type_defaults = null

staticprotected

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

---

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

• Services/Object/classes/class.ilObjectLP.php