Inheritance diagram for ilObjUserTrackingGUI:

Collaboration diagram for ilObjUserTrackingGUI:

Public Member Functions
	ilObjUserTrackingGUI ($a_data, $a_id, $a_call_by_reference)

&	executeCommand ()
	execute command More...

	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder More...

	getTabs (&$tabs_gui)
	get tabs abstract method. More...

	settingsObject ($a_form=null)
	display tracking settings form More...

	saveSettingsObject ()
	save user tracking settings More...

Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor @access public. More...

&	executeCommand ()
	execute command More...

	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ($in_rep=false)
	cancel action and go back to previous page @access public More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()
	save object More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

	viewObject ()
	list childs of current object More...

	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Data Fields
	$tpl = null

	$ilErr = null

	$lng = null

	$ctrl = null

Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1

	$ilias

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	initSettingsForm ()

Protected Member Functions inherited from ilObjectGUI
	assignObject ()

	prepareOutput ()
	prepare output More...

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	showMountWebfolderIcon ()

	setTabs ()
	set admin tabs @access public More...

	setAdminTabs ()
	set admin tabs @access public More...

	setLocator ()
	set Locator More...

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator ($a_omit=true)

	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...

	initEditForm ()
	Init object edit form. More...

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()
	Get values for edit form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste More...

	getTabs (&$tabs_gui)
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings ($column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Protected Attributes inherited from ilObjectGUI
	$tmp_import_dir

Detailed Description

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

Member Function Documentation

◆ executeCommand()

& ilObjUserTrackingGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 41 of file class.ilObjUserTrackingGUI.php.

        {
                $next_class = $this->ctrl->getNextClass();
                $this->ctrl->setReturn($this, "show");
                $this->prepareOutput();
 
                switch($next_class)
                {
                        case 'ilpermissiongui':
                                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                $perm_gui =& new ilPermissionGUI($this);
                                $ret =& $this->ctrl->forwardCommand($perm_gui);
                                break;
 
                        case 'illearningprogressgui':
                                $this->tabs_gui->setTabActive('learning_progress');
                                include_once("./Services/Tracking/classes/class.ilLearningProgressGUI.php");
                                $lp_gui =& new ilLearningProgressGUI(ilLearningProgressGUI::LP_CONTEXT_ADMINISTRATION);
                                $ret =& $this->ctrl->forwardCommand($lp_gui);
                                break;
                        
                        case 'illpobjectstatisticsgui':
                                $this->tabs_gui->setTabActive('statistics');
                                include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsGUI.php");
                                $os_gui =& new ilLPObjectStatisticsGUI(ilLPObjectStatisticsGUI::LP_CONTEXT_ADMINISTRATION);
                                $ret =& $this->ctrl->forwardCommand($os_gui);
                                break;
                        
                        case 'ilsessionstatisticsgui':
                                $this->tabs_gui->setTabActive('session_statistics');
                                include_once("./Services/Authentication/classes/class.ilSessionStatisticsGUI.php");
                                $sess_gui =& new ilSessionStatisticsGUI();
                                $ret =& $this->ctrl->forwardCommand($sess_gui);
                                break;
                                
                        default:
                                $cmd = $this->ctrl->getCmd();
                                if ($cmd == "view" || $cmd == "")
                                {                                       
                                        $cmd = "settings";
                                }
                                $cmd .= "Object";
                                $this->$cmd();
                                break;
                }
                
                return true;
        }

References $cmd, $ret, ilLearningProgressBaseGUI\LP_CONTEXT_ADMINISTRATION, and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjUserTrackingGUI::getAdminTabs ( & $tabs_gui )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 90 of file class.ilObjUserTrackingGUI.php.

        {
                $this->getTabs($tabs_gui);
        }

References getTabs().

Here is the call graph for this function:

◆ getTabs()

ilObjUserTrackingGUI::getTabs ( & $tabs_gui )

get tabs abstract method.

@abstract overwrite in derived GUI class of your object type @access public

Parameters

object instance of ilTabsGUI

Reimplemented from ilObjectGUI.

Definition at line 95 of file class.ilObjUserTrackingGUI.php.

        {
                global $rbacsystem;
 
                $this->ctrl->setParameter($this,"ref_id",$this->ref_id);
                
                $tabs_gui->addTarget("settings",
                        $this->ctrl->getLinkTarget($this, "settings"),
                        "settings",
                        get_class($this));                                      
 
                if ($rbacsystem->checkAccess("read",$this->object->getRefId()))
                {                                               
                        if (ilObjUserTracking::_enabledObjectStatistics())
                        {
                                $tabs_gui->addTarget("statistics",
                                        $this->ctrl->getLinkTargetByClass("illpobjectstatisticsgui",
                                                                                                        "access"),
                                        "",
                                        "illpobjectstatisticsgui");
                        }
 
                        if (ilObjUserTracking::_enabledLearningProgress())
                        {
                                $tabs_gui->addTarget("learning_progress",
                                        $this->ctrl->getLinkTargetByClass("illearningprogressgui",
                                                                                                        "show"),
                                        "",
                                        "illearningprogressgui");
                        }
                        
                        // session statistics
                        if (ilObjUserTracking::_enabledSessionStatistics())
                        {
                                $tabs_gui->addTarget("session_statistics",
                                        $this->ctrl->getLinkTargetByClass("ilsessionstatisticsgui",
                                                                                                        ""),
                                        "",
                                        "ilsessionstatisticsgui");                      
                        }
                }
                
                if ($rbacsystem->checkAccess("edit_permission",$this->object->getRefId()))
                {               
                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), 
                                array("perm","info","owner"),
                                'ilpermissiongui');
                }
        }

References ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledObjectStatistics(), and ilObjUserTracking\_enabledSessionStatistics().

Referenced by getAdminTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ilObjUserTrackingGUI()

ilObjUserTrackingGUI::ilObjUserTrackingGUI	(	$a_data,
		$a_id,
		$a_call_by_reference
	)

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

        {
                global $tpl,$ilErr,$lng,$ilCtrl;
 
                $this->type = "trac";
                $this->ilObjectGUI($a_data,$a_id,$a_call_by_reference, false);
 
                $this->tpl =& $tpl;
                $this->ilErr =& $ilErr;
                $this->lng =& $lng;
                $this->lng->loadLanguageModule('trac');
 
                $this->ctrl =& $ilCtrl;
        }

References $ilCtrl, $ilErr, $lng, $tpl, and ilObjectGUI\ilObjectGUI().

Here is the call graph for this function:

◆ initSettingsForm()

ilObjUserTrackingGUI::initSettingsForm ( )

protected

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

        {
                global $rbacsystem;
                
                include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->lng->txt('tracking_settings'));
 
                $activate = new ilCheckboxGroupInputGUI($this->lng->txt('activate_tracking'));
                $form->addItem($activate);
                
                // learning progress
                $lp = new ilCheckboxInputGUI($this->lng->txt('trac_learning_progress'), 'learning_progress_tracking');
                if($this->object->enabledLearningProgress())
                {
                        $lp->setChecked(true);
                }
                $activate->addSubItem($lp);
                
                
                // lp settings
 
                /*
                $desktop = new ilCheckboxInputGUI($this->lng->txt('trac_lp_on_personal_desktop'), 'lp_desktop');
                $desktop->setInfo($this->lng->txt('trac_lp_on_personal_desktop_info'));
                $desktop->setChecked($this->object->hasLearningProgressDesktop());
                $lp->addSubItem($desktop);
                */ 
                
                $learner = new ilCheckboxInputGUI($this->lng->txt('trac_lp_learner_access'), 'lp_learner');
                $learner->setInfo($this->lng->txt('trac_lp_learner_access_info'));
                $learner->setChecked($this->object->hasLearningProgressLearner());
                $lp->addSubItem($learner);
                
                
                // extended data
 
                $extdata = new ilCheckboxGroupInputGUI($this->lng->txt('trac_learning_progress_settings_info'), 'lp_extdata');
                $extdata->addOption(new ilCheckboxOption($this->lng->txt('trac_first_and_last_access'), 'lp_access'));          
                $extdata->addOption(new ilCheckboxOption($this->lng->txt('trac_read_count'), 'lp_count'));              
                $extdata->addOption(new ilCheckboxOption($this->lng->txt('trac_spent_seconds'), 'lp_spent'));
                $lp->addSubItem($extdata);
                
                $ext_value = array();
                if($this->object->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS))
                {
                        $ext_value[] = 'lp_access';
                }
                if($this->object->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT))
                {
                        $ext_value[] = 'lp_count';
                }
                if($this->object->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS))
                {
                        $ext_value[] = 'lp_spent';
                }
                $extdata->setValue($ext_value);
                
                $listgui = new ilCheckboxInputGUI($this->lng->txt('trac_lp_list_gui'), 'lp_list');
                $listgui->setInfo($this->lng->txt('trac_lp_list_gui_info'));
                $listgui->setChecked($this->object->hasLearningProgressListGUI());
                $lp->addSubItem($listgui);
                
                /* => REPOSITORY
                // change event
                $event = new ilCheckboxInputGUI($this->lng->txt('trac_repository_changes'), 'change_event_tracking');
                if($this->object->enabledChangeEventTracking())
                {
                        $event->setChecked(true);
                }
                $activate->addSubItem($event);
                */
                
                // object statistics
                $objstat = new ilCheckboxInputGUI($this->lng->txt('trac_object_statistics'), 'object_statistics');
                if($this->object->enabledObjectStatistics())
                {
                        $objstat->setChecked(true);
                }
                $activate->addSubItem($objstat);
                
                // session statistics
                $sessstat = new ilCheckboxInputGUI($this->lng->txt('session_statistics'), 'session_statistics');
                if($this->object->enabledSessionStatistics())
                {
                        $sessstat->setChecked(true);
                }
                $activate->addSubItem($sessstat);               
                        
                // Anonymized
                $user = new ilCheckboxInputGUI($this->lng->txt('trac_anonymized'), 'user_related');
                $user->setInfo($this->lng->txt('trac_anonymized_info'));
                $user->setChecked(!$this->object->enabledUserRelatedData());
                $form->addItem($user);
 
                // Max time gap
                $valid = new ilNumberInputGUI($this->lng->txt('trac_valid_request'), 'valid_request');
                $valid->setMaxLength(4);
                $valid->setSize(4);
                $valid->setSuffix($this->lng->txt('seconds'));
                $valid->setInfo($this->lng->txt('info_valid_request'));
                $valid->setValue($this->object->getValidTimeSpan());
                $valid->setMinValue(1);
                $valid->setMaxValue(9999);
                $valid->setRequired(true);
                $form->addItem($valid);
                
                include_once "Services/Administration/classes/class.ilAdministrationSettingsFormHandler.php";
                ilAdministrationSettingsFormHandler::addFieldsToForm(
                        ilAdministrationSettingsFormHandler::FORM_LP, 
                        $form,
                        $this
                );
                
                // #12259
                if ($rbacsystem->checkAccess("write",$this->object->getRefId()))
                {       
                        $form->addCommandButton('saveSettings', $this->lng->txt('save'));
                }
                else
                {
                        $lp->setDisabled(true);
                        $learner->setDisabled(true);
                        $extdata->setDisabled(true);
                        $listgui->setDisabled(true);
                        $objstat->setDisabled(true);
                        $user->setDisabled(true);
                        $valid->setDisabled(true);
                }
                                
                return $form;
        }

