ilObjSAHSLearningModule Class Reference

Class ilObjSCORMLearningModule. More...

Inheritance diagram for ilObjSAHSLearningModule:

Collaboration diagram for ilObjSAHSLearningModule:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	Constructor. More...
	create (bool $upload=false)
	create file based lm More...
	read ()
	read object More...
	getEditable ()
	setTries (int $a_tries)
	Set default tries for questions. More...
	getTries ()
	setLocalization (string $a_val)
	getLocalization ()
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	createDataDirectory ()
	creates data directory for package files ("./public/data/lm_data/lm_<id>") More...
	getDataDirectory (?string $mode="filesystem")
	get data directory of lm More...
	getRID ()
	setRID (?string $rid)
	hasContainerResource ()
	True when the module's content lives in a Resource Storage container. More...
	getResource ()
	getContainerBaseUri (float $valid_for_at_least_minutes=480.0)
	Base URL of the content container, ending in the sub-request separator so the player can append relative paths (e.g. More...
	removeContainerResource ()
	getManifestFromContainer (string $manifest_file='imsmanifest.xml')
	Read the imsmanifest.xml of the current container revision (migrated modules). More...
	replaceContainerFromZipPath (string $absolute_zip_path, ?string $revision_title=null)
	Replace the content of the module's container resource with a new ZIP as a new revision (migrated modules only). More...
	moveDataDirectoryToContainer ()
	Move the on-disk data directory into a new container resource and remove the directory. More...
	extractContainerToDataDirectory ()
	Extract the current container revision back onto disk at getDataDirectory(). More...
	writeContentZip (string $target_zip_path)
	Write the module content to $target_zip_path as a zip without the lm_<id> top directory (export "content.zip"). More...
	getAPIAdapterName ()
	get api adapter name More...
	setAPIAdapterName (string $a_api)
	set api adapter name More...
	getAPIFunctionsPrefix ()
	get api functions prefix More...
	setAPIFunctionsPrefix (string $a_prefix)
	set api functions prefix More...
	getCreditMode ()
	get credit mode More...
	setDefaultLessonMode (string $a_lesson_mode)
	set default lesson mode More...
	getDefaultLessonMode ()
	get default lesson mode More...
	getStyleSheetId ()
	get ID of assigned style sheet object More...
	setStyleSheetId (int $a_style_id)
	set ID of assigned style sheet object More...
	setAutoReview (bool $a_auto_review)
	set auto review as true/false for SCORM 1.2 More...
	getAutoReview ()
	get auto review as true/false for SCORM 1.2 More...
	setAutoReviewChar (?string $a_auto_review)
	set auto review as Char for SCORM 2004 More...
	getAutoReviewChar ()
	get auto review as Char for SCORM 2004 More...
	getMaxAttempt ()
	setMaxAttempt (int $a_max_attempt)
	getModuleVersion ()
	getAssignedGlossary ()
	setAssignedGlossary (int $a_assigned_glossary)
	setModuleVersion (int $a_module_version)
	getSession ()
	setSession (bool $a_session)
	getNoMenu ()
	disable menu More...
	setNoMenu (bool $a_no_menu)
	disable menu More...
	getHideNavig ()
	hide navigation tree More...
	setHideNavig (bool $a_hide_navig)
	disable menu More...
	getCacheDeactivated ()
	BrowserCacheDisabled for SCORM 2004 / ENABLE_JS_DEBUG. More...
	getSessionDeactivated ()
	sessionDisabled for SCORM 2004 More...
	getDebugActivated ()
	debugActivated More...
	getIe_force_render ()
	force Internet Explorer to render again after some Milliseconds - useful for learning Modules with a lot of iframes or frames and IE >=10 More...
	setIe_force_render (bool $a_ie_force_render)
	getFourth_Edition ()
	SCORM 2004 4th edition features. More...
	setFourth_edition (bool $a_fourth_edition)
	getSequencing ()
	setSequencing (bool $a_sequencing)
	getInteractions ()
	setInteractions (bool $a_interactions)
	getObjectives ()
	setObjectives (bool $a_objectives)
	getComments ()
	setComments (bool $a_comments)
	getTime_from_lms ()
	setTime_from_lms (bool $a_time_from_lms)
	getCheck_values ()
	setCheck_values (bool $a_check_values)
	getDebug ()
	setDebug (bool $a_debug)
	setAutoContinue (bool $a_auto_continue)
	getAutoContinue ()
	getAuto_last_visited ()
	setAuto_last_visited (bool $a_auto_last_visited)
	setAutoSuspend (bool $a_auto_suspend)
	getAutoSuspend ()
	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 More...
	setOpenMode (int $a_open_mode)
	getWidth ()
	setWidth (int $a_width)
	getHeight ()
	setHeight (int $a_height)
	getMasteryScore ()
	setMasteryScore (?int $a_mastery_score)
	checkMasteryScoreValues ()
	check mastery_score / min_normalized_measure of SCOs (SCORM 1.2) / objectives (SCORM 2004) More...
	getMasteryScoreValues ()
	getIdSetting ()
	setIdSetting (int $a_id_setting)
	getNameSetting ()
	setNameSetting (int $a_name_setting)
	update ()
	setSubType (string $a_sub_type)
	getSubType ()
	adoptSettingsFrom (ilObjSAHSLearningModule $source)
	Adopt compatible SCORM runtime/settings from another SCORM module. More...
	delete ()
	delete SCORM learning module and all related data More...
	getPointsInPercent ()
	Returns the points in percent for the learning module This is called by the certificate generator if [SCORM_POINTS] is inserted. More...
	getMaxPoints ()
	Returns score.max for the learning module, refered to the last sco where score.max is set. More...
	populateByDirectoy (string $a_dir, string $a_filename="")
	Populate by directory. More...
	getApiStudentId ()
	Get cmi.core.student_id / cmi.learner_id for API. More...
	getApiStudentName ()
	Get cmi.core.student_name / cmi.learner_name for API note: 'lastname, firstname' is required for SCORM 1.2; 9 = no name to hide student_name for external content. More...
	getViewButton ()
	get button for view More...
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	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. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getAffectiveLocalization (int $a_id)
	Get affective localization. More...
static	_lookupSubType (int $a_obj_id)
	lookup subtype id (scorm, ) More...
static	_getTries (int $a_id)
	obsolet? More...
static	getScormModulesForGlossary (int $a_glo_id)
	Get SCORM modules that assign a certain glossary. More...
static	lookupAssignedGlossary (int $a_slm_id)
	Get SCORM modules that assign a certain glossary. More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Protected Member Functions
	getIrss ()
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
bool	$sequencing = false
string	$localization = ""
string	$mastery_score_values = ""
int	$tries = 0
string	$api_adapter = 'API'
ILIAS DI UIServices	$ui
string	$rid = null
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Attributes
string	$api_func_prefix = 'LMS'
string	$lesson_mode = 'normal'
int	$style_id = 0
string	$auto_review = 'n'
int	$max_attempt = 0
int	$module_version = 1
int	$assigned_glossary = 0
bool	$session = false
bool	$no_menu = false
bool	$hide_navig = false
bool	$ie_force_render = false
bool	$fourth_edition = false
bool	$interactions = true
bool	$objectives = true
bool	$comments = true
bool	$time_from_lms = false
bool	$check_values = true
bool	$debug = false
bool	$auto_continue = false
bool	$auto_last_visited = true
bool	$auto_suspend = false
int	$open_mode = 0
int	$width = 950
int	$height = 650
int	$mastery_score = null
int	$id_setting = 0
int	$name_setting = 0
string	$sub_type = 'scorm'

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Detailed Description

Class ilObjSCORMLearningModule.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e $Id$

\

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

Constructor & Destructor Documentation

__construct()

ilObjSAHSLearningModule::__construct	(	int	$a_id = 0,
		bool	$a_call_by_reference = true
	)

Constructor.

Parameters

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

Reimplemented in ilObjSCORM2004LearningModule, and ilObjSCORMLearningModule.

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

    {
        global $DIC;
        $this->ui = $DIC->ui();
        $this->type = "sahs";
        parent::__construct($a_id, $a_call_by_reference);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

_getTries()

static ilObjSAHSLearningModule::_getTries ( int  $a_id )

static

obsolet?

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

                                               : int
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $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 (int) $lm_rec['question_tries'];
    }

References $DIC, $ilDB, and $lm_set.

_lookupSubType()

static ilObjSAHSLearningModule::_lookupSubType ( int  $a_obj_id )

static

lookup subtype id (scorm, )

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

                                                        : string
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $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);
        if ($obj_rec == null || $obj_rec["c_type"] == null) {
            return '';
        }
        return $obj_rec["c_type"];
    }

