SCORM Item. More...

Inheritance diagram for ilSCORMItem:

Collaboration diagram for ilSCORMItem:

Public Member Functions
	__construct (int $a_id=0)

	getImportId ()

	setImportId (string $a_import_id)

	getIdentifierRef ()

	setIdentifierRef (string $a_id_ref)

	getVisible ()

	setVisible (bool $a_visible)

	getParameters ()

	setParameters (?string $a_par)

	getPrereqType ()

	setPrereqType (?string $a_p_type)

	getPrerequisites ()

	setPrerequisites (?string $a_pre)

	getMaxTimeAllowed ()

	setMaxTimeAllowed (?string $a_max)

	getTimeLimitAction ()

	setTimeLimitAction (?string $a_lim_act)

	getDataFromLms ()

	setDataFromLms (?string $a_data)

	getMasteryScore ()

	setMasteryScore (?string $a_score)

	read ()

	create ()
	Create database record for SCORM object. More...

	update ()
	Updates database record for SCORM object. More...

	getTrackingDataOfUser (int $a_user_id=0)
	get tracking data of specified or current user More...

	delete ()

	insertTrackData (string $a_lval, string $a_rval, int $a_obj_id)

Public Member Functions inherited from ilSCORMObject
	__construct (int $a_id=0)
	Constructor. More...

	getId ()

	setId (int $a_id)

	getType ()

	setType (?string $a_type)

	getTitle ()

	setTitle (string $a_title)

	getSLMId ()

	setSLMId (int $a_slm_id)

	read ()

	create ()
	Create database record for SCORM object. More...

	update ()
	Updates database record for SCORM object. More...

	delete ()

Static Public Member Functions
static	_lookupTrackingDataOfUser (int $a_item_id, int $a_user_id=0, int $a_obj_id=0)

static	_getItems (int $a_obj_id)

static	_lookupTitle (int $a_obj_id)

Static Public Member Functions inherited from ilSCORMObject
static	_lookupPresentableItems (int $a_slm_id)
	Count number of presentable SCOs/Assets of SCORM learning module. More...

static &	_getInstance (int $a_id, int $a_slm_id)

Data Fields
string	$import_id

string	$identifierref

bool	$isvisible = true

string	$parameters = null

string	$prereq_type = null

string	$prerequisites = null

string	$maxtimeallowed = null

string	$timelimitaction = null

string	$datafromlms = null

string	$masteryscore = null

Data Fields inherited from ilSCORMObject
int	$id

string	$title = ""

string	$type = null

int	$slm_id

Detailed Description

SCORM Item.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

\

Definition at line 29 of file class.ilSCORMItem.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCORMItem::__construct ( int $a_id = 0 )

Parameters

int $a_id Object ID

Reimplemented from ilSCORMObject.

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

    {
        parent::__construct($a_id);
        $this->setType("sit");
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ilSCORMObject\setType().

Here is the call graph for this function:

Member Function Documentation

◆ _getItems()

static ilSCORMItem::_getItems ( int $a_obj_id )

static

Returns: int[]

Definition at line 330 of file class.ilSCORMItem.php.

                                                   : array
    {
        global $DIC;
        $ilDB = $DIC->database();
        $item_ids = [];
 
        $res = $ilDB->queryF(
            '
                        SELECT obj_id FROM scorm_object 
                        WHERE slm_id = %s
                        AND c_type = %s',
            array('integer', 'text'),
            array($a_obj_id, 'sit')
        );
        while ($row = $ilDB->fetchObject($res)) {
            $item_ids[] = $row->obj_id;
        }
        return $item_ids;
    }

References $DIC, $ilDB, and $res.

◆ _lookupTitle()

static ilSCORMItem::_lookupTitle ( int $a_obj_id )

static

Definition at line 350 of file class.ilSCORMItem.php.

                                                      : string
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $res = $ilDB->queryF(
            'SELECT title FROM scorm_object WHERE obj_id = %s',
            array('integer'),
            array($a_obj_id)
        );
 
        while ($row = $ilDB->fetchObject($res)) {
            return $row->title;
        }
        return '';
    }

References $DIC, $ilDB, and $res.

Referenced by ilLPStatusSCORM\_getStatusInfo().

Here is the caller graph for this function:

◆ _lookupTrackingDataOfUser()

static ilSCORMItem::_lookupTrackingDataOfUser	(	int	$a_item_id,
		int	$a_user_id = `0`,
		int	$a_obj_id = `0`
	)

static

Returns: array<int|string, mixed>