References $valid, ilAdministrationSettingsFormHandler\addFieldsToForm(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, and ilAdministrationSettingsFormHandler\FORM_LP.

Referenced by saveSettingsObject(), and settingsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettingsObject()

ilObjUserTrackingGUI::saveSettingsObject ( )

save user tracking settings

Definition at line 306 of file class.ilObjUserTrackingGUI.php.

        {
                global $rbacsystem;
                
                if (!$rbacsystem->checkAccess("write",$this->object->getRefId()))
                {       
                        return;
                }
                
                $form = $this->initSettingsForm();
                if($form->checkInput())
                {               
                        $lp_active = $form->getInput('learning_progress_tracking');
                        
                        $this->object->enableLearningProgress($lp_active);                                              
                        
                        if($lp_active)
                        {
                                $ext_data = (array)$form->getInput("lp_extdata");
                                $code = 0;
                                if(in_array('lp_access', $ext_data))
                                {
                                        $code += ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS;
                                }
                                if(in_array('lp_count', $ext_data))
                                {
                                        $code += ilObjUserTracking::EXTENDED_DATA_READ_COUNT;
                                }
                                if(in_array('lp_spent', $ext_data))
                                {
                                        $code += ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS;
                                }
                                $this->object->setExtendedData($code);
                        }
 
                        $this->object->enableChangeEventTracking($form->getInput('change_event_tracking'));                     
                        $this->object->enableObjectStatistics($form->getInput('object_statistics'));
                        $this->object->enableUserRelatedData(!$form->getInput('user_related'));
                        $this->object->setValidTimeSpan($form->getInput('valid_request'));                                              
                        // $this->object->setLearningProgressDesktop($form->getInput('lp_desktop'));
                        $this->object->setLearningProgressLearner($form->getInput('lp_learner'));
                        $this->object->enableSessionStatistics($form->getInput('session_statistics'));
                        $this->object->setLearningProgressListGUI($form->getInput('lp_list'));                                                  
                        $this->object->updateSettings();
                        
                        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
                        $this->ctrl->redirect($this, "settings");
                }
        
                $form->setValuesByPost();
                $this->settingsObject($form);
                return false;
        }

References $code, ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, initSettingsForm(), ilUtil\sendSuccess(), and settingsObject().

Here is the call graph for this function:

◆ settingsObject()

ilObjUserTrackingGUI::settingsObject ( $a_form = null )

display tracking settings form

Definition at line 150 of file class.ilObjUserTrackingGUI.php.

        {
                global $rbacsystem;
 
                if (!$rbacsystem->checkAccess('read',$this->object->getRefId()))
                {
                        $ilErr->raiseError($this->lng->txt("msg_no_perm_read_track"),$ilErr->WARNING);
                }
 
                $this->tabs_gui->setTabActive('settings');
 
                if(!$a_form)
                {
                        $a_form = $this->initSettingsForm();
                }
 
                $this->tpl->setContent($a_form->getHTML());
        }