References $DIC, and $ilDB.

Referenced by ilLPStatusSCORM\_getStatusInfo(), ilObjSCORMLearningModuleGUI\applyAdoptSettings(), checkMasteryScoreValues(), ilLPStatusSCORM\determinePercentage(), ilSAHSPresentationGUI\executeCommand(), ilSAHSEditGUI\executeCommand(), ilLPCollectionSettingsTableGUI\fillRow(), ilTrQuery\getParticipantsForObject(), ilLPCollectionOfSCOs\getPossibleItems(), ilObjSAHSLearningModuleListGUI\getProperties(), ilScormLP\getValidModes(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjSCORMLearningModuleGUI\initPropertiesForm(), ilSCORMAdoptSettingsNodeRetrieval\isSelectableSource(), ilLPCollectionOfSCOs\itemsAreEqual(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilLPStatusSCORM\refreshStatus(), and ilSAHSPresentationGUI\setInfoTabs().

Here is the caller graph for this function:

adoptSettingsFrom()

ilObjSAHSLearningModule::adoptSettingsFrom

(

ilObjSAHSLearningModule

$source

)

Adopt compatible SCORM runtime/settings from another SCORM module.

Returns false if source and target are not compatible.

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

                                                                      : bool
    {
        if ($source->getId() === $this->getId()) {
            return false;
        }
 
        $sub_type = $this->getSubType();
        if ($sub_type !== "scorm" && $sub_type !== "scorm2004") {
            return false;
        }
 
        if ($source->getSubType() !== $sub_type) {
            return false;
        }
 
        $this->setOpenMode($source->getOpenMode());
        $this->setWidth($source->getWidth());
        $this->setHeight($source->getHeight());
        $this->setAuto_last_visited($source->getAuto_last_visited());
        $this->setDefaultLessonMode($source->getDefaultLessonMode());
        $this->setAutoReviewChar($source->getAutoReviewChar());
        $this->setMasteryScore($source->getMasteryScore());
        $this->setSession($source->getSession());
        $this->setInteractions($source->getInteractions());
        $this->setObjectives($source->getObjectives());
        $this->setTime_from_lms($source->getTime_from_lms());
        $this->setCheck_values($source->getCheck_values());
        $this->setAutoSuspend($source->getAutoSuspend());
        $this->setDebug($source->getDebug());
        $this->setIdSetting($source->getIdSetting());
        $this->setNameSetting($source->getNameSetting());
 
        if ($sub_type === "scorm") {
            $this->setAutoContinue($source->getAutoContinue());
            return true;
        }
 
        if ($sub_type === "scorm2004") {
            $this->setIe_force_render($source->getIe_force_render());
            $this->setNoMenu($source->getNoMenu());
            $this->setHideNavig($source->getHideNavig());
            $this->setFourth_edition($source->getFourth_Edition());
            $this->setSequencing($source->getSequencing());
            $this->setComments($source->getComments());
            return true;
        }
 
        return false;
    }

References $sub_type, getAuto_last_visited(), getAutoContinue(), getAutoReviewChar(), getAutoSuspend(), getCheck_values(), getComments(), getDebug(), getDefaultLessonMode(), getFourth_Edition(), getHeight(), getHideNavig(), ilObject\getId(), getIdSetting(), getIe_force_render(), getInteractions(), getMasteryScore(), getNameSetting(), getNoMenu(), getObjectives(), getOpenMode(), getSequencing(), getSession(), getSubType(), getTime_from_lms(), getWidth(), setAuto_last_visited(), setAutoContinue(), setAutoReviewChar(), setAutoSuspend(), setCheck_values(), setComments(), setDebug(), setDefaultLessonMode(), setFourth_edition(), setHeight(), setHideNavig(), setIdSetting(), setIe_force_render(), setInteractions(), setMasteryScore(), setNameSetting(), setNoMenu(), setObjectives(), setOpenMode(), setSequencing(), setSession(), setTime_from_lms(), and setWidth().

Here is the call graph for this function:

checkMasteryScoreValues()

ilObjSAHSLearningModule::checkMasteryScoreValues

(

)

check mastery_score / min_normalized_measure of SCOs (SCORM 1.2) / objectives (SCORM 2004)

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

                                             : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $s_result = "";
        $a_result = array();
        $type = self::_lookupSubType($this->getID());
 
        if ($type === "scorm2004") {
            $set = $ilDB->query("SELECT minnormalmeasure FROM cp_objective, cp_node" .
                " WHERE satisfiedbymeasure=1 AND minnormalmeasure is not null AND cp_objective.cp_node_id=cp_node.cp_node_id AND" .
                " slm_id = " . $ilDB->quote($this->getID(), "integer"));
            while ($rec = $ilDB->fetchAssoc($set)) {
                $tmpval = $rec["minnormalmeasure"] * 100;
                if (!in_array($tmpval, $a_result)) {
                    $a_result[] = $tmpval;
                }
            }
        } else {
            $set = $ilDB->query("SELECT masteryscore FROM sc_item,scorm_object" .
                " WHERE sc_item.masteryscore is not null AND sc_item.obj_id=scorm_object.obj_id AND" .
                " slm_id = " . $ilDB->quote($this->getID(), "integer"));
            while ($rec = $ilDB->fetchAssoc($set)) {
                if (!in_array($rec["masteryscore"], $a_result)) {
                    $a_result[] = $rec["masteryscore"];
                }
            }
        }
        $s_result = implode(", ", $a_result);
        $this->mastery_score_values = $s_result;
    }

References $DIC, $ilDB, ilObject\$type, and _lookupSubType().

Here is the call graph for this function:

create()

ilObjSAHSLearningModule::create

(

bool

$upload = false

)

create file based lm

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

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

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

Here is the call graph for this function:

createDataDirectory()

ilObjSAHSLearningModule::createDataDirectory

(

)

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

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

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

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

Referenced by create(), and extractContainerToDataDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

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

Returns

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

Reimplemented from ilObject.

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

                            : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilLog = ilLoggerFactory::getLogger('sahs');
 
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        // delete meta data of scorm content object
        $this->deleteMetaData();
 
        // delete content container resource (migrated modules)
        $this->removeContainerResource();
 
        // delete data directory
        ilFileUtils::delDir($this->getDataDirectory());
 
        // delete scorm learning module record
        $ilDB->manipulateF(
            'DELETE FROM sahs_lm WHERE id = %s',
            array('integer'),
            array($this->getId())
        );
 
        $ilLog->debug("SAHS Delete(SAHSLM), Subtype: " . $this->getSubType());
 
        if ($this->getSubType() === "scorm") {
            $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((int) $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->info("SAHS Delete(SAHSLM): " . $q_log);
 
        $ilDB->manipulateF(
            'DELETE FROM scorm_tracking WHERE obj_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        $q_log = "DELETE FROM sahs_user WHERE obj_id = " . $ilDB->quote($this->getId());
        $ilLog->info("SAHS Delete(SAHSLM): " . $q_log);
 
        $ilDB->manipulateF(
            'DELETE FROM sahs_user WHERE obj_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        // always call parent delete function at the end!!
        return true;
    }

References $DIC, $ilDB, $res, ilSCORMObject\_getInstance(), ilFileUtils\delDir(), ilObject\deleteMetaData(), getDataDirectory(), ilObject\getId(), ilLoggerFactory\getLogger(), getSubType(), and removeContainerResource().

Here is the call graph for this function:

extractContainerToDataDirectory()

ilObjSAHSLearningModule::extractContainerToDataDirectory

(

)

Extract the current container revision back onto disk at getDataDirectory().

Used to re-parse the manifest (cp_* tables) for a freshly cloned module. The caller must remove the directory afterwards.

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

                                                     : bool
    {
        $resource = $this->getResource();
        if ($resource === null) {
            return false;
        }
        $this->createDataDirectory();
        $options = (new UnzipOptions())
            ->withZipOutputPath($this->getDataDirectory())
            ->withOverwrite(true);
 
        return $this->getIrss()
            ->consume()
            ->containerZIP($resource->getIdentification())
            ->getZIP($options)
            ->extract();
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, createDataDirectory(), getDataDirectory(), getIrss(), and getResource().

Referenced by writeContentZip().

Here is the call graph for this function:

Here is the caller graph for this function:

getAffectiveLocalization()

static ilObjSAHSLearningModule::getAffectiveLocalization ( int  $a_id )

static

Get affective localization.

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

                                                              : string
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $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();
    }

References $DIC, $ilDB, $lm_set, ilObject\$lng, ilLanguage\getInstalledLanguages(), and ilLanguage\getLangKey().

Here is the call graph for this function:

getAPIAdapterName()

ilObjSAHSLearningModule::getAPIAdapterName

(

)

get api adapter name

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

                                       : string
    {
        return $this->api_adapter;
    }

References $api_adapter.

Referenced by update().

Here is the caller graph for this function:

getAPIFunctionsPrefix()

ilObjSAHSLearningModule::getAPIFunctionsPrefix

(

)

get api functions prefix

Returns

string

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

                                           : string
    {
        return $this->api_func_prefix;
    }

References $api_func_prefix.

Referenced by update().

Here is the caller graph for this function:

getApiStudentId()

ilObjSAHSLearningModule::getApiStudentId

(

)

Get cmi.core.student_id / cmi.learner_id for API.

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

                                     : string
    {
        global $DIC;
        $usr = $DIC->user();
        $idSetting = $this->getIdSetting();
        $studentId = (string) $usr->getId();
        if ($idSetting % 2 == 1) {
            $studentId = $usr->getLogin();
        }
        if ($idSetting > 3) {
            $studentId .= '_o_' . $this->getId();
        } elseif ($idSetting > 1) {
            $studentId .= '_r_' . $this->getRefId();
        }
        return $studentId;
    }

References $DIC, ilObject\getId(), getIdSetting(), and ilObject\getRefId().

Referenced by ilObjSCORMInitData\getIliasScormVars().

Here is the call graph for this function:

Here is the caller graph for this function:

getApiStudentName()

ilObjSAHSLearningModule::getApiStudentName

(

)

Get cmi.core.student_name / cmi.learner_name for API note: 'lastname, firstname' is required for SCORM 1.2; 9 = no name to hide student_name for external content.

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

                                       : string
    {
        global $DIC;
        $lng = $DIC->language();
        $usr = $DIC->user();
        $studentName = " ";
        switch ($this->getNameSetting()) {
            case 0:
                $studentName = $usr->getLastname() . ', ' . $usr->getFirstname();
                break;
            case 1:
                $studentName = $usr->getFirstname() . ' ' . $usr->getLastname();
                break;
            case 2:
                $studentName = $usr->getFullname();
                break;
            case 3:
                switch ($usr->getGender()) {
                    case 'f':
                        $studentName = $lng->txt('salutation_f') . ' ';
                        break;
 
                    case 'm':
                        $studentName = $lng->txt('salutation_m') . ' ';
                        break;
 
                    case 'n':
                        $studentName = '';//$lng->txt('salutation_n');
                        break;
 
                    default:
                        $studentName = $lng->txt('salutation') . ' ';
                }
                $studentName .= $usr->getLastname();
                break;
            case 4:
                $studentName = $usr->getFirstname();
                break;
        }
        return $studentName;
    }

References $DIC, ilObject\$lng, getNameSetting(), and ilLanguage\txt().

Referenced by ilObjSCORMInitData\getIliasScormVars().

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignedGlossary()

ilObjSAHSLearningModule::getAssignedGlossary

(

)

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

                                         : int
    {
        return $this->assigned_glossary;
    }

References $assigned_glossary.

Referenced by update().

Here is the caller graph for this function:

getAuto_last_visited()

ilObjSAHSLearningModule::getAuto_last_visited

(

)

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

                                          : bool
    {
        return $this->auto_last_visited;
    }

References $auto_last_visited.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getAutoContinue()

ilObjSAHSLearningModule::getAutoContinue

(

)

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

                                     : bool
    {
        return $this->auto_continue;
    }

References $auto_continue.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getAutoReview()

ilObjSAHSLearningModule::getAutoReview

(

)

get auto review as true/false for SCORM 1.2

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

                                   : bool
    {
        return ilUtil::yn2tf($this->auto_review);
    }

References ilUtil\yn2tf().

Referenced by ilObjSCORMInitData\getIliasScormVars().

Here is the call graph for this function:

Here is the caller graph for this function:

getAutoReviewChar()

ilObjSAHSLearningModule::getAutoReviewChar

(

)

get auto review as Char for SCORM 2004

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

                                       : string
    {
        return $this->auto_review;
    }

References $auto_review.

Referenced by adoptSettingsFrom(), and update().

Here is the caller graph for this function:

getAutoSuspend()

ilObjSAHSLearningModule::getAutoSuspend

(

)

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

                                    : bool
    {
        return $this->auto_suspend;
    }

References $auto_suspend.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getCacheDeactivated()

ilObjSAHSLearningModule::getCacheDeactivated

(

)

BrowserCacheDisabled for SCORM 2004 / ENABLE_JS_DEBUG.

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

                                         : bool
    {
        global $DIC;
        $ilSetting = $DIC->settings();
        $lm_set = new ilSetting("lm");
        return $lm_set->get("scormdebug_disable_cache") == "1";
    }

References $DIC, $ilSetting, and $lm_set.

getCheck_values()

ilObjSAHSLearningModule::getCheck_values

(

)

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

                                     : bool
    {
        return $this->check_values;
    }

References $check_values.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getComments()

ilObjSAHSLearningModule::getComments

(

)

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

                                 : bool
    {
        return $this->comments;
    }

References $comments.

Referenced by adoptSettingsFrom(), and update().

Here is the caller graph for this function:

getContainerBaseUri()

ilObjSAHSLearningModule::getContainerBaseUri

(

float

$valid_for_at_least_minutes = 480.0

)

Base URL of the content container, ending in the sub-request separator so the player can append relative paths (e.g.

"<base>/-/sco1/index.html"). Returns null for un-migrated modules; callers must then fall back to the web path of getDataDirectory().

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

                                                                                  : ?string
    {
        $resource = $this->getResource();
        if ($resource === null) {
            return null;
        }
        $uri = $this->getIrss()->consume()->containerURI(
            $resource->getIdentification(),
            '',
            $valid_for_at_least_minutes
        )->getURI();
        if ($uri === null) {
            return null;
        }
 
        // The player appends relative file paths to this base, so it must end
        // with the sub-request separator "/-/". new URI() strips the trailing
        // slash for an empty start file, leaving ".../-" — restore it, otherwise
        // requests miss the separator and the whole container ZIP is delivered.
        $base = (string) $uri;
        if (str_ends_with($base, '/-')) {
            $base .= '/';
        }
        return $base;
    }

References getIrss(), and getResource().

Referenced by ilObjSCORMInitData\getIliasScormVars().

Here is the call graph for this function:

Here is the caller graph for this function:

getCreditMode()

ilObjSAHSLearningModule::getCreditMode

(

)

get credit mode

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

                                   : string
    {
        $learningProgress = ilObjectLP::getInstance($this->getID());
        $currentMode = $learningProgress->getCurrentMode();
        if ($currentMode === ilLPObjSettings::LP_MODE_SCORM || $currentMode === ilLPObjSettings::LP_MODE_SCORM_PACKAGE) {
            return "credit";
        } else {
            return "no-credit";
        }
    }

References ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_SCORM, and ilLPObjSettings\LP_MODE_SCORM_PACKAGE.

Referenced by ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

getDataDirectory()

ilObjSAHSLearningModule::getDataDirectory

(

?string

$mode = "filesystem"

)

get data directory of lm

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

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

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

Referenced by ilObjSCORM2004LearningModule\convert_1_2_to_2004(), createDataDirectory(), delete(), extractContainerToDataDirectory(), ilObjSCORMInitData\getIliasScormVars(), moveDataDirectoryToContainer(), populateByDirectoy(), ilObjSCORM2004LearningModule\readObject(), ilObjSCORMLearningModule\readObject(), and writeContentZip().

Here is the call graph for this function:

Here is the caller graph for this function:

getDebug()

ilObjSAHSLearningModule::getDebug

(

)

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

                              : bool
    {
        return $this->debug;
    }

References $debug.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getDebugActivated()

ilObjSAHSLearningModule::getDebugActivated

(

)

debugActivated

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

                                       : bool
    {
        global $DIC;
        $ilSetting = $DIC->settings();
        $lm_set = new ilSetting("lm");
        return $lm_set->get("scormdebug_global_activate") === "1";
    }

References $DIC, $ilSetting, and $lm_set.

getDefaultLessonMode()

ilObjSAHSLearningModule::getDefaultLessonMode

(

)

get default lesson mode

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

                                          : string
    {
        global $DIC;
        if ($DIC->user()->getId() == 13) {
            return "browse";
        }
        return $this->lesson_mode;
    }

References $DIC, and $lesson_mode.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getDiskUsage()

ilObjSAHSLearningModule::getDiskUsage

(

)

Gets the disk usage of the object in bytes.

Returns

integer the disk usage in bytes

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

                                  : int
    {
        return ilObjSAHSLearningModuleAccess::_lookupDiskUsage($this->id);
    }

References ilObjSAHSLearningModuleAccess\_lookupDiskUsage().

Here is the call graph for this function:

getEditable()

ilObjSAHSLearningModule::getEditable

(

)

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

                                 : bool
    {
        return false;
    }

Referenced by create(), and update().

Here is the caller graph for this function:

getFourth_Edition()

ilObjSAHSLearningModule::getFourth_Edition

(

)

SCORM 2004 4th edition features.

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

                                       : bool
    {
        return $this->fourth_edition;
    }

References $fourth_edition.

Referenced by adoptSettingsFrom().

Here is the caller graph for this function:

getHeight()

ilObjSAHSLearningModule::getHeight

(

)

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

                               : int
    {
        return $this->height;
    }

References $height.

Referenced by adoptSettingsFrom(), getViewButton(), and update().

Here is the caller graph for this function:

getHideNavig()

ilObjSAHSLearningModule::getHideNavig

(

)

hide navigation tree

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

                                  : bool
    {
        return $this->hide_navig;
    }

References $hide_navig.

Referenced by adoptSettingsFrom(), and update().

Here is the caller graph for this function:

getIdSetting()

ilObjSAHSLearningModule::getIdSetting

(

)

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

                                  : int
    {
        return $this->id_setting;
    }

References $id_setting.

Referenced by adoptSettingsFrom(), getApiStudentId(), and update().

Here is the caller graph for this function:

getIe_force_render()

ilObjSAHSLearningModule::getIe_force_render

(

)

force Internet Explorer to render again after some Milliseconds - useful for learning Modules with a lot of iframes or frames and IE >=10

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

                                        : bool
    {
        return $this->ie_force_render;
    }

References $ie_force_render.

Referenced by adoptSettingsFrom(), and update().

Here is the caller graph for this function:

getInteractions()

ilObjSAHSLearningModule::getInteractions

(

)

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

                                     : bool
    {
        return $this->interactions;
    }

References $interactions.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getIrss()

ilObjSAHSLearningModule::getIrss ( )

protected

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

                                : IRSS
    {
        global $DIC;
        return $DIC->resourceStorage();
    }

References $DIC.

Referenced by extractContainerToDataDirectory(), getContainerBaseUri(), getManifestFromContainer(), getResource(), moveDataDirectoryToContainer(), removeContainerResource(), and replaceContainerFromZipPath().

Here is the caller graph for this function:

getLocalization()

ilObjSAHSLearningModule::getLocalization

(

)

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

                                     : string
    {
        return $this->localization;
    }

References $localization.

Referenced by create(), and update().

Here is the caller graph for this function:

getManifestFromContainer()

ilObjSAHSLearningModule::getManifestFromContainer

(

string

$manifest_file = 'imsmanifest.xml'

)

Read the imsmanifest.xml of the current container revision (migrated modules).

Returns null when the module is not migrated or the manifest is absent. Used to validate that a new package version matches the existing manifest structure (cp_* tables) before replacing the resource.

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

                                                                                       : ?string
    {
        $resource = $this->getResource();
        if ($resource === null) {
            return null;
        }
        $zip = $this->getIrss()->consume()->containerZIP($resource->getIdentification())->getZIP();
        $files = iterator_to_array($zip->getFiles(), false);
        foreach ($zip->getFileStreams() as $i => $stream) {
            if (isset($files[$i]) && basename((string) $files[$i]) === $manifest_file) {
                try {
                    return $stream->getContents();
                } catch (\Throwable) {
                    // Keep method non-throwing; caller handles missing/unreadable manifest.
                    return null;
                }
            }
        }
        return null;
    }

References $files, getIrss(), and getResource().

Here is the call graph for this function:

getMasteryScore()

ilObjSAHSLearningModule::getMasteryScore

(

)

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

                                     : ?int
    {
        return $this->mastery_score;
    }

References $mastery_score.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getMasteryScoreValues()

ilObjSAHSLearningModule::getMasteryScoreValues

(

)

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

                                           : string
    {
        return $this->mastery_score_values;
    }

References $mastery_score_values.

getMaxAttempt()

ilObjSAHSLearningModule::getMaxAttempt

(

)

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

                                   : int
    {
        return $this->max_attempt;
    }

References $max_attempt.

Referenced by update().

Here is the caller graph for this function:

getMaxPoints()

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.

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

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

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

Here is the call graph for this function:

getModuleVersion()

ilObjSAHSLearningModule::getModuleVersion

(

)

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

                                      : int
    {
        return $this->module_version;
    }

References $module_version.

Referenced by update().

Here is the caller graph for this function:

getNameSetting()

ilObjSAHSLearningModule::getNameSetting

(

)

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

                                    : int
    {
        return $this->name_setting;
    }

References $name_setting.

Referenced by adoptSettingsFrom(), getApiStudentName(), and update().

Here is the caller graph for this function:

getNoMenu()

ilObjSAHSLearningModule::getNoMenu

(

)

disable menu

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

                               : bool
    {
        return $this->no_menu;
    }

References $no_menu.

Referenced by adoptSettingsFrom(), and update().

Here is the caller graph for this function:

getObjectives()

ilObjSAHSLearningModule::getObjectives

(

)

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

                                   : bool
    {
        return $this->objectives;
    }

References $objectives.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getOpenMode()

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 944 of file class.ilObjSAHSLearningModule.php.

                                 : int
    {
        return $this->open_mode;
    }

References $open_mode.

Referenced by adoptSettingsFrom(), getViewButton(), and update().

Here is the caller graph for this function:

getPointsInPercent()

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 1402 of file class.ilObjSAHSLearningModule.php.

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

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

Here is the call graph for this function:

getResource()

ilObjSAHSLearningModule::getResource

(

)

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

                                 : ?StorableContainerResource
    {
        $rid = $this->getRID();
        if ($rid === null || $rid === '' || $rid === '-') {
            return null;
        }
        $identification = $this->getIrss()->manage()->find($rid);
        if ($identification === null) {
            return null;
        }
        $resource = $this->getIrss()->manage()->getResource($identification);
        return $resource instanceof StorableContainerResource ? $resource : null;
    }

References $rid, getIrss(), and getRID().

Referenced by extractContainerToDataDirectory(), getContainerBaseUri(), getManifestFromContainer(), hasContainerResource(), removeContainerResource(), and replaceContainerFromZipPath().

Here is the call graph for this function:

Here is the caller graph for this function:

getRID()

ilObjSAHSLearningModule::getRID

(

)

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

                            : ?string
    {
        return $this->rid;
    }

References $rid.

Referenced by getResource(), and update().

Here is the caller graph for this function:

getScormModulesForGlossary()

static ilObjSAHSLearningModule::getScormModulesForGlossary ( int  $a_glo_id )

static

Get SCORM modules that assign a certain glossary.

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

                                                                    : array
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $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((int) $rec["id"])) {
                $sms[] = $rec["id"];
            }
        }
        return $sms;
    }

References $DIC, $ilDB, and ilObject\_hasUntrashedReference().

Here is the call graph for this function:

getSequencing()

ilObjSAHSLearningModule::getSequencing

(

)

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

                                   : bool
    {
        return $this->sequencing;
    }

References $sequencing.

Referenced by adoptSettingsFrom(), and update().

Here is the caller graph for this function:

getSession()

ilObjSAHSLearningModule::getSession

(

)

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

                                : bool
    {
        return $this->session;
    }

References $session.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getSessionDeactivated()

ilObjSAHSLearningModule::getSessionDeactivated

(

)

sessionDisabled for SCORM 2004

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

                                           : bool
    {
        global $DIC;
        $ilSetting = $DIC->settings();
        $lm_set = new ilSetting("lm");
        return $lm_set->get("scorm_without_session") == "1";
    }

References $DIC, $ilSetting, and $lm_set.

Referenced by ilObjSCORMInitData\getIliasScormVars().

Here is the caller graph for this function:

getStyleSheetId()

ilObjSAHSLearningModule::getStyleSheetId

(

)

get ID of assigned style sheet object

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

                                     : int
    {
        return $this->style_id;
    }

References $style_id.

Referenced by read(), and update().

Here is the caller graph for this function:

getSubType()

ilObjSAHSLearningModule::getSubType

(

)

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

                                : string
    {
        return $this->sub_type;
    }

References $sub_type.

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

Here is the caller graph for this function:

getTime_from_lms()

ilObjSAHSLearningModule::getTime_from_lms

(

)

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

                                      : bool
    {
        return $this->time_from_lms;
    }

References $time_from_lms.

Referenced by adoptSettingsFrom(), ilObjSCORMInitData\getIliasScormVars(), and update().

Here is the caller graph for this function:

getTries()

ilObjSAHSLearningModule::getTries

(

)

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

                              : int
    {
        return $this->tries;
    }

References $tries.

Referenced by update().

Here is the caller graph for this function:

getViewButton()

ilObjSAHSLearningModule::getViewButton

(

)

get button for view

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

                                   : \ILIAS\UI\Component\Link\Standard
    {
        global $DIC;
 
        $setUrl = "ilias.php?baseClass=ilSAHSPresentationGUI&ref_id=" . $this->getRefID();
        // $setUrl = $this->getLinkTargetByClass("ilsahspresentationgui", "")."&ref_id=".$this->getRefID();
 
        $setTarget = "ilContObj" . $this->getId();
 
        $om = $this->getOpenMode();
        $width = $this->getWidth();
        $height = $this->getHeight();
 
        if (($om == 5 || $om == 1) && $width > 0 && $height > 0) {
            $om++;
        }
 
        if ($om != 0) {
            $setUrl = "javascript:void(0); onclick=startSAHS('" . $setUrl . "','ilContObj" . $this->getId() . "'," . $om . "," . $width . "," . $height . ");";
            $setTarget = "";
        }
 
        $button = $this->ui->factory()->link()->standard(
            $DIC->language()->txt("start_lm"),
            $setUrl
        );
 
        $button = $button->withOnLoadCode(static fn($id): string => "
            document.getElementById('$id').setAttribute('target', '$setTarget');
            document.getElementById('$id').removeAttribute('rel');
        ");
 
        return $button;
    }

References $DIC, $height, $id, $width, getHeight(), ilObject\getId(), getOpenMode(), getWidth(), and ILIAS\Repository\ui().

Here is the call graph for this function:

getWidth()

ilObjSAHSLearningModule::getWidth

(

)

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

                              : int
    {
        return $this->width;
    }

References $width.

Referenced by adoptSettingsFrom(), getViewButton(), and update().

Here is the caller graph for this function:

hasContainerResource()

ilObjSAHSLearningModule::hasContainerResource

(

)

True when the module's content lives in a Resource Storage container.

The rid sentinel '-' marks a module whose migration failed, '' an un-migrated module; both fall back to the on-disk data directory.

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

                                          : bool
    {
        return $this->getResource() !== null;
    }

References getResource().

Referenced by writeContentZip().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupAssignedGlossary()

static ilObjSAHSLearningModule::lookupAssignedGlossary ( int  $a_slm_id )

static

Get SCORM modules that assign a certain glossary.

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

                                                                : int
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT DISTINCT glossary FROM sahs_lm WHERE " .
            " id = " . $ilDB->quote($a_slm_id, "integer"));
        $rec = $ilDB->fetchAssoc($set);
        $glo_id = $rec["glossary"];
        if (ilObject::_lookupType($glo_id) === "glo") {
            return $glo_id;
        }
        return 0;
    }

