Inheritance diagram for ilObjUserTracking:

Collaboration diagram for ilObjUserTracking:

Public Member Functions
	ilObjUserTracking ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	enableLearningProgress ($a_enable)
	enabledLearningProgress ()
	enableUserRelatedData ($a_enable)
	enable tracking of user related data
	enabledUserRelatedData ()
	enableObjectStatistics ($newValue)
	Sets the object statistics property.
	enabledObjectStatistics ()
	Gets the object statistic property.
	enableSessionStatistics ($newValue)
	Sets the session statistics property.
	enabledSessionStatistics ()
	Gets the session statistic property.
	setValidTimeSpan ($a_time_span)
	getValidTimeSpan ()
	enableChangeEventTracking ($newValue)
	Sets the changeEventTrackingEnabled property.
	enabledChangeEventTracking ()
	Gets the changeEventTrackingEnabled property.
	setExtendedData ($a_value)
	hasExtendedData ($a_code)
	updateSettings ()
	setLearningProgressLearner ($a_value)
	hasLearningProgressLearner ()
	setLearningProgressListGUI ($a_value)
	hasLearningProgressListGUI ()
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates.
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.
	_lookupCreationDate ($a_id)
	Lookup creation date.

Static Public Member Functions
static	_enabledLearningProgress ()
	check wether learing progress is enabled or not
static	_enabledUserRelatedData ()
	check wether user related tracking is enabled or not
static	_enabledObjectStatistics ()
	check wether object statistics is enabled or not
static	_enabledSessionStatistics ()
	check wether session statistics is enabled or not
static	_getValidTimeSpan ()
static	_deleteUser ($a_usr_id)
static	_hasLearningProgressOtherUsers ()
static	_hasLearningProgressLearner ()
static	_hasLearningProgressListGUI ()
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB.
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course.

Data Fields
	$valid_time
	$extended_data
	$learning_progress
	$tracking_user_related
	$object_statistics_enabled
	$lp_learner
	$session_statistics_enabled
	$lp_list_gui
const	EXTENDED_DATA_LAST_ACCESS = 1
const	EXTENDED_DATA_READ_COUNT = 2
const	EXTENDED_DATA_SPENT_SECONDS = 4
const	DEFAULT_TIME_SPAN = 300
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title
const	DESC_LENGTH = 128
	$ilias
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
	$obj_data_record
	object_data record

Protected Member Functions
	__readSettings ()

Private Attributes
	$is_change_event_tracking_enabled
	This variable holds the enabled state of the change event tracking.

Detailed Description

Definition at line 18 of file class.ilObjUserTracking.php.

Member Function Documentation

ilObjUserTracking::__readSettings ( )

protected

Definition at line 242 of file class.ilObjUserTracking.php.

References $ilSetting, ilChangeEvent\_isActive(), enableChangeEventTracking(), enableLearningProgress(), enableObjectStatistics(), enableSessionStatistics(), enableUserRelatedData(), setExtendedData(), setLearningProgressLearner(), setLearningProgressListGUI(), and setValidTimeSpan().