Definition at line 269 of file class.ilSCORMItem.php.

                                                                                                           : array
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        if ($a_user_id == 0) {
            $a_user_id = $ilUser->getId();
        }
 
        $track_set = $ilDB->queryF(
            '
                        SELECT lvalue, rvalue FROM scorm_tracking 
                        WHERE sco_id = %s 
                        AND user_id =  %s
                        AND obj_id = %s',
            array('integer', 'integer', 'integer'),
            array($a_item_id, $a_user_id, $a_obj_id)
        );
 
        $trdata = array();
        while ($track_rec = $ilDB->fetchAssoc($track_set)) {
            $trdata[$track_rec["lvalue"]] = $track_rec["rvalue"];
        }
 
        return $trdata;
    }

References $DIC, and $ilDB.

Referenced by ilSCORMExplorer\getOutputIcons().

Here is the caller graph for this function:

◆ create()

ilSCORMItem::create ( )

Create database record for SCORM object.

Reimplemented from ilSCORMObject.

Definition at line 180 of file class.ilSCORMItem.php.

                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::create();
 
        $str_visible = ($this->getVisible()) ? 'true' : 'false';
 
        $ilDB->insert('sc_item', array(
            'obj_id' => array('integer', $this->getId()),
            'import_id' => array('text', $this->getImportId()),
            'identifierref' => array('text', $this->getIdentifierRef()),
            'isvisible' => array('text', $str_visible),
            'parameters' => array('text', $this->getParameters()),
            'prereq_type' => array('text', $this->getPrereqType()),
            'prerequisites' => array('text', $this->getPrerequisites()),
            'maxtimeallowed' => array('text', $this->getMaxTimeAllowed()),
            'timelimitaction' => array('text', $this->getTimeLimitAction()),
            'datafromlms' => array('clob', $this->getDataFromLms()),
            'masteryscore' => array('text', $this->getMasteryScore())
        ));
    }

References $DIC, $ilDB, getDataFromLms(), ilSCORMObject\getId(), getIdentifierRef(), getImportId(), getMasteryScore(), getMaxTimeAllowed(), getParameters(), getPrereqType(), getPrerequisites(), getTimeLimitAction(), and getVisible().

Here is the call graph for this function:

◆ delete()

ilSCORMItem::delete ( )

Reimplemented from ilSCORMObject.

Definition at line 297 of file class.ilSCORMItem.php.

                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilLog = ilLoggerFactory::getLogger('sahs');
 
        parent::delete();
 
        $ilDB->manipulateF(
            'DELETE FROM sc_item WHERE obj_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        $ilLog->write("SAHS Delete(ScormItem): " .
            'DELETE FROM scorm_tracking WHERE sco_id = ' . $this->getId() . ' AND obj_id = ' . $this->getSLMId());
        $ilDB->manipulateF(
            'DELETE FROM scorm_tracking WHERE sco_id = %s AND obj_id = %s',
            array('integer', 'integer'),
            array($this->getId(), $this->getSLMId())
        );
        ilLPStatusWrapper::_refreshStatus($this->getSLMId());
    }

References $DIC, $ilDB, ilLPStatusWrapper\_refreshStatus(), ilSCORMObject\getId(), ilLoggerFactory\getLogger(), and ilSCORMObject\getSLMId().

Here is the call graph for this function:

◆ getDataFromLms()

ilSCORMItem::getDataFromLms ( )

Definition at line 131 of file class.ilSCORMItem.php.

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

References $datafromlms.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getIdentifierRef()

ilSCORMItem::getIdentifierRef ( )

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

                                      : string
    {
        return $this->identifierref;
    }

References $identifierref.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getImportId()

ilSCORMItem::getImportId ( )

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

                                 : string
    {
        return $this->import_id;
    }

References $import_id.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getMasteryScore()

ilSCORMItem::getMasteryScore ( )

Definition at line 141 of file class.ilSCORMItem.php.

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

References $masteryscore.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getMaxTimeAllowed()

ilSCORMItem::getMaxTimeAllowed ( )

Definition at line 111 of file class.ilSCORMItem.php.

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

References $maxtimeallowed.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getParameters()

ilSCORMItem::getParameters ( )

Definition at line 81 of file class.ilSCORMItem.php.

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

References $parameters.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getPrereqType()

ilSCORMItem::getPrereqType ( )

Definition at line 91 of file class.ilSCORMItem.php.

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

References $prereq_type.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getPrerequisites()

ilSCORMItem::getPrerequisites ( )

Definition at line 101 of file class.ilSCORMItem.php.

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

References $prerequisites.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getTimeLimitAction()

ilSCORMItem::getTimeLimitAction ( )

Definition at line 121 of file class.ilSCORMItem.php.

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

References $timelimitaction.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getTrackingDataOfUser()

ilSCORMItem::getTrackingDataOfUser ( int $a_user_id = 0 )

get tracking data of specified or current user

Returns: array<int|string, mixed>