References $DIC, $ilDB, and ilObject\_lookupType().

Here is the call graph for this function:

moveDataDirectoryToContainer()

ilObjSAHSLearningModule::moveDataDirectoryToContainer

(

)

Move the on-disk data directory into a new container resource and remove the directory.

Call AFTER readObject() — manifest parsing reads the files from disk. The zip keeps the directory structure but strips the top lm_<id> folder, so files end up at the container root.

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

                                                  : bool
    {
        $dir = $this->getDataDirectory();
        if (!is_dir($dir)) {
            return false;
        }
        $zip = new Zip(
            (new ZipOptions())
                ->withDirectoryHandling(ZipDirectoryHandling::KEEP_STRUCTURE)
        );
        $zip->addDirectory($dir);
        try {
            $zip_stream = $zip->get();
        } catch (\Throwable) {
            $zip->destroy();
            return false;
        }
        $rid = $this->getIrss()->manageContainer()->containerFromStream(
            $zip_stream,
            new ilSAHSStakeholder(),
            $this->getTitle()
        );
        $zip->destroy();
 
        $this->setRID($rid->serialize());
        $this->update();
 
        ilFileUtils::delDir($dir);
        return true;
    }

References $rid, ilFileUtils\delDir(), getDataDirectory(), getIrss(), ilObject\getTitle(), setRID(), and update().

