ilObjectLP Class Reference

Inheritance diagram for ilObjectLP:

Collaboration diagram for ilObjectLP:

Public Member Functions
	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	getInstance ($a_obj_id)
static	getTypeClass ($a_type)
static	getSupportedObjectTypes ()
static	isSupportedObjectType ($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)
	resetCustomLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Static Protected Member Functions
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
	$tree
	$db
	$obj_id
	$collection_instance
	$mode

Static Protected Attributes
static	$type_defaults

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjectLP::__construct (   $a_obj_id )

protected

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

References $DIC.

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->db = $DIC->database();
        $this->obj_id = (int) $a_obj_id;
    }

Member Function Documentation

findMembershipsByPath()

static ilObjectLP::findMembershipsByPath ( array &  $a_res,   $a_usr_id,   $a_parent_ref_id, array  $a_obj_ids,   $a_mapped_ref_ids = false  )

staticprotected

Find (lp-relevant) memberships by path.

Parameters

array	$a_res
int	$a_usr_id
int	$a_parent_ref_id
array	$a_obj_ids
bool	$a_mapped_ref_ids

Returns

array

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

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

    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        
        $found = array();
                
        // walk path to find course or group object and check members of that object
        $path = $tree->getPathId($a_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, $a_usr_id, array($path_ob_id));
                if (!$a_mapped_ref_ids) {
                    // we found a grp/crs in path of (single) parent - mark all objects
                    foreach ($a_obj_ids as $obj_id) {
                        $found[] = $obj_id;
                        if ($chk[$path_ob_id]) {
                            $a_res[$obj_id] = true;
                        }
                    }
                } else {
                    // all children from current node are "lp-valid"
                    foreach ($a_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]) {
                                    $a_res[$obj_id] = true;
                                }
                                break;
                            }
                        }
                    }
                }
                break;
            }
        }
        
        return $found;
    }

Here is the call graph for this function:

gatherLPUsers()

ilObjectLP::gatherLPUsers ( )

protected

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

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