Referenced by ilObjUserTracking().

        {
                global $ilSetting;
                $this->enableLearningProgress($ilSetting->get("enable_tracking",0));
                $this->enableUserRelatedData($ilSetting->get("save_user_related_data",0));
                $this->enableObjectStatistics($ilSetting->get("object_statistics",0));
                $this->setValidTimeSpan($ilSetting->get("tracking_time_span", self::DEFAULT_TIME_SPAN));
                // $this->setLearningProgressDesktop($ilSetting->get("lp_desktop", 1));
                $this->setLearningProgressLearner($ilSetting->get("lp_learner", 1));
                $this->enableSessionStatistics($ilSetting->get("session_statistics", 1)); 
                $this->setLearningProgressListGUI($ilSetting->get("lp_list_gui", 0));
                // BEGIN ChangeEvent
                require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
                $this->enableChangeEventTracking(ilChangeEvent::_isActive());
                // END ChangeEvent
                
                $this->setExtendedData($ilSetting->get("lp_extended_data"),0);
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilObjUserTracking::_deleteUser ( $a_usr_id )

static

Definition at line 265 of file class.ilObjUserTracking.php.

References $ilDB, $query, and $res.

Referenced by ilObjUser\delete().

        {
                global $ilDB;
                $query = sprintf('DELETE FROM read_event WHERE usr_id = %s ',
                        $ilDB->quote($a_usr_id,'integer'));
                $aff = $ilDB->manipulate($query);                       
                $query = sprintf('DELETE FROM write_event WHERE usr_id = %s ',
                        $ilDB->quote($a_usr_id,'integer'));
                $aff = $ilDB->manipulate($query);
                $query = "DELETE FROM ut_lp_marks WHERE usr_id = ".$ilDB->quote($a_usr_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
                $ilDB->manipulate("DELETE FROM ut_online WHERE usr_id = ".
                        $ilDB->quote($a_usr_id, "integer"));
                return true;
        }

Here is the caller graph for this function:

static ilObjUserTracking::_enabledLearningProgress ( )

static

check wether learing progress is enabled or not

Definition at line 69 of file class.ilObjUserTracking.php.

References $ilSetting.

Referenced by ilCourseParticipantsTableGUI\__construct(), ilLearningProgressGUI\__getNextClass(), ilObjSAHSLearningModuleAccess\_lookupUserCertificate(), ilLearningProgressAccess\checkAccess(), ilObjCourse\checkLPStatusSync(), ilOrgUnitStaffTableGUI\fillRow(), ilPortfolioPageGUI\getCoursesOfUser(), ilSCORMVerificationTableGUI\getItems(), ilUserLPTableGUI\getItems(), ilConditionHandler\getOperatorsByTargetType(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilObjUserTrackingGUI\getTabs(), ilObjUserGUI\getTabs(), ilCourseAppEventListener\handleEvent(), ilObjGroupGUI\initAttendanceList(), ilObjCourseGUI\initAttendanceList(), ilObjCourseGUI\initEditForm(), ilObjUserFolderGUI\learningProgressObject(), ilObjGroupGUI\membersObject(), ilObjCourseGUI\membersObject(), ilLPStatus\preloadListGUIData(), ilMainMenuGUI\renderDropDown(), ilMainMenuGUI\renderEntry(), ilObjSCORMLearningModule\setLearningProgressSettingsAtUpload(), ilObjCourse\setStatusDetermination(), ilInfoScreenGUI\showLearningProgress(), and ilObjCourseGUI\updateLPFromStatus().

        {
                global $ilSetting;
                return (bool)$ilSetting->get("enable_tracking", 0);
        }

Here is the caller graph for this function:

static ilObjUserTracking::_enabledObjectStatistics ( )

static

check wether object statistics is enabled or not

Definition at line 102 of file class.ilObjUserTracking.php.

References $ilSetting.

Referenced by ilChangeEvent\_recordObjStats(), and ilObjUserTrackingGUI\getTabs().

        {
                global $ilSetting;
                
                return (bool)$ilSetting->get('object_statistics', 0);
        }

Here is the caller graph for this function:

static ilObjUserTracking::_enabledSessionStatistics ( )

static

check wether session statistics is enabled or not

Definition at line 152 of file class.ilObjUserTracking.php.

References $ilSetting.

Referenced by ilObjUserTrackingGUI\getTabs().

        {
                global $ilSetting;
                
                return (bool)$ilSetting->get('session_statistics', 1);
        }

Here is the caller graph for this function:

static ilObjUserTracking::_enabledUserRelatedData ( )

static

check wether user related tracking is enabled or not

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

References $ilSetting.

Referenced by ilLPTableBaseGUI\__construct(), ilLearningProgressGUI\__getNextClass(), ilLearningProgressBaseGUI\__setSubTabs(), ilOrgUnitStaffTableGUI\fillRow(), ilPortfolioPageGUI\getCoursesOfUser(), ilObjUserGUI\getTabs(), ilLearningProgressBaseGUI\ilLearningProgressBaseGUI(), ilObjGroupGUI\initAttendanceList(), ilObjCourseGUI\initAttendanceList(), ilObjUserFolderGUI\learningProgressObject(), ilObjGroupGUI\membersObject(), and ilObjCourseGUI\membersObject().

        {
                global $ilSetting;
                
                return (bool)$ilSetting->get('save_user_related_data');
        }

Here is the caller graph for this function:

static ilObjUserTracking::_getValidTimeSpan ( )

static

Definition at line 169 of file class.ilObjUserTracking.php.

References $ilSetting.

Referenced by ilLPObjSettings\_mode2InfoText(), ilChangeEvent\_recordReadEvent(), ilLPListOfSettingsGUI\initFormSettings(), and ilLMTracker\trackPageAndChapterAccess().

        {
                global $ilSetting;
                
                return (int)$ilSetting->get("tracking_time_span", self::DEFAULT_TIME_SPAN);
        }

Here is the caller graph for this function:

static ilObjUserTracking::_hasLearningProgressLearner ( )

static

Definition at line 325 of file class.ilObjUserTracking.php.

References ilObject\$ilias.

Referenced by ilLearningProgressGUI\__getNextClass(), ilLearningProgressBaseGUI\__setSubTabs(), ilLearningProgressAccess\checkAccess(), ilPortfolioPageGUI\getCoursesOfUser(), ilLPStatus\preloadListGUIData(), and ilMainMenuGUI\renderEntry().

        {
                global $ilias;
                
                return (bool)$ilias->getSetting("lp_learner", 1);
        }

Here is the caller graph for this function:

static ilObjUserTracking::_hasLearningProgressListGUI ( )

static

Definition at line 342 of file class.ilObjUserTracking.php.

References ilObject\$ilias.

Referenced by ilLPStatus\preloadListGUIData().

        {
                global $ilias;
                
                return (bool)$ilias->getSetting("lp_list_gui", 0);
        }

Here is the caller graph for this function:

static ilObjUserTracking::_hasLearningProgressOtherUsers ( )

static

Definition at line 305 of file class.ilObjUserTracking.php.

References ilObject\$ref_id, ilObject\_getAllReferences(), and ilObject\_getObjectsByType().

Referenced by ilLearningProgressGUI\__getNextClass(), ilLearningProgressBaseGUI\__setSubTabs(), and ilMainMenuGUI\renderEntry().

        {               
                global $rbacsystem;
                
                $obj_id = array_pop(array_keys(ilObject::_getObjectsByType("trac")));   
                $ref_id = array_pop(ilObject::_getAllReferences($obj_id));
                
                return $rbacsystem->checkAccess("lp_other_users", $ref_id);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjUserTracking::enableChangeEventTracking ( $newValue )

Sets the changeEventTrackingEnabled property.

Parameters

boolean new value

Returns: void

Definition at line 183 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->is_change_event_tracking_enabled = (bool)$newValue;
        }

Here is the caller graph for this function:

ilObjUserTracking::enabledChangeEventTracking ( )

Gets the changeEventTrackingEnabled property.

Returns: boolean value

Definition at line 192 of file class.ilObjUserTracking.php.

References $is_change_event_tracking_enabled.

        {
                return (bool)$this->is_change_event_tracking_enabled;
        }

ilObjUserTracking::enabledLearningProgress ( )

Definition at line 61 of file class.ilObjUserTracking.php.

References $learning_progress.

Referenced by updateSettings().

        {
                return $this->learning_progress;
        }

Here is the caller graph for this function:

ilObjUserTracking::enabledObjectStatistics ( )

Gets the object statistic property.

Returns: boolean value

Definition at line 124 of file class.ilObjUserTracking.php.

References $object_statistics_enabled.

Referenced by updateSettings().

        {
                return (bool)$this->object_statistics_enabled;
        }

Here is the caller graph for this function:

ilObjUserTracking::enabledSessionStatistics ( )

Gets the session statistic property.

Returns: boolean value

Definition at line 144 of file class.ilObjUserTracking.php.

References $session_statistics_enabled.

Referenced by updateSettings().

        {
                return (bool)$this->session_statistics_enabled;
        }

Here is the caller graph for this function:

ilObjUserTracking::enabledUserRelatedData ( )

Definition at line 84 of file class.ilObjUserTracking.php.

References $tracking_user_related.

Referenced by updateSettings().

        {
                return (bool)$this->tracking_user_related;
        }

Here is the caller graph for this function:

ilObjUserTracking::enableLearningProgress ( $a_enable )

Definition at line 56 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->learning_progress = (bool)$a_enable;
        }

Here is the caller graph for this function:

ilObjUserTracking::enableObjectStatistics ( $newValue )

Sets the object statistics property.

Parameters

boolean new value

Returns: void

Definition at line 115 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->object_statistics_enabled = (bool)$newValue;
        }

Here is the caller graph for this function:

ilObjUserTracking::enableSessionStatistics ( $newValue )

Sets the session statistics property.

Parameters

boolean new value

Returns: void

Definition at line 135 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->session_statistics_enabled = (bool)$newValue;
        }

