ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields
ilObjSAHSLearningModule Class Reference
Modules/ScormAicc

Class ilObjSCORMLearningModule. More...

+ Inheritance diagram for ilObjSAHSLearningModule:
+ Collaboration diagram for ilObjSAHSLearningModule:

Public Member Functions

 ilObjSAHSLearningModule ($a_id=0, $a_call_by_reference=true)
 Constructor public.
 create ($upload=false)
 create file based lm
 read ()
 read object
 _lookupOnline ($a_id)
 check wether scorm module is online
 getAffectiveLocalization ($a_id)
 Get affective localization.
 _lookupSubType ($a_obj_id)
 lookup subtype id (scorm, aicc, hacp)
 setEditable ($a_editable)
 Set Editable.
 getEditable ()
 Get Editable.
 setTries ($a_tries)
 Set default tries for questions.
 getTries ()
 Get Tries.
 setLocalization ($a_val)
 Set localization.
 getLocalization ()
 Get localization.
 getDiskUsage ()
 Gets the disk usage of the object in bytes.
 createDataDirectory ()
 creates data directory for package files ("./data/lm_data/lm_<id>")
 getDataDirectory ($mode="filesystem")
 get data directory of lm
 getAPIAdapterName ()
 get api adapter name
 setAPIAdapterName ($a_api)
 set api adapter name
 getAPIFunctionsPrefix ()
 get api functions prefix
 setAPIFunctionsPrefix ($a_prefix)
 set api functions prefix
 getCreditMode ()
 get credit mode
 setCreditMode ($a_credit_mode)
 set credit mode
 setDefaultLessonMode ($a_lesson_mode)
 set default lesson mode
 getDefaultLessonMode ()
 get default lesson mode
 getStyleSheetId ()
 get ID of assigned style sheet object
 setStyleSheetId ($a_style_id)
 set ID of assigned style sheet object
 setAutoReview ($a_auto_review)
 get auto review
 getAutoReview ()
 set auto review
 getMaxAttempt ()
 get max attempt
 setMaxAttempt ($a_max_attempt)
 set max attempt
 getModuleVersion ()
 get max attempt
 getAssignedGlossary ()
 get assigned glossary
 setAssignedGlossary ($a_assigned_glossary)
 set assigned glossary
 setModuleVersion ($a_module_version)
 set max attempt
 getSession ()
 get session setting
 setSession ($a_session)
 set session setting
 getNoMenu ()
 disable menu
 setNoMenu ($a_no_menu)
 disable menu
 getHideNavig ()
 hide navigation tree
 setHideNavig ($a_hide_navig)
 disable menu
 getCacheDeactivated ()
 BrowserCacheDisabled for SCORM 2004 / ENABLE_JS_DEBUG.
 getDebugActivated ()
 debugActivated
 getSequencing ()
 sequencing
 setSequencing ($a_sequencing)
 getInteractions ()
 interactions
 setInteractions ($a_interactions)
 getObjectives ()
 objectives
 setObjectives ($a_objectives)
 getComments ()
 comments
 setComments ($a_comments)
 getTime_from_lms ()
 time_from_lms
 setTime_from_lms ($a_time_from_lms)
 getDebug ()
 debug
 setDebug ($a_debug)
 debug
 getDebugPw ()
 debug pw
 setDebugPw ($a_debug_pw)
 debug pw
 setAutoContinue ($a_auto_continue)
 get auto continue
 getAutoContinue ()
 set auto continue
 setSequencingExpertMode ($a_val)
 Set sequencing expert mode.
 getSequencingExpertMode ()
 Get sequencing expert mode.
 getOpenMode ()
 open_mode 0: in Tab/new Window like in previous versions 1: in iFrame with width=100% and heigth=100% 2: in iFrame with specified width and height 3: 4: 5: in new Window without specified width and height 6: in new Window with specified width and height
 setOpenMode ($a_open_mode)
 getWidth ()
 width
 setWidth ($a_width)
 getHeight ()
 height
 setHeight ($a_height)
 update ()
 update meta data only
 setOnline ($a_online)
 get online
 getOnline ()
 set online
 setSubType ($a_sub_type)
 get sub type
 getSubType ()
 set sub type
 delete ()
 delete SCORM learning module and all related data
 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 happend, each object may decide how it reacts.
 getPointsInPercent ()
 Returns the points in percent for the learning module This is called by the certificate generator if [SCORM_POINTS] is inserted.
 getMaxPoints ()
 Returns score.max for the learning module, refered to the last sco where score.max is set.