Definition at line 238 of file class.ilSCORMItem.php.

                                                             : array
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        if ($a_user_id == 0) {
            $a_user_id = $ilUser->getId();
        }
 
        $track_set = $ilDB->queryF(
            '
                        SELECT lvalue, rvalue FROM scorm_tracking 
                        WHERE sco_id = %s 
                        AND user_id =  %s
                        AND obj_id = %s',
            array('integer', 'integer', 'integer'),
            array($this->getId(), $a_user_id, $this->getSLMId())
        );
 
        $trdata = array();
        while ($track_rec = $ilDB->fetchAssoc($track_set)) {
            $trdata[$track_rec["lvalue"]] = $track_rec["rvalue"];
        }
 
        return $trdata;
    }

References $DIC, $ilDB, ilSCORMObject\getId(), and ilSCORMObject\getSLMId().

Here is the call graph for this function:

◆ getVisible()

ilSCORMItem::getVisible ( )

Definition at line 71 of file class.ilSCORMItem.php.

                                : bool
    {
        return $this->isvisible;
    }

References $isvisible.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ insertTrackData()

ilSCORMItem::insertTrackData	(	string	$a_lval,
		string	$a_rval,
		int	$a_obj_id
	)

Definition at line 321 of file class.ilSCORMItem.php.

                                                                                  : void
    {
        //ilObjSCORMTracking::_insertTrackData($this->getId(), $a_lval, $a_rval, $a_ref_id);
        ilObjSCORMTracking::_insertTrackData($this->getId(), $a_lval, $a_rval, $a_obj_id);
    }

References ilObjSCORMTracking\_insertTrackData(), and ilSCORMObject\getId().

Here is the call graph for this function:

◆ read()

ilSCORMItem::read ( )

Returns: void

Reimplemented from ilSCORMObject.

Definition at line 151 of file class.ilSCORMItem.php.

                          : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::read();
 
        $obj_set = $ilDB->queryF(
            'SELECT * FROM sc_item WHERE obj_id = %s',
            array('integer'),
            array($this->getId())
        );
        $obj_rec = $ilDB->fetchAssoc($obj_set);
        $this->setImportId((string) $obj_rec["import_id"]);
        $this->setIdentifierRef((string) $obj_rec["identifierref"]);
        if (strtolower((string) $obj_rec["isvisible"]) === "false") {
            $this->setVisible(false);
        } else {
            $this->setVisible(true);
        }
        $this->setParameters($obj_rec["parameters"]);
        $this->setPrereqType($obj_rec["prereq_type"]);
        $this->setPrerequisites($obj_rec["prerequisites"]);
        $this->setMaxTimeAllowed($obj_rec["maxtimeallowed"]);
        $this->setTimeLimitAction($obj_rec["timelimitaction"]);
        $this->setDataFromLms($obj_rec["datafromlms"]);
        $this->setMasteryScore($obj_rec["masteryscore"]);
    }

References $DIC, $ilDB, ilSCORMObject\getId(), setDataFromLms(), setIdentifierRef(), setImportId(), setMasteryScore(), setMaxTimeAllowed(), setParameters(), setPrereqType(), setPrerequisites(), setTimeLimitAction(), and setVisible().

Here is the call graph for this function:

◆ setDataFromLms()

ilSCORMItem::setDataFromLms ( ?string $a_data )

