class.ilSCORMItem.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSCORMItem extends ilSCORMObject
{
    public string $import_id;
    public string $identifierref;
    public bool $isvisible = true;
    public ?string $parameters = null;
    public ?string $prereq_type = null;
    public ?string $prerequisites = null;
    public ?string $maxtimeallowed = null;
    public ?string $timelimitaction = null;
    public ?string $datafromlms = null;
    public ?string $masteryscore = null;

    public function __construct(int $a_id = 0)
    {
        parent::__construct($a_id);
        $this->setType("sit");
    }

    public function getImportId(): string
    {
        return $this->import_id;
    }

    public function setImportId(string $a_import_id): void
    {
        $this->import_id = $a_import_id;
    }

    public function getIdentifierRef(): string
    {
        return $this->identifierref;
    }

    public function setIdentifierRef(string $a_id_ref): void
    {
        $this->identifierref = $a_id_ref;
    }

    public function getVisible(): bool
    {
        return $this->isvisible;
    }

    public function setVisible(bool $a_visible): void
    {
        $this->isvisible = $a_visible;
    }

    public function getParameters(): ?string
    {
        return $this->parameters;
    }

    public function setParameters(?string $a_par): void
    {
        $this->parameters = $a_par;
    }

    public function getPrereqType(): ?string
    {
        return $this->prereq_type;
    }

    public function setPrereqType(?string $a_p_type): void
    {
        $this->prereq_type = $a_p_type;
    }

    public function getPrerequisites(): ?string
    {
        return $this->prerequisites;
    }

    public function setPrerequisites(?string $a_pre): void
    {
        $this->prerequisites = $a_pre;
    }

    public function getMaxTimeAllowed(): ?string
    {
        return $this->maxtimeallowed;
    }

    public function setMaxTimeAllowed(?string $a_max): void
    {
        $this->maxtimeallowed = $a_max;
    }

    public function getTimeLimitAction(): ?string
    {
        return $this->timelimitaction;
    }

    public function setTimeLimitAction(?string $a_lim_act): void
    {
        $this->timelimitaction = $a_lim_act;
    }

    public function getDataFromLms(): ?string
    {
        return $this->datafromlms;
    }

    public function setDataFromLms(?string $a_data): void
    {
        $this->datafromlms = $a_data;
    }

    public function getMasteryScore(): ?string
    {
        return $this->masteryscore;
    }

    public function setMasteryScore(?string $a_score): void
    {
        $this->masteryscore = $a_score;
    }

    public function read(): 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"]);
    }

    public function create(): 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())
        ));
    }

    public function update(): 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())
            )
        );
    }

    public function getTrackingDataOfUser(int $a_user_id = 0): 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;
    }

    public static function _lookupTrackingDataOfUser(int $a_item_id, int $a_user_id = 0, int $a_obj_id = 0): 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;
    }

    public function delete(): 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());
    }

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

    public static function _getItems(int $a_obj_id): 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;
    }

    public static function _lookupTitle(int $a_obj_id): 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 '';
    }
}