SCORM Resource. More...

Inheritance diagram for ilSCORMResource:

Collaboration diagram for ilSCORMResource:

Public Member Functions
	__construct (int $a_id=0)

	getImportId ()

	setImportId (string $a_import_id)

	getResourceType ()

	setResourceType (string $a_type)

	getScormType ()

	setScormType (?string $a_scormtype)

	getHRef ()

	setHRef (?string $a_href)

	getXmlBase ()

	setXmlBase (?string $a_xml_base)

	addFile (ilSCORMResourceFile $a_file_obj)

&	getFiles ()

	addDependency (ilSCORMResourceDependency $a_dependency)

&	getDependencies ()

	read ()

	readByIdRef (string $a_id_ref, int $a_slm_id)

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

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

	delete ()

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	_lookupIdByIdRef (string $a_id_ref, int $a_slm_id)

static	_lookupScormType (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	$resourcetype

string	$scormtype = null

string	$href = null

string	$xml_base = null

array	$files

array	$dependencies

Data Fields inherited from ilSCORMObject
int	$id

string	$title = ""

string	$type = null

int	$slm_id

Detailed Description

SCORM Resource.

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

Version: $Id$

\

Definition at line 28 of file class.ilSCORMResource.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCORMResource::__construct ( int $a_id = 0 )

Parameters

int $a_id Object ID

Reimplemented from ilSCORMObject.

Definition at line 41 of file class.ilSCORMResource.php.

    {
        $this->files = array();
        $this->dependencies = array();
        $this->setType("sre");
        parent::__construct($a_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _lookupIdByIdRef()

static ilSCORMResource::_lookupIdByIdRef	(	string	$a_id_ref,
		int	$a_slm_id
	)

static

Definition at line 189 of file class.ilSCORMResource.php.

                                                                            : int
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];
        $ilDB = $DIC->database();
 
        $id_set = $ilDB->queryF(
            'SELECT ob.obj_id id FROM sc_resource res, scorm_object ob
                        WHERE ob.obj_id = res.obj_id 
                        AND res.import_id = %s 
                        AND ob.slm_id = %s',
            array('text', 'integer'),
            array($a_id_ref ,$a_slm_id)
        );
 
        if ($id_rec = $ilDB->fetchAssoc($id_set)) {
            return (int) $id_rec["id"];
        }
        return 0;
    }

References $DIC, and $ilDB.

Referenced by ilSCORMExplorer\insertObject().

Here is the caller graph for this function:

◆ _lookupScormType()

static ilSCORMResource::_lookupScormType ( int $a_obj_id )

static

Definition at line 210 of file class.ilSCORMResource.php.

                                                          : string
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $st_set = $ilDB->queryF(
            'SELECT scormtype FROM sc_resource WHERE obj_id = %s',
            array('integer'),
            array($a_obj_id)
        );
        if ($st_rec = $ilDB->fetchAssoc($st_set)) {
            return (string) $st_rec["scormtype"];//check UK usually null
        }
        return "";
    }

References $DIC, and $ilDB.

Referenced by ilSCORMExplorer\insertObject().

Here is the caller graph for this function:

◆ addDependency()

ilSCORMResource::addDependency ( ilSCORMResourceDependency $a_dependency )

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

                                                                          : void
    {
        $this->dependencies[] = &$a_dependency;
    }

Referenced by read().

Here is the caller graph for this function:

◆ addFile()

ilSCORMResource::addFile ( ilSCORMResourceFile $a_file_obj )

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

                                                            : void
    {
        $this->files[] = &$a_file_obj;
    }

Referenced by read().

Here is the caller graph for this function:

◆ create()

ilSCORMResource::create ( )

Create database record for SCORM object.

Reimplemented from ilSCORMObject.

Definition at line 226 of file class.ilSCORMResource.php.

                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::create();
 
        $ilDB->manipulateF(
            '
                        INSERT INTO sc_resource 
                        (obj_id, import_id, resourcetype, scormtype, href, xml_base) 
                        VALUES(%s, %s, %s, %s, %s, %s)',
            array('integer','text','text','text','text','text'),
            array(      $this->getId(),
                    $this->getImportId(),
                    $this->getResourceType(),
                    $this->getScormType(),
                    $this->getHref(),
                    $this->getXmlBase()
            )
        );
 
        // save files
        foreach ($this->files as $i => $value) {
            $nextId = $ilDB->nextId('sc_resource_file');
 
            $ilDB->manipulateF(
                '
                                INSERT INTO sc_resource_file (id,res_id, href, nr) 
                                VALUES(%s, %s, %s, %s)',
                array('integer', 'integer', 'text', 'integer'),
                array($nextId, $this->getId(), $value->getHref(), ($i + 1))
            );
        }
 
        // save dependencies
        for ($i = 0, $max = count($this->dependencies); $i < $max; $i++) {
            $nextId = $ilDB->nextId('sc_resource_dependen');
 
            $ilDB->manipulateF(
                '
                                INSERT INTO sc_resource_dependen (id, res_id, identifierref, nr)
                                VALUES(%s, %s, %s, %s)',
                array('integer', 'integer', 'text', 'integer'),
                array($nextId, $this->getId(), $this->files[$i]->getHref(), ($i + 1))
            );
        }
    }