Here is the call graph for this function:

populateByDirectoy()

ilObjSAHSLearningModule::populateByDirectoy	(	string	$a_dir,
		string	$a_filename = ""
	)

Populate by directory.

Add a filename to do a special check for ILIAS SCORM export files. If the corresponding directory is found within the passed directory path (i.e. "htlm_<id>") this subdirectory is used instead.

Exceptions

ILIAS\Filesystem\Exception\DirectoryNotFoundException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

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

                                                                              : void
    {
        /*preg_match("/.*sahs_([0-9]*)\.zip/", $a_filename, $match);
        if (is_dir($a_dir."/sahs_".$match[1]))
        {
            $a_dir = $a_dir."/sahs_".$match[1];
        }*/
        ilFileUtils::rCopy($a_dir, $this->getDataDirectory());
        ilFileUtils::renameExecutables($this->getDataDirectory());
    }

References getDataDirectory(), ilFileUtils\rCopy(), and ilFileUtils\renameExecutables().

Here is the call graph for this function:

read()

ilObjSAHSLearningModule::read

(

)

read object

Exceptions

ilObjectNotFoundException
ilObjectTypeMismatchException

Reimplemented from ilObject.

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

                          : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        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->setAutoReviewChar((string) $lm_rec["auto_review"]);
            $this->setAPIAdapterName((string) $lm_rec["api_adapter"]);
            $this->setDefaultLessonMode((string) $lm_rec["default_lesson_mode"]);
            $this->setAPIFunctionsPrefix((string) $lm_rec["api_func_prefix"]);
            $this->setSubType((string) $lm_rec["c_type"]);
            //            $this->setEditable(false);
            $this->setStyleSheetId((int) $lm_rec["stylesheet"]);
            $this->setMaxAttempt((int) $lm_rec["max_attempt"]);
            $this->setModuleVersion((int) $lm_rec["module_version"]);
            $this->setAssignedGlossary((int) $lm_rec["glossary"]);
            $this->setTries((int) $lm_rec["question_tries"]);
            $this->setLocalization((string) $lm_rec["localization"]);
            $this->setSession(ilUtil::yn2tf($lm_rec["unlimited_session"]));
            $this->setNoMenu(ilUtil::yn2tf($lm_rec["no_menu"] ?? "n"));
            $this->setHideNavig(ilUtil::yn2tf($lm_rec["hide_navig"]));
            $this->setFourth_edition(ilUtil::yn2tf($lm_rec["fourth_edition"]));
            $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(bool $lm_rec["seq_exp_mode"]);
            $this->setOpenMode((int) $lm_rec["open_mode"]);
            $this->setWidth((int) $lm_rec["width"]);
            $this->setHeight((int) $lm_rec["height"]);
            $this->setAutoContinue(ilUtil::yn2tf($lm_rec["auto_continue"]));
            $this->setAuto_last_visited(ilUtil::yn2tf($lm_rec["auto_last_visited"]));
            $this->setCheck_values(ilUtil::yn2tf($lm_rec["check_values"]));
            //            $this->setOfflineMode(ilUtil::yn2tf($lm_rec["offline_mode"]));
            $this->setAutoSuspend(ilUtil::yn2tf($lm_rec["auto_suspend"]));
            $this->setIe_force_render(ilUtil::yn2tf($lm_rec["ie_force_render"]));
            if ($lm_rec["mastery_score"] != null) {
                $this->setMasteryScore((int) $lm_rec["mastery_score"]);
            }
            $this->setIdSetting((int) $lm_rec["id_setting"]);
            $this->setNameSetting((int) $lm_rec["name_setting"]);
            $this->setRID((string) ($lm_rec["rid"] ?? ''));
            if (ilObject::_lookupType($this->getStyleSheetId()) !== "sty") {
                $this->setStyleSheetId(0);
            }
        }
    }