- 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
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class)
 create ()
 create
 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
 _lookupObjectId ($a_ref_id)
 lookup object id
 _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
 createReference ()
 creates reference for object
 countReferences ()
 count references of object
 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
 createRoleFolder ()
 creates a local role folder
 applyDidacticTemplate ($a_tpl_id)
 Apply template.
 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.

Static Public Member Functions

static _getTries ($a_id)
static getScormModulesForGlossary ($a_glo_id)
 Get SCORM modules that assign a certain glossary.
- 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 _lookupType ($a_id, $a_reference=false)
 lookup object type
 _exists ($a_id, $a_reference=false)
 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.

Data Fields

 $validator
- Data Fields inherited from ilObject
const TITLE_LENGTH = 128
 max length of object title
 $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

Detailed Description

Class ilObjSCORMLearningModule.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Id:
class.ilObjSAHSLearningModule.php 30952 2011-10-03 23:00:46Z ukohnle

Definition at line 20 of file class.ilObjSAHSLearningModule.php.

Member Function Documentation

static ilObjSAHSLearningModule::_getTries (   $a_id)
static

Definition at line 216 of file class.ilObjSAHSLearningModule.php.

References $ilDB.

Referenced by ilPCQuestionGUI\edit().

{
global $ilDB;
$lm_set = $ilDB->queryF('SELECT question_tries FROM sahs_lm WHERE id = %s',
array('integer'), array($a_id));
$lm_rec = $ilDB->fetchAssoc($lm_set);
return $lm_rec['question_tries'];
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::_lookupOnline (   $a_id)

check wether scorm module is online

Definition at line 108 of file class.ilObjSAHSLearningModule.php.

References $ilDB, and ilUtil\yn2tf().

{
global $ilDB;
$lm_set = $ilDB->queryF('SELECT c_online FROM sahs_lm WHERE id = %s',
array('integer'), array($a_id));
$lm_rec = $ilDB->fetchAssoc($lm_set);
return ilUtil::yn2tf($lm_rec["c_online"]);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::_lookupSubType (   $a_obj_id)

lookup subtype id (scorm, aicc, hacp)

Parameters
int$a_idobject id

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

References $ilDB.

Referenced by ilLPCollections\_getPossibleSAHSItems(), ilLPCollections\_getScoresForUserAndCP_Node_Id(), ilLPStatusSCORM\_getStatusInfo(), ilObjSAHSLearningModuleAccess\_lookupUserCertificate(), ilLPStatusSCORM\determinePercentage(), ilLPStatusSCORM\determineStatus(), ilSCORMPresentationGUI\downloadCertificate(), ilSAHSPresentationGUI\executeCommand(), ilSAHSEditGUI\executeCommand(), ilTrQuery\getObjectsDataForUser(), ilTrQuery\getParticipantsForObject(), ilObjSAHSLearningModuleListGUI\getProperties(), ilLPObjSettings\getValidModes(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilObjSCORMLearningModuleGUI\properties(), and ilLPStatusSCORM\refreshStatus().

{
global $ilDB;
$obj_set = $ilDB->queryF('SELECT c_type FROM sahs_lm WHERE id = %s',
array('integer'), array($a_obj_id));
$obj_rec = $ilDB->fetchAssoc($obj_set);
return $obj_rec["c_type"];
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::create (   $upload = false)

create file based lm

Definition at line 40 of file class.ilObjSAHSLearningModule.php.

References $ilDB, ilObject\create(), createDataDirectory(), ilObject\createMetaData(), getEditable(), ilObject\getId(), getLocalization(), getSequencingExpertMode(), and getSubType().

{
global $ilDB;
parent::create();
if(!$upload)
$this->createMetaData();
$this->createDataDirectory();
$ilDB->manipulateF('
INSERT INTO sahs_lm (id, c_online, api_adapter, c_type, editable, seq_exp_mode,localization)
VALUES (%s,%s,%s,%s,%s,%s,%s)',
array('integer', 'text', 'text', 'text', 'integer','integer','text'),
array($this->getId(),'n','API', $this->getSubType(),(int)$this->getEditable(),
(int)$this->getSequencingExpertMode(), $this->getLocalization()
));
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::createDataDirectory ( )

creates data directory for package files ("./data/lm_data/lm_<id>")

Definition at line 243 of file class.ilObjSAHSLearningModule.php.

References getDataDirectory(), ilUtil\getWebspaceDir(), and ilUtil\makeDir().

Referenced by create().

{
$lm_data_dir = ilUtil::getWebspaceDir()."/lm_data";
ilUtil::makeDir($lm_data_dir);
ilUtil::makeDir($this->getDataDirectory());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::delete ( )

delete SCORM learning module and all related data

this method has been tested on may 9th 2004 meta data, scorm lm data, scorm tree, scorm objects (organization(s), manifest, resources and items), tracking data and data directory have been deleted correctly as desired

public

Returns
boolean true if all object data were removed; false if only a references were removed

Reimplemented from ilObject.

Reimplemented in ilObjAICCLearningModule.

Definition at line 856 of file class.ilObjSAHSLearningModule.php.

References $ilDB, $ilLog, $res, $row, ilSCORMObject\_getInstance(), ilUtil\delDir(), ilObject\deleteMetaData(), getDataDirectory(), ilObject\getId(), and getSubType().

{
global $ilDB, $ilLog;
// always call parent delete function first!!
if (!parent::delete())
{
return false;
}
// delete meta data of scorm content object
/*
$nested = new ilNestedSetXML();
$nested->init($this->getId(), $this->getType());
$nested->deleteAllDBData();
*/
$this->deleteMetaData();
// delete data directory
ilUtil::delDir($this->getDataDirectory());
// delete scorm learning module record
$ilDB->manipulateF('DELETE FROM sahs_lm WHERE id = %s',
array('integer'), array($this->getId()));
$ilLog->write("SAHS Delete(SAHSLM), Subtype: ".$this->getSubType());
if ($this->getSubType() == "scorm")
{
// remove all scorm objects and scorm tree
include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMTree.php");
include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMObject.php");
$sc_tree = new ilSCORMTree($this->getId());
$r_id = $sc_tree->readRootId();
if ($r_id > 0)
{
$items = $sc_tree->getSubTree($sc_tree->getNodeData($r_id));
foreach($items as $item)
{
$sc_object =& ilSCORMObject::_getInstance($item["obj_id"], $this->getId());
if (is_object($sc_object))
{
$sc_object->delete();
}
}
$sc_tree->removeTree($sc_tree->getTreeId());
}
}
if ($this->getSubType() != "scorm")
{
// delete aicc data
$res = $ilDB->queryF('
SELECT aicc_object.obj_id FROM aicc_object, aicc_units
WHERE aicc_object.obj_id = aicc_units.obj_id
AND aicc_object.slm_id = %s',
array('integer'), array($this->getId()));
while($row = $ilDB->fetchAssoc($res))
{
$obj_id = $row['obj_id'];
$ilDB->manipulateF('
DELETE FROM aicc_units WHERE obj_id = %s',
array('integer'), array($obj_id));
}
$res = $ilDB->queryF('
SELECT aicc_object.obj_id FROM aicc_object, aicc_course
WHERE aicc_object.obj_id = aicc_course.obj_id
AND aicc_object.slm_id = %s',
array('integer'), array($this->getId()));
while($row = $ilDB->fetchAssoc($res))
{
$obj_id = $row['obj_id'];
$ilDB->manipulateF('
DELETE FROM aicc_course WHERE obj_id = %s',
array('integer'), array($obj_id));
}
$ilDB->manipulateF('
DELETE FROM aicc_object WHERE slm_id = %s',
array('integer'), array($this->getId()));
}
$q_log = "DELETE FROM scorm_tracking WHERE obj_id = ".$ilDB->quote($this->getId());
$ilLog->write("SAHS Delete(SAHSLM): ".$q_log);
$ilDB->manipulateF('DELETE FROM scorm_tracking WHERE obj_id = %s',
array('integer'), array($this->getId()));
// always call parent delete function at the end!!
return true;
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::getAffectiveLocalization (   $a_id)

Get affective localization.

Parameters
int$a_idscorm lm id

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

References $ilDB, and ilObject\$lng.

Referenced by ilSCORM2004PageGUI\__construct(), ilSCORM2004Asset\exportHTMLPageObjects(), ilSCORM2004ScoGUI\getGloOverviewOv(), ilSCORM2004PageGUI\postOutputProcessing(), and ilSCORM2004ScoGUI\sco_preview().

{
global $ilDB, $lng;
$lm_set = $ilDB->queryF('SELECT localization FROM sahs_lm WHERE id = %s',
array('integer'), array($a_id));
$lm_rec = $ilDB->fetchAssoc($lm_set);
$inst_lang = $lng->getInstalledLanguages();
if ($lm_rec["localization"] != "" && in_array($lm_rec["localization"], $inst_lang))
{
return $lm_rec["localization"];
}
return $lng->getLangKey();
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAPIAdapterName ( )

get api adapter name

Definition at line 264 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->api_adapter;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAPIFunctionsPrefix ( )

get api functions prefix

Definition at line 280 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->api_func_prefix;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAssignedGlossary ( )

get assigned glossary

Definition at line 385 of file class.ilObjSAHSLearningModule.php.

Referenced by ilObjSCORM2004LearningModule\exportHTMLScoObjects(), ilObjSCORM2004LearningModule\exportPDF(), ilObjSCORM2004LearningModule\exportScorm(), and update().

{
return $this->assigned_glossary;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAutoContinue ( )

set auto continue

Definition at line 583 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->auto_continue;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAutoReview ( )

set auto review

Definition at line 351 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->auto_review;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getCacheDeactivated ( )

BrowserCacheDisabled for SCORM 2004 / ENABLE_JS_DEBUG.

Definition at line 456 of file class.ilObjSAHSLearningModule.php.

References $ilSetting.

{
global $ilSetting;
$lm_set = new ilSetting("lm");
if ($lm_set->get("scormdebug_disable_cache") == "1") return true;
return false;
}
ilObjSAHSLearningModule::getComments ( )

comments

Definition at line 517 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->comments;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getCreditMode ( )

get credit mode

Definition at line 296 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->credit_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDataDirectory (   $mode = "filesystem")

get data directory of lm

Definition at line 253 of file class.ilObjSAHSLearningModule.php.

References ilObject\getId(), and ilUtil\getWebspaceDir().

Referenced by ilObjSCORM2004LearningModule\convert_1_2_to_2004(), createDataDirectory(), ilObjAICCLearningModule\delete(), delete(), ilObjAICCLearningModule\readObject(), ilObjSCORM2004LearningModule\readObject(), and ilObjSCORMLearningModule\readObject().

{
$lm_data_dir = ilUtil::getWebspaceDir($mode)."/lm_data";
$lm_dir = $lm_data_dir."/lm_".$this->getId();
return $lm_dir;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDebug ( )

debug

Definition at line 544 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->debug;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDebugActivated ( )

debugActivated

Definition at line 467 of file class.ilObjSAHSLearningModule.php.

References $ilSetting.

{
global $ilSetting;
$lm_set = new ilSetting("lm");
if ($lm_set->get("scormdebug_global_activate") == "1") return true;
return false;
}
ilObjSAHSLearningModule::getDebugPw ( )

debug pw

Definition at line 560 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->debug_pw;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDefaultLessonMode ( )

get default lesson mode

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

Referenced by update().

{
return $this->lesson_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDiskUsage ( )

Gets the disk usage of the object in bytes.

public

Returns
integer the disk usage in bytes

Reimplemented from ilObject.

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

References ilObjSAHSLearningModuleAccess\_lookupDiskUsage().

{
require_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php");
return ilObjSAHSLearningModuleAccess::_lookupDiskUsage($this->id);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::getEditable ( )

Get Editable.

Returns
boolean Editable

Definition at line 170 of file class.ilObjSAHSLearningModule.php.

Referenced by create(), ilObjSCORM2004LearningModule\readObject(), and update().

{
return $this->editable;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getHeight ( )

height

Definition at line 644 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->height;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getHideNavig ( )

hide navigation tree

Definition at line 440 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->hide_navig;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getInteractions ( )

interactions

Definition at line 491 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->interactions;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getLocalization ( )

Get localization.

Returns
string localization

Definition at line 211 of file class.ilObjSAHSLearningModule.php.

Referenced by create(), and update().

{
return $this->localization;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getMaxAttempt ( )

get max attempt

Definition at line 360 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->max_attempt;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getMaxPoints ( )

Returns score.max for the learning module, refered to the last sco where score.max is set.

This is called by the certificate generator if [SCORM_POINTS_MAX] is inserted.

public

Returns
float

Definition at line 1050 of file class.ilObjSAHSLearningModule.php.

References $res, ilObjSCORM2004LearningModule\_getMaxScoreForUser(), ilObject\getId(), and getSubType().

{
global $ilUser;
if(strcmp($this->getSubType(), 'scorm2004') == 0)
{
$res = ilObjSCORM2004LearningModule::_getMaxScoreForUser($this->getId(), $ilUser->getId());
return $res;
}
else
{
return null;
}
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::getModuleVersion ( )

get max attempt

Definition at line 377 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->module_version;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getNoMenu ( )

disable menu

Definition at line 424 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->no_menu;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getObjectives ( )

objectives

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

Referenced by update().

{
return $this->objectives;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getOnline ( )

set online

Definition at line 824 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->online;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getOpenMode ( )

open_mode 0: in Tab/new Window like in previous versions 1: in iFrame with width=100% and heigth=100% 2: in iFrame with specified width and height 3: 4: 5: in new Window without specified width and height 6: in new Window with specified width and height

Definition at line 620 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->open_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getPointsInPercent ( )

Returns the points in percent for the learning module This is called by the certificate generator if [SCORM_POINTS] is inserted.

Definition at line 1019 of file class.ilObjSAHSLearningModule.php.

References $res, ilObjSCORM2004LearningModule\_getUniqueScaledScoreForUser(), ilObject\getId(), and getSubType().

{
global $ilUser;
if (strcmp($this->getSubType(), "scorm2004") == 0)
{
$res = ilObjSCORM2004LearningModule::_getUniqueScaledScoreForUser($this->getId(), $ilUser->getId());
if (!is_null($res))
{
return $res * 100.0;
}
else
{
return $res;
}
}
else
{
return null;
}
}

+ Here is the call graph for this function:

static ilObjSAHSLearningModule::getScormModulesForGlossary (   $a_glo_id)
static

Get SCORM modules that assign a certain glossary.

Parameters
@return

Definition at line 796 of file class.ilObjSAHSLearningModule.php.

References $ilDB, and ilObject\_hasUntrashedReference().

Referenced by ilObjGlossaryGUI\addUsagesToInfo(), and ilObjGlossary\getDeletionDependencies().

{
global $ilDB;
$set = $ilDB->query("SELECT DISTINCT id FROM sahs_lm WHERE ".
" glossary = ".$ilDB->quote($a_glo_id, "integer"));
$sms = array();
while ($rec = $ilDB->fetchAssoc($set))
{
if (ilObject::_hasUntrashedReference($rec["id"]))
{
$sms[] = $rec["id"];
}
}
return $sms;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getSequencing ( )

sequencing

Definition at line 478 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->sequencing;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getSequencingExpertMode ( )

Get sequencing expert mode.

Returns
boolean sequencing expert mode

Definition at line 604 of file class.ilObjSAHSLearningModule.php.

Referenced by create(), and update().

{
return $this->seq_exp_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getSession ( )

get session setting

Definition at line 408 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->session;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getStyleSheetId ( )

get ID of assigned style sheet object

Definition at line 327 of file class.ilObjSAHSLearningModule.php.

Referenced by ilObjSCORM2004LearningModule\prepareHTMLExporter(), and update().

{
return $this->style_id;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getSubType ( )

set sub type

Definition at line 840 of file class.ilObjSAHSLearningModule.php.

Referenced by create(), delete(), getMaxPoints(), getPointsInPercent(), and update().

{
return $this->sub_type;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getTime_from_lms ( )

time_from_lms

Definition at line 530 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->time_from_lms;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getTries ( )

Get Tries.

Returns
boolean tries

Definition at line 191 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->tries;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getWidth ( )

width

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

Referenced by update().

{
return $this->width;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::ilObjSAHSLearningModule (   $a_id = 0,
  $a_call_by_reference = true 
)

Constructor public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

References ilObject\ilObject().

{
$this->type = "sahs";
parent::ilObject($a_id,$a_call_by_reference);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::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 happend, each object may decide how it reacts.

public

Parameters
stringevent
integerreference id of object where the event occured
arraypasses optional paramters if required
Returns
boolean

Reimplemented from ilObject.

Definition at line 961 of file class.ilObjSAHSLearningModule.php.

References $_GET, and ilObject\getType().

{
global $tree;
switch ($a_event)
{
case "link":
//var_dump("<pre>",$a_params,"</pre>");
//echo "SCORMLearningModule ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
//exit;
break;
case "cut":
//echo "SCORMLearningModule ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
//exit;
break;
case "copy":
//var_dump("<pre>",$a_params,"</pre>");
//echo "SCORMLearningModule ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
//exit;
break;
case "paste":
//echo "SCORMLearningModule ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
//exit;
break;
case "new":
//echo "SCORMLearningModule ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
//exit;
break;
}
// At the beginning of the recursive process it avoids second call of the notify function with the same parameter
if ($a_node_id==$_GET["ref_id"])
{
$parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
$parent_type = $parent_obj->getType();
if($parent_type == $this->getType())
{
$a_node_id = (int) $tree->getParentId($a_node_id);
}
}
parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::read ( )

read object

Definition at line 62 of file class.ilObjSAHSLearningModule.php.

References $ilDB, ilObject\getId(), setAPIAdapterName(), setAPIFunctionsPrefix(), setAssignedGlossary(), setAutoContinue(), setAutoReview(), setComments(), setCreditMode(), setDebug(), setDebugPw(), setDefaultLessonMode(), setEditable(), setHeight(), setHideNavig(), setInteractions(), setLocalization(), setMaxAttempt(), setModuleVersion(), setNoMenu(), setObjectives(), setOnline(), setOpenMode(), setSequencing(), setSequencingExpertMode(), setSession(), setStyleSheetId(), setSubType(), setTime_from_lms(), setTries(), setWidth(), and ilUtil\yn2tf().

{
global $ilDB;
parent::read();
$lm_set = $ilDB->queryF('SELECT * FROM sahs_lm WHERE id = %s',
array('integer'),array($this->getId()));
while($lm_rec = $ilDB->fetchAssoc($lm_set))
{
$this->setOnline(ilUtil::yn2tf($lm_rec["c_online"]));
$this->setAutoReview(ilUtil::yn2tf($lm_rec["auto_review"]));
$this->setAPIAdapterName($lm_rec["api_adapter"]);
$this->setDefaultLessonMode($lm_rec["default_lesson_mode"]);
$this->setAPIFunctionsPrefix($lm_rec["api_func_prefix"]);
$this->setCreditMode($lm_rec["credit"]);
$this->setSubType($lm_rec["c_type"]);
$this->setEditable($lm_rec["editable"]);
$this->setStyleSheetId($lm_rec["stylesheet"]);
$this->setMaxAttempt($lm_rec["max_attempt"]);
$this->setModuleVersion($lm_rec["module_version"]);
$this->setAssignedGlossary($lm_rec["glossary"]);
$this->setTries($lm_rec["question_tries"]);
$this->setLocalization($lm_rec["localization"]);
$this->setSession(ilUtil::yn2tf($lm_rec["unlimited_session"]));
$this->setNoMenu(ilUtil::yn2tf($lm_rec["no_menu"]));
$this->setHideNavig(ilUtil::yn2tf($lm_rec["hide_navig"]));
$this->setSequencing(ilUtil::yn2tf($lm_rec["sequencing"]));
$this->setInteractions(ilUtil::yn2tf($lm_rec["interactions"]));
$this->setObjectives(ilUtil::yn2tf($lm_rec["objectives"]));
$this->setComments(ilUtil::yn2tf($lm_rec["comments"]));
$this->setTime_from_lms(ilUtil::yn2tf($lm_rec["time_from_lms"]));
$this->setDebug(ilUtil::yn2tf($lm_rec["debug"]));
$this->setDebugPw($lm_rec["debugpw"]);
$this->setSequencingExpertMode($lm_rec["seq_exp_mode"]);
$this->setOpenMode($lm_rec["open_mode"]);
$this->setWidth($lm_rec["width"]);
$this->setHeight($lm_rec["height"]);
$this->setAutoContinue(ilUtil::yn2tf($lm_rec["auto_continue"]));
}
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::setAPIAdapterName (   $a_api)

set api adapter name

Definition at line 272 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->api_adapter = $a_api;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setAPIFunctionsPrefix (   $a_prefix)

set api functions prefix

Definition at line 288 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->api_func_prefix = $a_prefix;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setAssignedGlossary (   $a_assigned_glossary)

set assigned glossary

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

Referenced by read().

{
$this->assigned_glossary = $a_assigned_glossary;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setAutoContinue (   $a_auto_continue)

get auto continue

Definition at line 576 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->auto_continue = $a_auto_continue;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setAutoReview (   $a_auto_review)

get auto review

Definition at line 344 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->auto_review = $a_auto_review;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setComments (   $a_comments)

Definition at line 522 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->comments = $a_comments;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setCreditMode (   $a_credit_mode)

set credit mode

Definition at line 304 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->credit_mode = $a_credit_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setDebug (   $a_debug)

debug

Definition at line 552 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->debug = $a_debug;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setDebugPw (   $a_debug_pw)

debug pw

Definition at line 568 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->debug_pw = $a_debug_pw;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setDefaultLessonMode (   $a_lesson_mode)

set default lesson mode

Definition at line 312 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->lesson_mode = $a_lesson_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setEditable (   $a_editable)

Set Editable.

Parameters
boolean$a_editableEditable

Definition at line 160 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->editable = $a_editable;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setHeight (   $a_height)

Definition at line 648 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->height = $a_height;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setHideNavig (   $a_hide_navig)

disable menu

Definition at line 448 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->hide_navig = $a_hide_navig;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setInteractions (   $a_interactions)

Definition at line 496 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->interactions = $a_interactions;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setLocalization (   $a_val)

Set localization.

Parameters
string$a_vallocalization

Definition at line 201 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->localization = $a_val;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setMaxAttempt (   $a_max_attempt)

set max attempt

Definition at line 369 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->max_attempt = $a_max_attempt;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setModuleVersion (   $a_module_version)

set max attempt

Definition at line 400 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->module_version = $a_module_version;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setNoMenu (   $a_no_menu)

disable menu

Definition at line 432 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->no_menu = $a_no_menu;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setObjectives (   $a_objectives)

Definition at line 509 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->objectives = $a_objectives;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setOnline (   $a_online)

get online

Definition at line 816 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->online = $a_online;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setOpenMode (   $a_open_mode)

Definition at line 624 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->open_mode = $a_open_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setSequencing (   $a_sequencing)

Definition at line 483 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->sequencing = $a_sequencing;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setSequencingExpertMode (   $a_val)

Set sequencing expert mode.

Parameters
boolean$a_valsequencing expert mode

Definition at line 594 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->seq_exp_mode = $a_val;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setSession (   $a_session)

set session setting

Definition at line 416 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->session = $a_session;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setStyleSheetId (   $a_style_id)

set ID of assigned style sheet object

Definition at line 335 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->style_id = $a_style_id;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setSubType (   $a_sub_type)

get sub type

Definition at line 832 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->sub_type = $a_sub_type;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setTime_from_lms (   $a_time_from_lms)

Definition at line 535 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->time_from_lms = $a_time_from_lms;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setTries (   $a_tries)

Set default tries for questions.

Parameters
boolean$a_trestries

Definition at line 181 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->tries = $a_tries;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setWidth (   $a_width)

Definition at line 636 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->width = $a_width;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::update ( )

update meta data only

update object data

public

Returns
boolean

Reimplemented from ilObject.

Definition at line 685 of file class.ilObjSAHSLearningModule.php.

References $ilDB, getAPIAdapterName(), getAPIFunctionsPrefix(), getAssignedGlossary(), getAutoContinue(), getAutoReview(), getComments(), getCreditMode(), getDebug(), getDebugPw(), getDefaultLessonMode(), getEditable(), getHeight(), getHideNavig(), ilObject\getId(), getInteractions(), getLocalization(), getMaxAttempt(), getModuleVersion(), getNoMenu(), getObjectives(), getOnline(), getOpenMode(), getSequencing(), getSequencingExpertMode(), getSession(), getStyleSheetId(), getSubType(), getTime_from_lms(), getTries(), getWidth(), ilUtil\tf2yn(), and ilObject\updateMetaData().

{
global $ilDB;
$this->updateMetaData();
parent::update();
$statement = $ilDB->manipulateF('
UPDATE sahs_lm
SET c_online = %s,
api_adapter = %s,
api_func_prefix = %s,
auto_review = %s,
default_lesson_mode = %s,
c_type = %s,
stylesheet = %s,
editable = %s,
max_attempt = %s,
module_version = %s,
credit = %s,
glossary = %s,
question_tries = %s,
unlimited_session = %s,
no_menu = %s,
hide_navig = %s,
sequencing = %s,
interactions = %s,
objectives = %s,
comments = %s,
time_from_lms = %s,
debug = %s,
localization = %s,
seq_exp_mode = %s,
debugpw = %s,
open_mode = %s,
width = %s,
height = %s,
auto_continue = %s
WHERE id = %s',
array( 'text',
'text',
'text',
'text',
'text',
'text',
'integer',
'integer',
'integer',
'integer',
'text',
'integer',
'integer',
'text',
'text',
'text',
'text',
'text',
'text',
'text',
'text',
'text',
'text',
'integer',
'text',
'integer',
'integer',
'integer',
'text',
'integer'
),
array( ilUtil::tf2yn($this->getOnline()),
$this->getAPIAdapterName(),
$this->getAPIFunctionsPrefix(),
ilUtil::tf2yn($this->getAutoReview()),
$this->getDefaultLessonMode(),
$this->getSubType(),
$this->getStyleSheetId(),
$this->getEditable(),
$this->getMaxAttempt(),
$this->getModuleVersion(),
$this->getCreditMode(),
$this->getAssignedGlossary(),
$this->getTries(),
ilUtil::tf2yn($this->getSession()),
ilUtil::tf2yn($this->getNoMenu()),
ilUtil::tf2yn($this->getHideNavig()),
ilUtil::tf2yn($this->getSequencing()),
ilUtil::tf2yn($this->getInteractions()),
ilUtil::tf2yn($this->getObjectives()),
ilUtil::tf2yn($this->getComments()),
ilUtil::tf2yn($this->getTime_from_lms()),
ilUtil::tf2yn($this->getDebug()),
$this->getLocalization(),
$this->getSequencingExpertMode(),
$this->getDebugPw(),
$this->getOpenMode(),
$this->getWidth(),
$this->getHeight(),
ilUtil::tf2yn($this->getAutoContinue()),
$this->getId())
);
return true;
}

+ Here is the call graph for this function:

Field Documentation

ilObjSAHSLearningModule::$validator

Definition at line 22 of file class.ilObjSAHSLearningModule.php.

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