Referenced by resetLPDataForCompleteObject().

    {
        include_once "Services/Tracking/classes/class.ilLPMarks.php";
        $user_ids = ilLPMarks::_getAllUserIds($this->obj_id);
        
        include_once "Services/Tracking/classes/class.ilChangeEvent.php";
        $user_ids = array_merge($user_ids, ilChangeEvent::_getAllUserIds($this->obj_id));
        
        return $user_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCollectionInstance()

ilObjectLP::getCollectionInstance

(

)

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

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

Referenced by handleDelete().

    {
        if ($this->collection_instance === null) {
            include_once "Services/Tracking/classes/collection/class.ilLPCollection.php";
            $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 236 of file class.ilObjectLP.php.

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

Referenced by getCollectionInstance(), ilCmiXapiLP\initModeOptions(), and isActive().

    {
        if ($this->mode === null) {
            // using global type default if LP is inactive
            include_once "Services/Tracking/classes/class.ilObjUserTracking.php";
            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 226 of file class.ilObjectLP.php.

References ilLPObjSettings\LP_MODE_UNDEFINED.

Referenced by getCurrentMode().

    {
        return ilLPObjSettings::LP_MODE_UNDEFINED;
    }

Here is the caller graph for this function:

getDefaultModes()

static ilObjectLP::getDefaultModes (   $a_lp_active )

static

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

Parameters

bool

$a_lp_active

Returns

array

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

References ilLPObjSettings\LP_MODE_UNDEFINED.

    {
        return array(ilLPObjSettings::LP_MODE_UNDEFINED);
    }

getInstance()

static ilObjectLP::getInstance (   $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

ilObjectLP

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

References $type, and ilObject\_lookupType().

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLPProgressTableGUI\__construct(), ilLPTableBaseGUI\__construct(), ilLPListOfSettingsGUI\__construct(), ilTrSummaryTableGUI\__construct(), ilScormPlaceholderDescription\__construct(), ilXapiStatementEvaluation\__construct(), ilCertificateSettingsCourseFormRepository\__construct(), ilLearningProgressBaseGUI\__construct(), ilLPObjSettings\__construct(), ilLearningProgressGUI\__getNextClass(), ilLPListOfProgressGUI\__initDetails(), ilLPListOfObjectsGUI\__initDetails(), ilLearningProgressBaseGUI\__readItemStatusInfo(), ilLearningProgressBaseGUI\__setSubTabs(), ilLearningProgressBaseGUI\__showObjectDetails(), ilLPStatusFactory\_getClassById(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilLPStatusCollection\_getInProgress(), ilLPStatusFactory\_getInstance(), ilLPStatusSCORM\_getNotAttempted(), ilLPStatusCollectionTLT\_getStatusInfo(), ilLPStatusCollectionManual\_getStatusInfo(), ilLPStatusSCORM\_getStatusInfo(), ilLPStatusCollection\_getStatusInfo(), ilLPStatusCollectionManual\_setObjectStatus(), ilObjMediaCast\addMobToCast(), ilConditionHandlerGUI\assign(), ilContentPageKioskModeView\buildLearningProgressToggleControl(), ilLearningProgressAccess\checkAccess(), ilLMExplorerGUI\checkLPIcon(), ilLPStatus\checkLPModesForObjects(), ilContainer\cloneDependencies(), ilObjMediaCast\copyOrder(), ilObjSurvey\deleteAllUserData(), ilLPStatusSCORM\determinePercentage(), ilLPStatusSCORM\determineStatus(), ilLPStatusCollection\determineStatus(), 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(), ilLearningProgressGUI\initCollectionManualForm(), ilCourseLPBadgeGUI\initConfigForm(), ilObjCourseGUI\initEditForm(), ilLearningProgressBaseGUI\initEditUserForm(), ilTrUserObjectsPropsTableGUI\initFilter(), ilConditionHandlerGUI\initFormCondition(), ilGroupMembershipGUI\initParticipantTableGUI(), ilCourseMembershipGUI\initParticipantTableGUI(), ilLPStatusPlugin\initPluginObj(), ilIndividualAssessmentLPInterface\isActiveLP(), ilLPTableBaseGUI\isPercentageAvailable(), ilMembershipGUI\jump2UsersGallery(), ilSCORMTrackingItems\markedLearningStatusForExportSelected(), ilLearningModuleKioskModeView\maybeBuildLearningProgressToggleControl(), ilLMObject\MDUpdateListener(), ilObjContentObject\MDUpdateListener(), ilLPCollectionOfRepositoryObjects\parseTableGUIItem(), ilLPTableBaseGUI\parseTitle(), ilObjSAHSLearningModule\populateByDirectoy(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), ilObjCourseGUI\readMemberData(), ilTimingCache\readObjectInformation(), ilObjSurvey\removeSelectedSurveyResults(), ilObjTest\removeTestResults(), ilLMMenuRendererGUI\render(), ilCourseObjectiveResult\resetTestForUser(), ilLPListOfProgressGUI\saveProgress(), ilLPTableBaseGUI\searchFilterListener(), ilLPTableBaseGUI\sendMail(), ilObjContentObjectGUI\setilLMMenu(), ilInfoScreenGUI\showLearningProgress(), ilLearningProgressGUI\showtlt(), ilContentPageKioskModeView\toggleLearningProgress(), ilLearningModuleKioskModeView\toggleLearningProgress(), ilSCORMOfflineMode\tracking2sop(), ilObjContentPage\trackProgress(), ilConditionHandlerGUI\updateCondition(), ilObjCourseGUI\updateLPFromStatus(), ilLearningProgressGUI\updateManual(), ilLPCollectionOfRepositoryObjects\validateEntry(), and ilCourseLPBadgeGUI\validateForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLPMemberships()

static ilObjectLP::getLPMemberships (   $a_usr_id, array  $a_obj_ids,   $a_parent_ref_id = null,   $a_mapped_ref_ids = false  )

static

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

Parameters

int	$a_usr_id
array	$a_obj_ids
int	$a_parent_ref_id
bool	$a_mapped_ref_ids

Returns

array

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

References $DIC, $ilDB, $obj_id, $query, $res, $tree, $type, and ROOT_FOLDER_ID.

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

    {
        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 ((bool) $a_mapped_ref_ids) {
            $ref_map = $a_obj_ids;
            $a_obj_ids = array_keys($a_obj_ids);
        }
        
        $res = array();
        
        // get object types
        $types_map = array();
        $query = " SELECT obj_id, type" .
            " FROM object_data" .
            " WHERE " . $ilDB->in("obj_id", $a_obj_ids, "", "integer");
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $types_map[$row["type"]][] = $row["obj_id"];
            $res[$row["obj_id"]] = false;
        }
        
        $find_by_parent = array();
        foreach ($types_map as $type => $type_obj_ids) {
            $class = self::getTypeClass($type);
            if ($class) {
                // lp-supported type?
                if (!$class::isLPMember($res, $a_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 ($a_parent_ref_id) {
                if (self::findMembershipsByPath($res, $a_usr_id, $a_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, $a_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) {
                $set = $ilDB->query("SELECT obj_id" .
                    " FROM read_event" .
                    " WHERE " . $ilDB->in("obj_id", $find_by_parent, "", "integer") .
                    " AND usr_id = " . $ilDB->quote($a_usr_id, "integer"));
                while ($row = $ilDB->fetchAssoc($set)) {
                    $res[$row["obj_id"]] = true;
                }
            }
        }
        
        return $res;
    }

Here is the caller graph for this function:

getMailTemplateId()

ilObjectLP::getMailTemplateId

(

)

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

    {
        // type-specific
    }

getMembers()

ilObjectLP::getMembers

(

$a_search = true

)

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

References $tree, ilObject\_getAllReferences(), and ilObject\_lookupObjId().

    {
        $tree = $this->tree;
        
        if (!$a_search) {
            return;
        }
        
        $ref_ids = ilObject::_getAllReferences($this->obj_id);
        $ref_id = current($ref_ids);
        
        // walk path to find parent with specific members
        $path = $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;
            }
        }
    }

Here is the call graph for this function:

getModeInfoText()

ilObjectLP::getModeInfoText

(

$a_mode

)

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

References ilLPObjSettings\_mode2InfoText().

    {
        return ilLPObjSettings::_mode2InfoText($a_mode);
    }

Here is the call graph for this function:

getModeText()

ilObjectLP::getModeText

(

$a_mode

)

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

References ilLPObjSettings\_mode2Text().

    {
        return ilLPObjSettings::_mode2Text($a_mode);
    }

Here is the call graph for this function:

getSettingsInfo()

ilObjectLP::getSettingsInfo

(

)

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

    {
        // type-specific
    }

getSupportedObjectTypes()

static ilObjectLP::getSupportedObjectTypes ( )

static

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

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

Referenced by ilPersonalSkillsGUI\getActualLevels().

                                                     : array
    {
        global $DIC;
        $ilPluginAdmin = $DIC['ilPluginAdmin'];

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

        $plugins = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
        foreach ($plugins as $plugin) {
            $type = $ilPluginAdmin->getId(IL_COMP_SERVICE, "Repository", "robj", $plugin);
            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 (   $a_type )

static

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

References $DIC.

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

    {
        global $DIC;

        $objDefinition = $DIC["objDefinition"];
        
        if (self::isSupportedObjectType($a_type)) {
            switch ($a_type) {
                // container

                case "crs":
                    include_once "Modules/Course/classes/class.ilCourseLP.php";
                    return "ilCourseLP";

                case 'crsr':
                    return 'ilCourseReferenceLP';

                case "grp":
                    include_once "Modules/Group/classes/class.ilGroupLP.php";
                    return "ilGroupLP";

                case "fold":
                    include_once "Modules/Folder/classes/class.ilFolderLP.php";
                    return "ilFolderLP";

                case "lso":
                    include_once "Modules/LearningSequence/classes/LearnerProgress/class.ilLSLP.php";
                    return "ilLSLP";


                // learning resources

                case "lm":
                    include_once "Modules/LearningModule/classes/class.ilLearningModuleLP.php";
                    return "ilLearningModuleLP";

                case "htlm":
                    include_once "Modules/HTMLLearningModule/classes/class.ilHTMLLearningModuleLP.php";
                    return "ilHTMLLearningModuleLP";

                case "sahs":
                    include_once "Modules/ScormAicc/classes/class.ilScormLP.php";
                    return "ilScormLP";
                    

                // misc

                case "tst":
                    include_once "Modules/Test/classes/class.ilTestLP.php";
                    return "ilTestLP";

                case "exc":
                    include_once "Modules/Exercise/classes/class.ilExerciseLP.php";
                    return "ilExerciseLP";
                    
                case 'file':
                    require_once 'Modules/File/classes/class.ilFileLP.php';
                    return 'ilFileLP';
                    
                case "mcst":
                    require_once "Modules/MediaCast/classes/class.ilMediaCastLP.php";
                    return "ilMediaCastLP";
            
                case "sess":
                    include_once "Modules/Session/classes/class.ilSessionLP.php";
                    return  "ilSessionLP";
                    
                case "svy":
                    return  "ilSurveyLP";

                case "prg":
                    include_once "Modules/StudyProgramme/classes/class.ilStudyProgrammeLP.php";
                    return "ilStudyProgrammeLP";

                case "iass":
                    include_once "Modules/IndividualAssessment/classes/class.ilIndividualAssessmentLP.php";
                    return "ilIndividualAssessmentLP";

                case "copa":
                    return "ilContentPageLP";

                case 'cmix':
                    return ilCmiXapiLP::class;

                case 'lti':
                    return ilLTIConsumerLP::class;

                // plugin
                case $objDefinition->isPluginTypeName($a_type):
                    include_once "Services/Component/classes/class.ilPluginLP.php";
                    return "ilPluginLP";
            }
        }
    }

Here is the caller graph for this function:

getTypeDefault()

static ilObjectLP::getTypeDefault (   $a_type )

static

Get current type default.

Parameters

string

$a_type

Returns

int

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

References $db.

Referenced by ilObjUserTrackingGUI\initLPDefaultsForm().

    {
        $db = self::getTypeDefaultFromDB($a_type);
        if ($db !== null) {
            return $db;
        }
        
        $class = self::getTypeClass($a_type);
        $olp = new $class(0);
        return $olp->getDefaultMode();
    }

Here is the caller graph for this function:

getTypeDefaultFromDB()

static ilObjectLP::getTypeDefaultFromDB (   $a_type )

staticprotected

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

References $DIC, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        if (!is_array(self::$type_defaults)) {
            self::$type_defaults = array();
            $set = $ilDB->query("SELECT * FROM ut_lp_defaults");
            while ($row = $ilDB->fetchAssoc($set)) {
                self::$type_defaults[$row["type_id"]] = $row["lp_mode"];
            }
        }
        return self::$type_defaults[$a_type];
    }

getValidModes()

ilObjectLP::getValidModes

(

)

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

    {
        return array();
    }

handleDelete()

ilObjectLP::handleDelete ( )

final

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

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

    {
        include_once "Services/Tracking/classes/class.ilLPMarks.php";
        ilLPMarks::deleteObject($this->obj_id);

        include_once "Services/Tracking/classes/class.ilChangeEvent.php";
        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 (   $a_source_ref_id )

staticfinal

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

References $DIC, $ilDB, $query, $tree, ilObject\_getAllReferences(), ilObject\_lookupType(), and ilLPStatusWrapper\_refreshStatus().

Referenced by ilTrackingAppEventListener\handleEvent().

    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilDB = $DIC->database();
        
        $ref_ids = $tree->getSubTreeIds($a_source_ref_id);
        $ref_ids[] = $a_source_ref_id;
        
        // get "parent" path to source node (not including source node)
        $new_path = $tree->getPathId($a_source_ref_id);
        array_pop($new_path);
        $new_path = implode("/", $new_path);
    
        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
        
        // find collections with ref_ids
        $set = $ilDB->query("SELECT DISTINCT(ut_lp_collections.obj_id) obj_id" .
            " FROM object_reference" .
            " JOIN ut_lp_collections ON" .
            " (" . $ilDB->in("object_reference.ref_id", $ref_ids, "", "integer") .
            " AND object_reference.ref_id = ut_lp_collections.item_id)");
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (in_array(ilObject::_lookupType($rec["obj_id"]), array("crs", "grp", "fold"))) {
                $coll_ref_id = ilObject::_getAllReferences($rec["obj_id"]);
                $coll_ref_id = array_pop($coll_ref_id);
                
                // #13402
                if ($coll_ref_id == $a_source_ref_id) {
                    continue;
                }
                
                // #17703 - collection has also been moved - nothing todo
                if ($tree->isGrandChild($a_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
                    $query = "DELETE FROM ut_lp_collections" .
                        " WHERE obj_id = " . $ilDB->quote($rec["obj_id"], "integer") .
                        " AND " . $ilDB->in("item_id", $ref_ids, "", "integer");
                    $ilDB->manipulate($query);
                    
                    ilLPStatusWrapper::_refreshStatus($rec["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 450 of file class.ilObjectLP.php.

References updateParentCollections().

    {
        $this->updateParentCollections();
    }

Here is the call graph for this function:

isActive()

ilObjectLP::isActive

(

)

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

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

    {
        // :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 215 of file class.ilObjectLP.php.

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

isLPMember()

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

staticprotected

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

Parameters

array	$a_res
int	$a_usr_id
array	$a_obj_ids

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

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

isSupportedObjectType()

static ilObjectLP::isSupportedObjectType (   $type )

static

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

References $type, and $valid.

Referenced by ilCtrl\checkLPSettingsForward(), ilConditionHandler\enableAutomaticValidation(), ilSkillLevelResourcesTableGUI\fillRow(), ilLearnerProgressDB\getLearningProgressFor(), ilLPListOfSettingsGUI\getLPPathInfo(), ilCourseLPBadgeGUI\getLPTypes(), ilTimingsUser\getObjectsWithInactiveLP(), ilConditionHandler\getOperatorsByTriggerType(), ilObjUserTrackingGUI\initLPDefaultsForm(), ilCertificateObjectLPHelper\isSupportedObjectType(), and ilObjUserTrackingGUI\saveLPDefaultsObject().

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

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

        return false;
    }

Here is the caller graph for this function:

resetCaches()

ilObjectLP::resetCaches

(

)

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

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

resetCustomLPDataForUserIds()

ilObjectLP::resetCustomLPDataForUserIds ( array  $a_user_ids,   $a_recursive = true  )

protected

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

Referenced by resetLPDataForUserIds().

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

Here is the caller graph for this function:

resetLPDataForCompleteObject()

ilObjectLP::resetLPDataForCompleteObject (   $a_recursive = true )

final

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

References gatherLPUsers(), and resetLPDataForUserIds().

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

Here is the call graph for this function:

resetLPDataForUserIds()

ilObjectLP::resetLPDataForUserIds ( array  $a_user_ids,   $a_recursive = true  )

final

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

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

Referenced by resetLPDataForCompleteObject().

    {
        if ((bool) $a_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($a_user_ids, false);
                }
            }
        }
        
        $this->resetCustomLPDataForUserIds($a_user_ids, (bool) $a_recursive);
                        
        include_once "Services/Tracking/classes/class.ilLPMarks.php";
        ilLPMarks::_deleteForUsers($this->obj_id, $a_user_ids);

        include_once "Services/Tracking/classes/class.ilChangeEvent.php";
        ilChangeEvent::_deleteReadEventsForUsers($this->obj_id, $a_user_ids);
                
        // update LP status to get collections up-to-date
        include_once "Services/Tracking/classes/class.ilLPStatusWrapper.php";
        foreach ($a_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:

saveTypeDefaults()

static ilObjectLP::saveTypeDefaults ( array  $a_data )

static

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

References $DIC, $ilDB, $mode, and $type.

Referenced by ilObjUserTrackingGUI\saveLPDefaultsObject().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $ilDB->manipulate("DELETE FROM ut_lp_defaults");
        foreach ($a_data as $type => $mode) {
            $ilDB->insert("ut_lp_defaults", array(
                "type_id" => array("text", $type),
                "lp_mode" => array("integer", $mode)
            ));
        }
    }

Here is the caller graph for this function:

supportsMark()

static ilObjectLP::supportsMark (   $a_obj_type )

static

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

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

    {
        return !in_array($a_obj_type, array("lm", "dbk"));
    }

Here is the caller graph for this function:

supportsMatrixView()

static ilObjectLP::supportsMatrixView (   $a_obj_type )

static

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

Referenced by ilLearningProgressBaseGUI\__setSubTabs().

    {
        return !in_array($a_obj_type, array('svy', 'tst', 'htlm', 'exc', 'sess', 'file', 'prg', 'copa', 'cmix', 'lti','crsr'));
    }

Here is the caller graph for this function:

supportsSpentSeconds()

static ilObjectLP::supportsSpentSeconds (   $a_obj_type )

static

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

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

    {
        return !in_array($a_obj_type, array("exc", "file", "mcst", "mob", "htlm", "copa", 'cmix', 'lti'));
    }

Here is the caller graph for this function:

updateParentCollections()

ilObjectLP::updateParentCollections ( )

finalprotected

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

References $db, $ilDB, $query, ilObject\_lookupType(), and ilLPStatusWrapper\_refreshStatus().

Referenced by handleDelete(), and handleToTrash().

    {
        $ilDB = $this->db;
        
        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
        
        // update parent collections?
        $set = $ilDB->query("SELECT ut_lp_collections.obj_id obj_id FROM " .
                "object_reference JOIN ut_lp_collections ON " .
                "(object_reference.obj_id = " . $ilDB->quote($this->obj_id, "integer") .
                " AND object_reference.ref_id = ut_lp_collections.item_id)");
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (in_array(ilObject::_lookupType($rec["obj_id"]), array("crs", "grp", "fold"))) {
                // remove from parent collection
                $query = "DELETE FROM ut_lp_collections" .
                    " WHERE obj_id = " . $ilDB->quote($rec["obj_id"], "integer") .
                    " AND item_id = " . $ilDB->quote($this->obj_id, "integer");
                $ilDB->manipulate($query);
                
                ilLPStatusWrapper::_refreshStatus($rec["obj_id"]);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$collection_instance

ilObjectLP::$collection_instance

protected

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

Referenced by getCollectionInstance().

$db

ilObjectLP::$db

protected

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

Referenced by getTypeDefault(), and updateParentCollections().

$mode

ilObjectLP::$mode

protected

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

Referenced by getCurrentMode(), isActive(), and saveTypeDefaults().

$obj_id

ilObjectLP::$obj_id

protected

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

Referenced by findMembershipsByPath(), and getLPMemberships().

$tree

ilObjectLP::$tree

protected

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

Referenced by findMembershipsByPath(), getLPMemberships(), getMembers(), and handleMove().

$type_defaults

ilObjectLP::$type_defaults

staticprotected

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

---

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

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