References $DIC, $ilDB, $lm_set, ilObject\_lookupType(), ilObject\getId(), getStyleSheetId(), setAPIAdapterName(), setAPIFunctionsPrefix(), setAssignedGlossary(), setAuto_last_visited(), setAutoContinue(), setAutoReviewChar(), setAutoSuspend(), setCheck_values(), setComments(), setDebug(), setDefaultLessonMode(), setFourth_edition(), setHeight(), setHideNavig(), setIdSetting(), setIe_force_render(), setInteractions(), setLocalization(), setMasteryScore(), setMaxAttempt(), setModuleVersion(), setNameSetting(), setNoMenu(), setObjectives(), setOpenMode(), setRID(), setSequencing(), setSession(), setStyleSheetId(), setSubType(), setTime_from_lms(), setTries(), setWidth(), and ilUtil\yn2tf().

Here is the call graph for this function:

removeContainerResource()

ilObjSAHSLearningModule::removeContainerResource

(

)

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

                                             : void
    {
        $resource = $this->getResource();
        if ($resource === null) {
            return;
        }
        $this->getIrss()->manage()->remove(
            $resource->getIdentification(),
            new ilSAHSStakeholder()
        );
        $this->setRID('');
    }

References getIrss(), getResource(), and setRID().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

replaceContainerFromZipPath()