References $DIC, $ilDB, ilSCORMObject\getId(), getImportId(), getResourceType(), getScormType(), and getXmlBase().

Here is the call graph for this function:

◆ delete()

ilSCORMResource::delete ( )

Reimplemented from ilSCORMObject.

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

                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::delete();
 
        $ilDB->manipulateF(
            'DELETE FROM sc_resource WHERE obj_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        $ilDB->manipulateF(
            'DELETE FROM sc_resource_file WHERE res_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        $ilDB->manipulateF(
            'DELETE FROM sc_resource_dependen WHERE res_id = %s',
            array('integer'),
            array($this->getId())
        );
    }

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

Here is the call graph for this function:

◆ getDependencies()

& ilSCORMResource::getDependencies ( )

Definition at line 115 of file class.ilSCORMResource.php.

                                      : array
    {
        return $this->dependencies;
    }

References $dependencies.

◆ getFiles()

& ilSCORMResource::getFiles ( )

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

                               : array
    {
        return $this->files;
    }

References $files.

◆ getHRef()

ilSCORMResource::getHRef ( )

Definition at line 79 of file class.ilSCORMResource.php.

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

References $href.

Referenced by update().

Here is the caller graph for this function:

◆ getImportId()

ilSCORMResource::getImportId ( )

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

                                 : string
    {
        return $this->import_id;
    }

References $import_id.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getResourceType()

ilSCORMResource::getResourceType ( )

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

                                     : string
    {
        return $this->resourcetype;
    }

References $resourcetype.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getScormType()

ilSCORMResource::getScormType ( )

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

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

References $scormtype.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getXmlBase()

ilSCORMResource::getXmlBase ( )

Definition at line 90 of file class.ilSCORMResource.php.

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

References $xml_base.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ read()

ilSCORMResource::read ( )

Returns: void

Reimplemented from ilSCORMObject.

Definition at line 120 of file class.ilSCORMResource.php.

                          : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::read();
 
        $obj_set = $ilDB->queryF(
            'SELECT * FROM sc_resource WHERE obj_id = %s',
            array('integer'),
            array($this->getId())
        );
        $obj_rec = $ilDB->fetchAssoc($obj_set);
        $this->setImportId($obj_rec["import_id"]);
        $this->setResourceType($obj_rec["resourcetype"]);
        $this->setScormType($obj_rec["scormtype"]);
        $this->setHRef($obj_rec["href"]);
        $this->setXmlBase($obj_rec["xml_base"]);
 
        // read files
        $file_set = $ilDB->queryF(
            'SELECT href FROM sc_resource_file WHERE res_id = %s ORDER BY nr',
            array('integer'),
            array($this->getId())
        );
        while ($file_rec = $ilDB->fetchAssoc($file_set)) {
            $res_file = new ilSCORMResourceFile();
            $res_file->setHref($file_rec["href"]);
            $this->addFile($res_file);
        }
        // read dependencies
 
        $dep_set = $ilDB->queryF(
            'SELECT identifierref FROM sc_resource_dependen WHERE res_id = %s ORDER BY nr',
            array('integer'),
            array($this->getId())
        );
        while ($dep_rec = $ilDB->fetchAssoc($dep_set)) {
            $res_dep = new ilSCORMResourceDependency();
            $res_dep->setIdentifierRef($dep_rec["identifierref"]);
            $this->addDependency($res_dep);
        }
    }

References $DIC, $ilDB, addDependency(), addFile(), ilSCORMObject\getId(), setHRef(), setImportId(), setResourceType(), setScormType(), and setXmlBase().

Referenced by readByIdRef().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readByIdRef()

ilSCORMResource::readByIdRef	(	string	$a_id_ref,
		int	$a_slm_id
	)

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

                                                                : void
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];
        $ilDB = $DIC->database();
 
        $ilBench->start("SCORMResource", "readByIdRef_Query");
 
        $id_set = $ilDB->queryF(
            'SELECT ob.obj_id id FROM sc_resource res, scorm_object ob
                        WHERE ob.obj_id = res.obj_id 
                        AND res.import_id = %s 
                        AND ob.slm_id = %s',
            array('text', 'integer'),
            array($a_id_ref, $a_slm_id)
        );
 
        $ilBench->stop("SCORMResource", "readByIdRef_Query");
 
        if ($id_rec = $ilDB->fetchAssoc($id_set)) {
            $this->setId($id_rec["id"]);
            $this->read();
        }
    }

