ilLPObjSettings Class Reference

Collaboration diagram for ilLPObjSettings:

Public Member Functions
	ilLPObjSettings ($a_obj_id)
	cloneSettings ($a_new_obj_id)
	Clone settings.
	getVisits ()
	setVisits ($a_visits)
	setMode ($a_mode)
	getMode ()
	getObjId ()
	getObjType ()
	update ()
	insert ()
	_lookupVisits ($a_obj_id)
	_isContainer ($a_mode)
	_delete ($a_obj_id)
	_lookupMode ($a_obj_id)
	getValidModes ()
	_mode2Text ($a_mode)
	_checkObjectives ($a_obj_id)
	_checkSCORMPreconditions ($a_obj_id)
	__read ()
	__getDefaultMode ($a_obj_id, $a_type)

Static Public Member Functions
static	_mode2InfoText ($a_mode)
	get mode info text

Data Fields
	$db = null
	$obj_id = null
	$obj_type = null
	$obj_mode = null
	$visits = null
	$is_stored = false

Detailed Description

Definition at line 52 of file class.ilLPObjSettings.php.

Member Function Documentation

ilLPObjSettings::__getDefaultMode	(		$a_obj_id,
			$a_type
	)

Definition at line 489 of file class.ilLPObjSettings.php.

References $ilDB, _checkObjectives(), LP_MODE_DEACTIVATED, LP_MODE_EVENT, LP_MODE_EXERCISE_RETURNED, LP_MODE_MANUAL, LP_MODE_MANUAL_BY_TUTOR, LP_MODE_OBJECTIVES, and LP_MODE_TEST_PASSED.