ilObjSAHSLearningModule::replaceContainerFromZipPath	(	string	$absolute_zip_path,
		?string	$revision_title = null
	)

Replace the content of the module's container resource with a new ZIP as a new revision (migrated modules only).

Returns false when the module is not migrated.

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

                                                                                                          : bool
    {
        $resource = $this->getResource();
        if ($resource === null) {
            return false;
        }
        $handle = fopen($absolute_zip_path, 'rb');
        if ($handle === false) {
            return false;
        }
        $this->getIrss()->manage()->appendNewRevisionFromStream(
            $resource->getIdentification(),
            FilesystemStreams::ofResource($handle),
            new ilSAHSStakeholder(),
            $revision_title ?? basename($absolute_zip_path)
        );
        return true;
    }

References getIrss(), and getResource().

Here is the call graph for this function:

setAPIAdapterName()

ilObjSAHSLearningModule::setAPIAdapterName

(

string

$a_api

)

set api adapter name

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

                                                    : void
    {
        $this->api_adapter = $a_api;
    }

Referenced by read().

Here is the caller graph for this function:

setAPIFunctionsPrefix()

ilObjSAHSLearningModule::setAPIFunctionsPrefix

(

string

$a_prefix

)

set api functions prefix

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

                                                           : void
    {
        $this->api_func_prefix = $a_prefix;
    }

Referenced by read().

Here is the caller graph for this function:

setAssignedGlossary()

ilObjSAHSLearningModule::setAssignedGlossary

(

int

$a_assigned_glossary

)

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

                                                                 : void
    {
        $this->assigned_glossary = $a_assigned_glossary;
    }

Referenced by read().

Here is the caller graph for this function:

setAuto_last_visited()

ilObjSAHSLearningModule::setAuto_last_visited

(

bool

$a_auto_last_visited

)

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

                                                                   : void
    {
        $this->auto_last_visited = $a_auto_last_visited;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setAutoContinue()

ilObjSAHSLearningModule::setAutoContinue

(

bool

$a_auto_continue

)

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

                                                          : void
    {
        $this->auto_continue = $a_auto_continue;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setAutoReview()

ilObjSAHSLearningModule::setAutoReview

(

bool

$a_auto_review

)

set auto review as true/false for SCORM 1.2

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

                                                      : void
    {
        $this->auto_review = ilUtil::tf2yn($a_auto_review);
    }

References ilUtil\tf2yn().

Here is the call graph for this function:

setAutoReviewChar()

ilObjSAHSLearningModule::setAutoReviewChar

(

?string

$a_auto_review

)

set auto review as Char for SCORM 2004

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

                                                             : void
    {
        if ($a_auto_review == null) {
            $this->auto_review = 'n';
        } else {
            $this->auto_review = $a_auto_review;
        }
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setAutoSuspend()

ilObjSAHSLearningModule::setAutoSuspend

(

bool

$a_auto_suspend

)

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

                                                        : void
    {
        $this->auto_suspend = $a_auto_suspend;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setCheck_values()

ilObjSAHSLearningModule::setCheck_values

(

bool

$a_check_values

)

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

                                                         : void
    {
        $this->check_values = $a_check_values;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setComments()

ilObjSAHSLearningModule::setComments

(

bool

$a_comments

)

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

                                                 : void
    {
        $this->comments = $a_comments;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setDebug()

ilObjSAHSLearningModule::setDebug

(

bool

$a_debug

)

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

                                           : void
    {
        $this->debug = $a_debug;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setDefaultLessonMode()

ilObjSAHSLearningModule::setDefaultLessonMode

(

string

$a_lesson_mode

)

set default lesson mode

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

                                                               : void
    {
        $this->lesson_mode = $a_lesson_mode;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setFourth_edition()

ilObjSAHSLearningModule::setFourth_edition

(

bool

$a_fourth_edition

)

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

                                                             : void
    {
        $this->fourth_edition = $a_fourth_edition;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setHeight()

ilObjSAHSLearningModule::setHeight

(

int

$a_height

)

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

                                            : void
    {
        $this->height = $a_height;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setHideNavig()

ilObjSAHSLearningModule::setHideNavig

(

bool

$a_hide_navig

)

disable menu

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

                                                    : void
    {
        $this->hide_navig = $a_hide_navig;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setIdSetting()

ilObjSAHSLearningModule::setIdSetting

(

int

$a_id_setting

)

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

                                                   : void
    {
        $this->id_setting = $a_id_setting;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setIe_force_render()

ilObjSAHSLearningModule::setIe_force_render

(

bool

$a_ie_force_render

)

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

                                                               : void
    {
        $this->ie_force_render = $a_ie_force_render;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setInteractions()

ilObjSAHSLearningModule::setInteractions

(

bool

$a_interactions

)

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

                                                         : void
    {
        $this->interactions = $a_interactions;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setLocalization()

ilObjSAHSLearningModule::setLocalization

(

string

$a_val

)

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

                                                  : void
    {
        $this->localization = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

setMasteryScore()

ilObjSAHSLearningModule::setMasteryScore

(

?int

$a_mastery_score

)

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

                                                          : void
    {
        $this->mastery_score = $a_mastery_score;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setMaxAttempt()

ilObjSAHSLearningModule::setMaxAttempt

(

int

$a_max_attempt

)

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

                                                     : void
    {
        $this->max_attempt = $a_max_attempt;
    }

Referenced by read().

Here is the caller graph for this function:

setModuleVersion()

ilObjSAHSLearningModule::setModuleVersion

(

int

$a_module_version

)

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

                                                           : void
    {
        $this->module_version = $a_module_version;
    }

Referenced by read().

Here is the caller graph for this function:

setNameSetting()

ilObjSAHSLearningModule::setNameSetting

(

int

$a_name_setting

)

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

                                                       : void
    {
        $this->name_setting = $a_name_setting;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setNoMenu()

ilObjSAHSLearningModule::setNoMenu

(

bool

$a_no_menu

)

disable menu

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

                                              : void
    {
        $this->no_menu = $a_no_menu;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setObjectives()

ilObjSAHSLearningModule::setObjectives

(

bool

$a_objectives

)

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

                                                     : void
    {
        $this->objectives = $a_objectives;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setOpenMode()

ilObjSAHSLearningModule::setOpenMode

(

int

$a_open_mode

)

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

                                                 : void
    {
        $this->open_mode = $a_open_mode;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setRID()

ilObjSAHSLearningModule::setRID

(

?string

$rid

)

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

                                        : void
    {
        $this->rid = $rid;
    }

References $rid.

Referenced by moveDataDirectoryToContainer(), read(), and removeContainerResource().

Here is the caller graph for this function:

setSequencing()

ilObjSAHSLearningModule::setSequencing

(

bool

$a_sequencing

)

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

                                                     : void
    {
        $this->sequencing = $a_sequencing;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setSession()

ilObjSAHSLearningModule::setSession

(

bool

$a_session

)

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

                                               : void
    {
        $this->session = $a_session;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setStyleSheetId()

ilObjSAHSLearningModule::setStyleSheetId

(

int

$a_style_id

)

set ID of assigned style sheet object

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

                                                    : void
    {
        $this->style_id = $a_style_id;
    }

Referenced by read().

Here is the caller graph for this function:

setSubType()

ilObjSAHSLearningModule::setSubType

(

string

$a_sub_type

)

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

                                                  : void
    {
        $this->sub_type = $a_sub_type;
    }

Referenced by read().

Here is the caller graph for this function:

setTime_from_lms()

ilObjSAHSLearningModule::setTime_from_lms

(

bool

$a_time_from_lms

)

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

                                                           : void
    {
        $this->time_from_lms = $a_time_from_lms;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

setTries()

ilObjSAHSLearningModule::setTries

(

int

$a_tries

)

Set default tries for questions.

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

                                          : void
    {
        $this->tries = $a_tries;
    }

Referenced by read().

Here is the caller graph for this function:

setWidth()

ilObjSAHSLearningModule::setWidth

(

int

$a_width

)

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

                                          : void
    {
        $this->width = $a_width;
    }

Referenced by adoptSettingsFrom(), and read().

Here is the caller graph for this function:

update()

ilObjSAHSLearningModule::update

(

)

Reimplemented from ilObject.

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

                            : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $this->updateMetaData();
        parent::update();
 
        $statement = $ilDB->manipulateF(
            '
            UPDATE sahs_lm  
            SET 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,
                fourth_edition =%s,
                sequencing = %s,
                interactions = %s,
                objectives = %s,
                comments = %s,
                time_from_lms = %s,
                debug = %s,
                localization = %s,
                seq_exp_mode = %s,
                open_mode = %s,
                width = %s,
                height = %s,
                auto_continue = %s,
                auto_last_visited = %s,
                check_values = %s,
                auto_suspend = %s,
                ie_force_render = %s,
                mastery_score = %s,
                id_setting = %s,
                name_setting = %s,
                rid = %s
            WHERE id = %s',
            array(      'text',
                'text',
                'text',
                'text',
                'text',
                'integer',
                'integer',
                'integer',
                'integer',
                'text',
                'integer',
                'integer',
                'text',
                'text',
                'text',
                'text',
                'text',
                'text',
                'text',
                'text',
                'text',
                'text',
                'text',
                'integer',
                'integer',
                'integer',
                'integer',
                'text',
                'text',
                'text',
                'text',
                'text',
                'integer',
                'integer',
                'integer',
                'text',
                'integer'
                ),
            array(      $this->getAPIAdapterName(),
                $this->getAPIFunctionsPrefix(),
                $this->getAutoReviewChar(),
                $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->getFourth_edition()),
                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(),
                0,//$this->getSequencingExpertMode(),
                $this->getOpenMode(),
                $this->getWidth(),
                $this->getHeight(),
                ilUtil::tf2yn($this->getAutoContinue()),
                ilUtil::tf2yn($this->getAuto_last_visited()),
                ilUtil::tf2yn($this->getCheck_values()),
                ilUtil::tf2yn($this->getAutoSuspend()),
                ilUtil::tf2yn($this->getIe_force_render()),
                $this->getMasteryScore(),
                $this->getIdSetting(),
                $this->getNameSetting(),
                $this->getRID() ?? '',
                $this->getId())
        );
 
        return true;
    }

References $DIC, $ilDB, getAPIAdapterName(), getAPIFunctionsPrefix(), getAssignedGlossary(), getAuto_last_visited(), getAutoContinue(), getAutoReviewChar(), getAutoSuspend(), getCheck_values(), getComments(), getCreditMode(), getDebug(), getDefaultLessonMode(), getEditable(), getHeight(), getHideNavig(), ilObject\getId(), getIdSetting(), getIe_force_render(), getInteractions(), getLocalization(), getMasteryScore(), getMaxAttempt(), getModuleVersion(), getNameSetting(), getNoMenu(), getObjectives(), getOpenMode(), getRID(), getSequencing(), getSession(), getStyleSheetId(), getSubType(), getTime_from_lms(), getTries(), getWidth(), ilUtil\tf2yn(), and ilObject\updateMetaData().

Referenced by moveDataDirectoryToContainer().

Here is the call graph for this function:

Here is the caller graph for this function:

writeContentZip()

ilObjSAHSLearningModule::writeContentZip

(

string

$target_zip_path

)

Write the module content to $target_zip_path as a zip without the lm_<id> top directory (export "content.zip").

Sources from the container for migrated modules, otherwise from the on-disk data directory.

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

                                                            : void
    {
        global $DIC;
        $cleanup = false;
        if ($this->hasContainerResource()) {
            $this->extractContainerToDataDirectory();
            $cleanup = true;
        }
 
        $DIC->legacyArchives()->zip($this->getDataDirectory(), $target_zip_path, false);
 
        if ($cleanup) {
            ilFileUtils::delDir($this->getDataDirectory());
        }
    }

References $DIC, ilFileUtils\delDir(), extractContainerToDataDirectory(), getDataDirectory(), and hasContainerResource().

Here is the call graph for this function:

Field Documentation

$api_adapter

string ilObjSAHSLearningModule::$api_adapter = 'API'

protected

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

Referenced by getAPIAdapterName().

$api_func_prefix

string ilObjSAHSLearningModule::$api_func_prefix = 'LMS'

private

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

Referenced by getAPIFunctionsPrefix().

$assigned_glossary

int ilObjSAHSLearningModule::$assigned_glossary = 0

private

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

Referenced by getAssignedGlossary().

$auto_continue

bool ilObjSAHSLearningModule::$auto_continue = false

private

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

Referenced by getAutoContinue().

$auto_last_visited

bool ilObjSAHSLearningModule::$auto_last_visited = true

private

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

Referenced by getAuto_last_visited().

$auto_review

string ilObjSAHSLearningModule::$auto_review = 'n'

private

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

Referenced by getAutoReviewChar().

$auto_suspend

bool ilObjSAHSLearningModule::$auto_suspend = false

private

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

Referenced by getAutoSuspend().

$check_values

bool ilObjSAHSLearningModule::$check_values = true

private

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

Referenced by getCheck_values().

$comments

bool ilObjSAHSLearningModule::$comments = true

private

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

Referenced by getComments().

$debug

bool ilObjSAHSLearningModule::$debug = false

private

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

Referenced by getDebug().

$fourth_edition

bool ilObjSAHSLearningModule::$fourth_edition = false

private

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

Referenced by getFourth_Edition().

$height

int ilObjSAHSLearningModule::$height = 650

private

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

Referenced by getHeight(), and getViewButton().

$hide_navig

bool ilObjSAHSLearningModule::$hide_navig = false

private

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

Referenced by getHideNavig().

$id_setting

int ilObjSAHSLearningModule::$id_setting = 0

private

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

Referenced by getIdSetting().

$ie_force_render

bool ilObjSAHSLearningModule::$ie_force_render = false

private

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

Referenced by getIe_force_render().

$interactions

bool ilObjSAHSLearningModule::$interactions = true

private

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

Referenced by getInteractions().

$lesson_mode

string ilObjSAHSLearningModule::$lesson_mode = 'normal'

private

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

Referenced by getDefaultLessonMode().

$localization

string ilObjSAHSLearningModule::$localization = ""

protected

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

Referenced by getLocalization().

$mastery_score

int ilObjSAHSLearningModule::$mastery_score = null

private

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

Referenced by getMasteryScore().

$mastery_score_values

string ilObjSAHSLearningModule::$mastery_score_values = ""

protected

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

Referenced by getMasteryScoreValues().

$max_attempt

int ilObjSAHSLearningModule::$max_attempt = 0

private

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

Referenced by getMaxAttempt().

$module_version

int ilObjSAHSLearningModule::$module_version = 1

private

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

Referenced by getModuleVersion().

$name_setting

int ilObjSAHSLearningModule::$name_setting = 0

private

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

Referenced by getNameSetting().

$no_menu

bool ilObjSAHSLearningModule::$no_menu = false

private

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

Referenced by getNoMenu().

$objectives

bool ilObjSAHSLearningModule::$objectives = true

private

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

Referenced by getObjectives().

$open_mode

int ilObjSAHSLearningModule::$open_mode = 0

private

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

Referenced by getOpenMode().

$rid

string ilObjSAHSLearningModule::$rid = null

protected

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

Referenced by getResource(), getRID(), moveDataDirectoryToContainer(), and setRID().

$sequencing

bool ilObjSAHSLearningModule::$sequencing = false

protected

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

Referenced by getSequencing().

$session

bool ilObjSAHSLearningModule::$session = false

private

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

Referenced by getSession().

$style_id

int ilObjSAHSLearningModule::$style_id = 0

private

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

Referenced by getStyleSheetId().

$sub_type

string ilObjSAHSLearningModule::$sub_type = 'scorm'

private

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

Referenced by adoptSettingsFrom(), and getSubType().

$time_from_lms

bool ilObjSAHSLearningModule::$time_from_lms = false

private

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

Referenced by getTime_from_lms().

$tries

int ilObjSAHSLearningModule::$tries = 0

protected

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

Referenced by getTries().

$ui

ILIAS DI UIServices ilObjSAHSLearningModule::$ui

protected

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

$width

int ilObjSAHSLearningModule::$width = 950

private

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

Referenced by getViewButton(), and getWidth().

---

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

• components/ILIAS/ScormAicc/classes/class.ilObjSAHSLearningModule.php