Here is the caller graph for this function:

ilObjUserTracking::enableUserRelatedData ( $a_enable )

enable tracking of user related data

Definition at line 79 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->tracking_user_related = (bool)$a_enable;
        }

Here is the caller graph for this function:

ilObjUserTracking::getValidTimeSpan ( )

Definition at line 164 of file class.ilObjUserTracking.php.

References $valid_time.

Referenced by updateSettings().

        {
                return (int)$this->valid_time;
        } 

Here is the caller graph for this function:

ilObjUserTracking::hasExtendedData ( $a_code )

Definition at line 203 of file class.ilObjUserTracking.php.

        {
                return $this->extended_data & $a_code;
        }

ilObjUserTracking::hasLearningProgressLearner ( )

Definition at line 320 of file class.ilObjUserTracking.php.

References $lp_learner.

Referenced by updateSettings().

        {
                return (bool)$this->lp_learner;
        }

Here is the caller graph for this function:

ilObjUserTracking::hasLearningProgressListGUI ( )

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

References $lp_list_gui.

Referenced by updateSettings().

        {
                return (bool)$this->lp_list_gui;
        }

Here is the caller graph for this function:

ilObjUserTracking::ilObjUserTracking	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Definition at line 48 of file class.ilObjUserTracking.php.

References __readSettings(), and ilObject\ilObject().

        {
                $this->type = "trac";
                $this->ilObject($a_id,$a_call_by_reference);
                $this->__readSettings();
        }