Referenced by _lookupMode(), and ilLPObjSettings().

        {
                global $ilDB;

                #$type = strlen($a_type) ? $a_type : $this->obj_type;

                switch($a_type)
                {
                        case 'crs':
                                // If objectives are enabled return deactivated
                                if(ilLPObjSettings::_checkObjectives($a_obj_id))
                                {
                                        return LP_MODE_OBJECTIVES;
                                }
                                return LP_MODE_MANUAL_BY_TUTOR;

                        case 'dbk':
                        case 'lm':
                        case 'htlm':
                                return LP_MODE_MANUAL;

                        case 'sahs':
                                return LP_MODE_DEACTIVATED;

                        case 'dbk':
                                return LP_MODE_MANUAL;

                        case 'tst':
                                return LP_MODE_TEST_PASSED;

                        case 'exc':
                                return LP_MODE_EXERCISE_RETURNED;

                        case 'grp':
                                return LP_MODE_DEACTIVATED;

                        case 'fold':
                                return LP_MODE_DEACTIVATED;
                                
                        case 'sess':
                                return LP_MODE_EVENT;
                                        
                        default:
                                return LP_MODE_UNDEFINED;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPObjSettings::__read

(

)

Definition at line 463 of file class.ilLPObjSettings.php.

References $res, $row, _checkObjectives(), _checkSCORMPreconditions(), DB_FETCHMODE_OBJECT, LP_MODE_OBJECTIVES, and LP_MODE_SCORM.

Referenced by ilLPObjSettings(), insert(), and update().

        {
                $res = $this->db->query("SELECT * FROM ut_lp_settings WHERE obj_id = ".
                        $this->db->quote($this->obj_id ,'integer'));
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->is_stored = true;
                        $this->obj_type = $row->obj_type;
                        $this->obj_mode = $row->u_mode;
                        $this->visits = $row->visits;

                        if(ilLPObjSettings::_checkObjectives($this->obj_id))
                        {
                                $this->obj_mode = LP_MODE_OBJECTIVES;
                        }
                        if(ilLPObjSettings::_checkSCORMPreconditions($this->obj_id))
                        {
                                $this->obj_mode = LP_MODE_SCORM;
                        }

                        return true;
                }

                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPObjSettings::_checkObjectives

(

$a_obj_id

)

Definition at line 428 of file class.ilLPObjSettings.php.

References $ilDB, ilObjCourse\_lookupViewMode(), and IL_CRS_VIEW_OBJECTIVE.

Referenced by __getDefaultMode(), __read(), _lookupMode(), and getValidModes().

        {
                global $ilDB,$ilObjDataCache;

                // Return deactivate for course with objective view
                if($ilObjDataCache->lookupType($a_obj_id) == 'crs')
                {
                        include_once 'Modules/Course/classes/class.ilObjCourse.php';

                        if(ilObjCourse::_lookupViewMode($a_obj_id) == IL_CRS_VIEW_OBJECTIVE)
                        {
                                return true;
                        }
                }
                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPObjSettings::_checkSCORMPreconditions

(

$a_obj_id

)

Definition at line 445 of file class.ilLPObjSettings.php.

References ilConditionHandler\_getConditionsOfTrigger().

Referenced by __read(), _lookupMode(), and getValidModes().

        {
                global $ilObjDataCache;
                
                if($ilObjDataCache->lookupType($a_obj_id) != 'sahs')
                {
                        return false;
                }
                include_once('classes/class.ilConditionHandler.php');
                if(count($conditions = ilConditionHandler::_getConditionsOfTrigger('sahs',$a_obj_id)))
                {
                        return true;
                }
                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPObjSettings::_delete

(

$a_obj_id

)

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

References $ilDB, $query, and $res.

Referenced by ilTrackingTest\testLPObjectSettings().

        {
                global $ilDB;

                $query = "DELETE FROM ut_lp_settings WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer');
                $res = $ilDB->manipulate($query);

                return true;
        }

Here is the caller graph for this function:

ilLPObjSettings::_isContainer

(

$a_mode

)

Definition at line 179 of file class.ilLPObjSettings.php.

References LP_MODE_COLLECTION, LP_MODE_MANUAL_BY_TUTOR, LP_MODE_OBJECTIVES, and LP_MODE_SCORM.

Referenced by ilPDFPresentation\__createObjectDetails(), ilLPListOfObjectsGUI\__renderContainerRow(), ilLPListOfProgressGUI\__renderContainerRow(), and ilLPListOfProgressGUI\details().

        {
                return $a_mode == LP_MODE_COLLECTION or
                        $a_mode == LP_MODE_SCORM or
                        $a_mode == LP_MODE_OBJECTIVES or
                        $a_mode == LP_MODE_MANUAL_BY_TUTOR;
        }

Here is the caller graph for this function:

ilLPObjSettings::_lookupMode

(

$a_obj_id

)

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

References $ilDB, $query, $res, $row, __getDefaultMode(), _checkObjectives(), _checkSCORMPreconditions(), DB_FETCHMODE_OBJECT, LP_MODE_OBJECTIVES, and LP_MODE_SCORM.

Referenced by ilPDFPresentation\__createObjectDetails(), ilLPFilter\__getAllObjects(), ilLPListOfProgressGUI\__initDetails(), ilLPListOfObjectsGUI\__initDetails(), ilLearningProgressBaseGUI\__readItemStatusInfo(), ilLPItemListGUI\__readMode(), ilLPListOfSettingsGUI\__showCollectionTable(), ilLPListOfObjectsGUI\__showEditUser(), ilLearningProgressBaseGUI\__showObjectDetails(), ilLPStatusFactory\_getClassById(), ilLPStatusFactory\_getInstance(), ilLPCollections\_getItems(), ilCourseItems\_hasCollectionTimings(), ilLearningProgressAccess\checkAccess(), ilObjGroupGUI\membersObject(), ilObjCourseGUI\membersObject(), ilObjCourseGUI\printMembersObject(), ilLPFilter\searchFilterListener(), and ilInfoScreenGUI\showLearningProgress().

        {
                global $ilDB,$ilObjDataCache;

                if(ilLPObjSettings::_checkObjectives($a_obj_id))
                {
                        return LP_MODE_OBJECTIVES;
                }
                if(ilLPObjSettings::_checkSCORMPreconditions($a_obj_id))
                {
                        return LP_MODE_SCORM;
                }

                $query = "SELECT u_mode FROM ut_lp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer');

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->u_mode;
                }
                
                // no db entry exists => return default mode by type
                return ilLPObjSettings::__getDefaultMode($a_obj_id,$ilObjDataCache->lookupType($a_obj_id));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPObjSettings::_lookupVisits

(

$a_obj_id

)

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and LP_DEFAULT_VISITS.

Referenced by ilLearningProgressBaseGUI\__readItemStatusInfo(), ilLearningProgressBaseGUI\__showObjectDetails(), and ilLPStatusVisits\_getStatusInfo().

        {
                global $ilDB;

                $query = "SELECT visits FROM ut_lp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer');

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->visits;
                }
                return LP_DEFAULT_VISITS;
        }

Here is the caller graph for this function:

static ilLPObjSettings::_mode2InfoText (   $a_mode )

static

get mode info text

public

Parameters

int

$mode

Definition at line 376 of file class.ilLPObjSettings.php.

References $lng, LP_MODE_COLLECTION, LP_MODE_DEACTIVATED, LP_MODE_EVENT, LP_MODE_EXERCISE_RETURNED, LP_MODE_MANUAL, LP_MODE_MANUAL_BY_TUTOR, LP_MODE_OBJECTIVES, LP_MODE_SCORM, LP_MODE_SCORM_PACKAGE, LP_MODE_TEST_FINISHED, LP_MODE_TEST_PASSED, LP_MODE_TLT, and LP_MODE_VISITS.

Referenced by ilLPListOfSettingsGUI\showModeSelection().

        {
                global $lng;
                
                switch($a_mode)
                {
                        case LP_MODE_DEACTIVATED:
                                return $lng->txt('trac_mode_deactivated_info');

                        case LP_MODE_TLT:
                                return $lng->txt('trac_mode_tlt_info');

                        case LP_MODE_VISITS:
                                return $lng->txt('trac_mode_visits_info');
                                
                        case LP_MODE_MANUAL:
                                return $lng->txt('trac_mode_manual_info');
                                
                        case LP_MODE_MANUAL_BY_TUTOR:
                                return $lng->txt('trac_mode_manual_by_tutor_info');

                        case LP_MODE_OBJECTIVES:
                                return $lng->txt('trac_mode_objectives_info');

                        case LP_MODE_COLLECTION:
                                return $lng->txt('trac_mode_collection_info');

                        case LP_MODE_SCORM:
                                return $lng->txt('trac_mode_scorm_info');

                        case LP_MODE_TEST_FINISHED:
                                return $lng->txt('trac_mode_test_finished_info');

                        case LP_MODE_TEST_PASSED:
                                return $lng->txt('trac_mode_test_passed_info');

                        case LP_MODE_EXERCISE_RETURNED:
                                return $lng->txt('trac_mode_exercise_returned_info');

                        case LP_MODE_SCORM_PACKAGE:
                                return $lng->txt('trac_mode_scorm_package_info');
                                
                        case LP_MODE_EVENT:
                                return $lng->txt('trac_mode_event_info');
                }
                
        }

Here is the caller graph for this function:

ilLPObjSettings::_mode2Text

(

$a_mode

)

Definition at line 319 of file class.ilLPObjSettings.php.

References $lng, LP_MODE_COLLECTION, LP_MODE_DEACTIVATED, LP_MODE_EVENT, LP_MODE_EXERCISE_RETURNED, LP_MODE_MANUAL, LP_MODE_MANUAL_BY_TUTOR, LP_MODE_OBJECTIVES, LP_MODE_SCORM, LP_MODE_SCORM_PACKAGE, LP_MODE_TEST_FINISHED, LP_MODE_TEST_PASSED, LP_MODE_TLT, and LP_MODE_VISITS.

Referenced by ilLPListOfSettingsGUI\__showCollectionTable(), ilLearningProgressBaseGUI\__showObjectDetails(), ilLPItemListGUI\renderObjectInfo(), and ilLPItemListGUI\renderObjectInfoXML().

        {
                global $lng;

                switch($a_mode)
                {
                        case LP_MODE_DEACTIVATED:
                                return $lng->txt('trac_mode_deactivated');

                        case LP_MODE_TLT:
                                return $lng->txt('trac_mode_tlt');

                        case LP_MODE_VISITS:
                                return $lng->txt('trac_mode_visits');
                                
                        case LP_MODE_MANUAL:
                                return $lng->txt('trac_mode_manual');

                        case LP_MODE_MANUAL_BY_TUTOR:
                                return $lng->txt('trac_mode_manual_by_tutor');

                        case LP_MODE_OBJECTIVES:
                                return $lng->txt('trac_mode_objectives');

                        case LP_MODE_COLLECTION:
                                return $lng->txt('trac_mode_collection');

                        case LP_MODE_SCORM:
                                return $lng->txt('trac_mode_scorm');

                        case LP_MODE_TEST_FINISHED:
                                return $lng->txt('trac_mode_test_finished');

                        case LP_MODE_TEST_PASSED:
                                return $lng->txt('trac_mode_test_passed');

                        case LP_MODE_EXERCISE_RETURNED:
                                return $lng->txt('trac_mode_exercise_returned');
                        
                        case LP_MODE_SCORM_PACKAGE:
                                return $lng->txt('trac_mode_scorm_package');
                                
                        case LP_MODE_EVENT:
                                return $lng->txt('trac_mode_event');
                                

                }
        }

Here is the caller graph for this function:

ilLPObjSettings::cloneSettings

(

$a_new_obj_id

)

Clone settings.

public

Parameters

int	new obj id

Definition at line 85 of file class.ilLPObjSettings.php.

References $ilDB, $query, $res, getMode(), getObjType(), and getVisits().

        {
                global $ilDB;

                $query = "INSERT INTO ut_lp_settings (obj_id,obj_type,u_mode,visits) ".
                        "VALUES( ".
                        $this->db->quote($a_new_obj_id ,'integer').", ".
                        $this->db->quote($this->getObjType() ,'text').", ".
                        $this->db->quote($this->getMode() ,'integer').", ".
                        $this->db->quote($this->getVisits() ,'integer').
                        ")";
                $res = $ilDB->manipulate($query);
                return true;
        }

Here is the call graph for this function:

ilLPObjSettings::getMode

(

)

Definition at line 114 of file class.ilLPObjSettings.php.

References $obj_mode.

Referenced by cloneSettings(), insert(), and update().

        {
                return $this->obj_mode;
        }

Here is the caller graph for this function:

ilLPObjSettings::getObjId

(

)

Definition at line 119 of file class.ilLPObjSettings.php.

References $obj_id.

Referenced by getValidModes(), insert(), and update().

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

Here is the caller graph for this function:

ilLPObjSettings::getObjType

(

)

Definition at line 123 of file class.ilLPObjSettings.php.

References $obj_type.

Referenced by cloneSettings(), and insert().

        {
                return $this->obj_type;
        }

Here is the caller graph for this function:

ilLPObjSettings::getValidModes

(

)

Definition at line 224 of file class.ilLPObjSettings.php.

References $lng, _checkObjectives(), _checkSCORMPreconditions(), ilLPCollections\_getCountPossibleSAHSItems(), ilObjSAHSLearningModule\_lookupSubType(), getObjId(), LP_MODE_COLLECTION, LP_MODE_DEACTIVATED, LP_MODE_EVENT, LP_MODE_EXERCISE_RETURNED, LP_MODE_MANUAL, LP_MODE_MANUAL_BY_TUTOR, LP_MODE_OBJECTIVES, LP_MODE_SCORM, LP_MODE_SCORM_PACKAGE, LP_MODE_TEST_FINISHED, LP_MODE_TEST_PASSED, LP_MODE_TLT, and LP_MODE_VISITS.

        {
                global $lng;

                switch($this->obj_type)
                {
                        case 'crs':
                                if(ilLPObjSettings::_checkObjectives($this->getObjId()))
                                {
                                        return array(LP_MODE_OBJECTIVES => $lng->txt('trac_mode_objectives'));
                                }

                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                         LP_MODE_MANUAL_BY_TUTOR => $lng->txt('trac_mode_manual_by_tutor'),
                                                         LP_MODE_COLLECTION => $lng->txt('trac_mode_collection'));

                                break;

                        case 'dbk':
                                return array(
                                        LP_MODE_MANUAL => $lng->txt('trac_mode_manual'),
                                        LP_MODE_DEACTIVATE => $lng->txt('trac_mode_deactivated')
                                );
                        case 'lm':
                                return array(LP_MODE_MANUAL => $lng->txt('trac_mode_manual'),
                                                         LP_MODE_VISITS => $lng->txt('trac_mode_visits'),
                                                         LP_MODE_TLT => $lng->txt('trac_mode_tlt'),
                                                         LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'));

                        case 'htlm':
                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                         LP_MODE_MANUAL => $lng->txt('trac_mode_manual'));

                        case 'sahs':
                                include_once './Services/Tracking/classes/class.ilLPCollections.php';
                                include_once "./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php";
                                $subtype = ilObjSAHSLearningModule::_lookupSubType($this->getObjId());
                                
                                if ($subtype != "scorm2004")
                                {
                                        if(ilLPObjSettings::_checkSCORMPreconditions($this->getObjId()))
                                        {
                                                return array(LP_MODE_SCORM => $lng->txt('trac_mode_scorm_aicc'));
                                        }
                                        if(ilLPCollections::_getCountPossibleSAHSItems($this->getObjId()))
                                        {
                                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                                         LP_MODE_SCORM => $lng->txt('trac_mode_scorm_aicc'));
                                        }
                                        return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'));
                                }
                                else
                                {
                                        if(ilLPObjSettings::_checkSCORMPreconditions($this->getObjId()))
                                        {
                                                return array(LP_MODE_SCORM => $lng->txt('trac_mode_scorm_aicc'),
                                                        LP_MODE_SCORM_PACKAGE => $lng->txt('trac_mode_scorm_package'));
                                        }
                                        if(ilLPCollections::_getCountPossibleSAHSItems($this->getObjId()))
                                        {
                                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                        LP_MODE_SCORM_PACKAGE => $lng->txt('trac_mode_scorm_package'),
                                                        LP_MODE_SCORM => $lng->txt('trac_mode_scorm_aicc'));
                                        }
                                        return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                LP_MODE_SCORM_PACKAGE => $lng->txt('trac_mode_scorm_package'));
                                }
                                break;

                        case 'tst':
                                return array(LP_MODE_TEST_FINISHED => $lng->txt('trac_mode_test_finished'),
                                                         LP_MODE_TEST_PASSED => $lng->txt('trac_mode_test_passed'),
                                                         LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'));

                        case 'exc':
                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                         LP_MODE_EXERCISE_RETURNED => $lng->txt('trac_mode_exercise_returned'));

                        case 'grp':
                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                         LP_MODE_MANUAL_BY_TUTOR => $lng->txt('trac_mode_manual_by_tutor'),
                                                         LP_MODE_COLLECTION => $lng->txt('trac_mode_collection'));

                        case 'fold':
                                return array(LP_MODE_DEACTIVATED => $lng->txt('trac_mode_deactivated'),
                                                         LP_MODE_COLLECTION => $lng->txt('trac_mode_collection'));
                        
                        case 'sess':
                                return array(LP_MODE_EVENT => $this->lng->txt('trac_mode_event'));

                        default:
                                return array();
                }
        }