References $DIC, $ilDB, read(), and ilSCORMObject\setId().

Here is the call graph for this function:

◆ setHRef()

ilSCORMResource::setHRef ( ?string $a_href )

Definition at line 84 of file class.ilSCORMResource.php.

                                            : void
    {
        $this->href = $a_href;
        $this->setTitle("" . $a_href);
    }

References ilSCORMObject\setTitle().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setImportId()

ilSCORMResource::setImportId ( string $a_import_id )

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

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

Referenced by read().

Here is the caller graph for this function:

◆ setResourceType()

ilSCORMResource::setResourceType ( string $a_type )

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

                                                   : void
    {
        $this->resourcetype = $a_type;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setScormType()

ilSCORMResource::setScormType ( ?string $a_scormtype )

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

                                                      : void
    {
        $this->scormtype = $a_scormtype;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setXmlBase()

ilSCORMResource::setXmlBase ( ?string $a_xml_base )

Definition at line 95 of file class.ilSCORMResource.php.

                                                   : void
    {
        $this->xml_base = $a_xml_base;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilSCORMResource::update ( )

Updates database record for SCORM object.

Reimplemented from ilSCORMObject.

Definition at line 275 of file class.ilSCORMResource.php.

                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        parent::update();
 
        $ilDB->manipulateF(
            '
                        UPDATE sc_resource 
                        SET import_id = %s,
                                resourcetype = %s,
                                scormtype = %s,
                                href = %s,
                                xml_base = %s
                        WHERE obj_id = %s',
            array('text', 'text', 'text', 'text', 'text', 'integer'),
            array(      $this->getImportId(),
                    $this->getResourceType(),
                    $this->getScormType(),
                    $this->getHRef(),
                    $this->getXmlBase(),
                    $this->getId())
        );
 
        // save files
        $ilDB->manipulateF(
            'DELETE FROM sc_resource_file WHERE res_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        foreach ($this->files as $i => $value) {
            $nextId = $ilDB->nextId('sc_resource_file');
 
            $ilDB->manipulateF(
                'INSERT INTO sc_resource_file (id, res_id, href, nr) 
                                VALUES (%s, %s, %s, %s)',
                array('integer', 'integer', 'text', 'integer'),
                array($nextId, $this->getId(), $value->getHref(), ($i + 1))
            );
        }
 
        // save dependencies
        $ilDB->manipulateF(
            'DELETE FROM sc_resource_dependen WHERE res_id = %s',
            array('integer'),
            array($this->getId())
        );
 
        foreach ($this->dependencies as $i => $value) {
            $nextId = $ilDB->nextId('sc_resource_dependen');
 
            $ilDB->manipulateF(
                '
                                INSERT INTO sc_resource_dependen (id, res_id, identifierref, nr) VALUES
                                (%s, %s, %s, %s) ',
                array('integer', 'integer', 'text', 'integer'),
                array($nextId, $this->getId(), $value->getIdentifierRef(), ($i + 1))
            );
        }
    }

References $DIC, $ilDB, getHRef(), ilSCORMObject\getId(), getImportId(), getResourceType(), getScormType(), and getXmlBase().

Here is the call graph for this function:

Field Documentation

◆ $dependencies

array ilSCORMResource::$dependencies

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

Referenced by getDependencies().

◆ $files

array ilSCORMResource::$files

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

Referenced by getFiles().

◆ $href

string ilSCORMResource::$href = null

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

Referenced by getHRef().

◆ $import_id

string ilSCORMResource::$import_id

Definition at line 30 of file class.ilSCORMResource.php.

Referenced by getImportId().

◆ $resourcetype

string ilSCORMResource::$resourcetype

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

Referenced by getResourceType().

◆ $scormtype

string ilSCORMResource::$scormtype = null

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

Referenced by getScormType().

◆ $xml_base

string ilSCORMResource::$xml_base = null

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

Referenced by getXmlBase().

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookupIdByIdRef()

◆ _lookupScormType()

◆ addDependency()

◆ addFile()

◆ create()

◆ delete()

◆ getDependencies()

◆ getFiles()

◆ getHRef()

◆ getImportId()

◆ getResourceType()

◆ getScormType()

◆ getXmlBase()

◆ read()

◆ readByIdRef()

◆ setHRef()

◆ setImportId()

◆ setResourceType()

◆ setScormType()

◆ setXmlBase()

◆ update()

Field Documentation

◆ $dependencies

◆ $files

◆ $href

◆ $import_id

◆ $resourcetype

◆ $scormtype

◆ $xml_base