Here is the call graph for this function:

ilObjUserTracking::setExtendedData ( $a_value )

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

Referenced by __readSettings().

        {
                $this->extended_data = $a_value;
        }

Here is the caller graph for this function:

ilObjUserTracking::setLearningProgressLearner ( $a_value )

Definition at line 315 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->lp_learner = (bool)$a_value;
        }

Here is the caller graph for this function:

ilObjUserTracking::setLearningProgressListGUI ( $a_value )

Definition at line 332 of file class.ilObjUserTracking.php.

Referenced by __readSettings().

        {
                $this->lp_list_gui = (bool)$a_value;
        }

Here is the caller graph for this function:

ilObjUserTracking::setValidTimeSpan ( $a_time_span )

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

Referenced by __readSettings().

        {
                $this->valid_time = (int)$a_time_span;
        }

Here is the caller graph for this function:

ilObjUserTracking::updateSettings ( )

Definition at line 208 of file class.ilObjUserTracking.php.

References $ilSetting, enabledLearningProgress(), enabledObjectStatistics(), enabledSessionStatistics(), enabledUserRelatedData(), getValidTimeSpan(), hasLearningProgressLearner(), and hasLearningProgressListGUI().

        {
                global $ilSetting;
                $ilSetting->set("enable_tracking", (int)$this->enabledLearningProgress());
                $ilSetting->set("save_user_related_data", (int)$this->enabledUserRelatedData());
                $ilSetting->set("tracking_time_span",$this->getValidTimeSpan());
                $ilSetting->set("lp_extended_data", $this->extended_data);
                $ilSetting->set("object_statistics", (int)$this->enabledObjectStatistics());            
                // $ilSetting->set("lp_desktop", (int)$this->hasLearningProgressDesktop());             
                $ilSetting->set("lp_learner", (int)$this->hasLearningProgressLearner());
                $ilSetting->set("session_statistics", (int)$this->enabledSessionStatistics());
                $ilSetting->set("lp_list_gui", (int)$this->hasLearningProgressListGUI());
                /* => REPOSITORY
                // BEGIN ChangeEvent
                require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
                if ($this->enabledChangeEventTracking() != ilChangeEvent::_isActive())
                {
                        if ($this->enabledChangeEventTracking())
                        {
                                ilChangeEvent::_activate();
                        }
                        else
                        {
                                ilChangeEvent::_deactivate();
                        }
                }
                // END ChangeEvent
                */
                
                return true;
        }