Definition at line 136 of file class.ilSCORMItem.php.

                                                   : void
    {
        $this->datafromlms = $a_data;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setIdentifierRef()

ilSCORMItem::setIdentifierRef ( string $a_id_ref )

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

                                                      : void
    {
        $this->identifierref = $a_id_ref;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setImportId()

ilSCORMItem::setImportId ( string $a_import_id )

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

                                                    : void
    {
        $this->import_id = $a_import_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setMasteryScore()

ilSCORMItem::setMasteryScore ( ?string $a_score )

Definition at line 146 of file class.ilSCORMItem.php.

                                                     : void
    {
        $this->masteryscore = $a_score;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setMaxTimeAllowed()

ilSCORMItem::setMaxTimeAllowed ( ?string $a_max )

Definition at line 116 of file class.ilSCORMItem.php.

                                                     : void
    {
        $this->maxtimeallowed = $a_max;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setParameters()

ilSCORMItem::setParameters ( ?string $a_par )

Definition at line 86 of file class.ilSCORMItem.php.

                                                 : void
    {
        $this->parameters = $a_par;
    }

References ILIAS\UI\examples\Prompt\Standard\parameters().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPrereqType()

ilSCORMItem::setPrereqType ( ?string $a_p_type )

Definition at line 96 of file class.ilSCORMItem.php.

                                                    : void
    {
        $this->prereq_type = $a_p_type;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setPrerequisites()

ilSCORMItem::setPrerequisites ( ?string $a_pre )

Definition at line 106 of file class.ilSCORMItem.php.

                                                    : void
    {
        $this->prerequisites = $a_pre;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTimeLimitAction()

ilSCORMItem::setTimeLimitAction ( ?string $a_lim_act )

Definition at line 126 of file class.ilSCORMItem.php.

                                                          : void
    {
        $this->timelimitaction = $a_lim_act;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setVisible()

ilSCORMItem::setVisible ( bool $a_visible )

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

                                               : void
    {
        $this->isvisible = $a_visible;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilSCORMItem::update ( )

Updates database record for SCORM object.

Reimplemented from ilSCORMObject.

Definition at line 204 of file class.ilSCORMItem.php.

                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::update();
 
        $str_visible = ($this->getVisible()) ? 'true' : 'false';
 
        $ilDB->update(
            'sc_item',
            array(
                'import_id' => array('text', $this->getImportId()),
                'identifierref' => array('text', $this->getIdentifierRef()),
                'isvisible' => array('text', $str_visible),
                'parameters' => array('text', $this->getParameters()),
                'prereq_type' => array('text', $this->getPrereqType()),
                'prerequisites' => array('text', $this->getPrerequisites()),
                'maxtimeallowed' => array('text', $this->getMaxTimeAllowed()),
                'timelimitaction' => array('text', $this->getTimeLimitAction()),
                'datafromlms' => array('clob', $this->getDataFromLms()),
                'masteryscore' => array('text', $this->getMasteryScore())
            ),
            array(
                'obj_id' => array('integer', $this->getId())
            )
        );
    }

References $DIC, $ilDB, getDataFromLms(), ilSCORMObject\getId(), getIdentifierRef(), getImportId(), getMasteryScore(), getMaxTimeAllowed(), getParameters(), getPrereqType(), getPrerequisites(), getTimeLimitAction(), and getVisible().

Here is the call graph for this function:

Field Documentation

◆ $datafromlms

string ilSCORMItem::$datafromlms = null

Definition at line 39 of file class.ilSCORMItem.php.

Referenced by getDataFromLms().

◆ $identifierref

string ilSCORMItem::$identifierref

Definition at line 32 of file class.ilSCORMItem.php.

Referenced by getIdentifierRef().

◆ $import_id

string ilSCORMItem::$import_id

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

Referenced by getImportId().

◆ $isvisible

bool ilSCORMItem::$isvisible = true

Definition at line 33 of file class.ilSCORMItem.php.

Referenced by getVisible().

◆ $masteryscore

string ilSCORMItem::$masteryscore = null

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

Referenced by getMasteryScore().

◆ $maxtimeallowed

string ilSCORMItem::$maxtimeallowed = null

Definition at line 37 of file class.ilSCORMItem.php.

Referenced by getMaxTimeAllowed().

◆ $parameters

string ilSCORMItem::$parameters = null

Definition at line 34 of file class.ilSCORMItem.php.

Referenced by getParameters().

◆ $prereq_type

string ilSCORMItem::$prereq_type = null

Definition at line 35 of file class.ilSCORMItem.php.

Referenced by getPrereqType().

◆ $prerequisites

string ilSCORMItem::$prerequisites = null

Definition at line 36 of file class.ilSCORMItem.php.

Referenced by getPrerequisites().

◆ $timelimitaction

string ilSCORMItem::$timelimitaction = null

Definition at line 38 of file class.ilSCORMItem.php.

Referenced by getTimeLimitAction().

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

components/ILIAS/ScormAicc/classes/SCORM/class.ilSCORMItem.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getItems()

◆ _lookupTitle()

◆ _lookupTrackingDataOfUser()

◆ create()

◆ delete()

◆ getDataFromLms()

◆ getIdentifierRef()

◆ getImportId()

◆ getMasteryScore()

◆ getMaxTimeAllowed()

◆ getParameters()

◆ getPrereqType()

◆ getPrerequisites()

◆ getTimeLimitAction()

◆ getTrackingDataOfUser()

◆ getVisible()

◆ insertTrackData()

◆ read()

◆ setDataFromLms()

◆ setIdentifierRef()

◆ setImportId()

◆ setMasteryScore()

◆ setMaxTimeAllowed()

◆ setParameters()

◆ setPrereqType()

◆ setPrerequisites()

◆ setTimeLimitAction()

◆ setVisible()

◆ update()

Field Documentation

◆ $datafromlms

◆ $identifierref

◆ $import_id

◆ $isvisible

◆ $masteryscore

◆ $maxtimeallowed

◆ $parameters

◆ $prereq_type

◆ $prerequisites

◆ $timelimitaction