Here is the call graph for this function:

ilLPObjSettings::getVisits

(

)

Definition at line 100 of file class.ilLPObjSettings.php.

References LP_DEFAULT_VISITS.

Referenced by cloneSettings(), and update().

        {
                return (int) $this->visits ? $this->visits : LP_DEFAULT_VISITS;
        }

Here is the caller graph for this function:

ilLPObjSettings::ilLPObjSettings

(

$a_obj_id

)

Definition at line 63 of file class.ilLPObjSettings.php.

References $ilDB, __getDefaultMode(), and __read().

        {
                global $ilObjDataCache,$ilDB;

                $this->db =& $ilDB;

                $this->obj_id = $a_obj_id;

                if(!$this->__read())
                {
                        $this->obj_type = $ilObjDataCache->lookupType($this->obj_id);
                        $this->obj_mode = $this->__getDefaultMode($this->obj_id,$this->obj_type);
                }
        }

Here is the call graph for this function:

ilLPObjSettings::insert

(

)

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

References $ilDB, $ilLog, $query, $res, __read(), getMode(), getObjId(), and getObjType().

Referenced by update().

        {
                global $ilDB,$ilLog;
                
                $ilLog->logStack();
                
                $query = "INSERT INTO ut_lp_settings (obj_id,obj_type,u_mode,visits) ".
                        "VALUES(".
                        $ilDB->quote($this->getObjId() ,'integer').", ".
                        $ilDB->quote($this->getObjType(),'text').", ".
                        $ilDB->quote($this->getMode(),'integer').", ".
                        $ilDB->quote(0, 'integer').
                        ")";
                $res = $ilDB->manipulate($query);
                $this->__read();
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPObjSettings::setMode

(

$a_mode

)

Definition at line 110 of file class.ilLPObjSettings.php.

        {
                $this->obj_mode = $a_mode;
        }

ilLPObjSettings::setVisits

(

$a_visits

)

Definition at line 105 of file class.ilLPObjSettings.php.

        {
                $this->visits = $a_visits;
        }

ilLPObjSettings::update

(

)

Definition at line 128 of file class.ilLPObjSettings.php.

References $ilDB, $query, $res, __read(), getMode(), getObjId(), getVisits(), and insert().

        {
                global $ilDB;
                
                if(!$this->is_stored)
                {
                        return $this->insert();
                }
                $query = "UPDATE ut_lp_settings SET u_mode = ".$ilDB->quote($this->getMode() ,'integer').", ".
                        "visits = ".$ilDB->quote($this->getVisits() ,'integer')." ".
                        "WHERE obj_id = ".$ilDB->quote($this->getObjId() ,'integer');
                $res = $ilDB->manipulate($query);
                $this->__read();
                return true;
        }

Here is the call graph for this function:

Field Documentation

ilLPObjSettings::$db = null

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

ilLPObjSettings::$is_stored = false

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

ilLPObjSettings::$obj_id = null

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

Referenced by getObjId().

ilLPObjSettings::$obj_mode = null

Definition at line 58 of file class.ilLPObjSettings.php.

Referenced by getMode().

ilLPObjSettings::$obj_type = null

Definition at line 57 of file class.ilLPObjSettings.php.

Referenced by getObjType().

ilLPObjSettings::$visits = null

Definition at line 59 of file class.ilLPObjSettings.php.

---

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

• Services/Tracking/classes/class.ilLPObjSettings.php