ilSCORM2004Sco Class Reference

Class ilSCORM2004Sco. More...

Inheritance diagram for ilSCORM2004Sco:

Collaboration diagram for ilSCORM2004Sco:

Public Member Functions
	__construct ($a_slm_object, $a_id=0)
	Constructor. More...
	setHideObjectivePage ($a_val)
	Set hide objective page. More...
	getHideObjectivePage ()
	Get hide objective page. More...
	create ($a_upload=false, $a_template=false)
	Create sco. More...
	read ()
	Read data from database. More...
	update ()
	Update. More...
	delete ($a_delete_meta_data=true)
	Delete. More...
	copy ($a_target_slm)
	Copy sco. More...
	getMainObjectiveText ()
	Get main objective. More...
Public Member Functions inherited from ilSCORM2004Asset
	__construct ($a_slm_object, $a_id=0)
	Constructor. More...
	delete ($a_delete_meta_data=true)
	Delete a SCO. More...
	create ($a_upload=false, $a_template=false)
	Create asset. More...
	insertDefaultSequencingItem ()
	Insert default sequencing item. More...
	copy ($a_target_slm)
	Copy sco. More...
	exportScorm ($a_inst, $a_target_dir, $ver, &$expLog)
	exportHTML ( $a_inst, $a_target_dir, &$expLog, $a_asset_type="sco", $a_one_file="")
	exportHTML4PDF ($a_inst, $a_target_dir, &$expLog)
	exportPDF ($a_inst, $a_target_dir, &$expLog)
	exportPDFPrepareXmlNFiles ($a_inst, $a_target_dir, &$expLog, &$a_xml_writer)
	exportHTMLPageObjects ( $a_inst, $a_target_dir, &$expLog, $mode, $a_asset_type="sco", $a_one_file="", $a_sco_tpl=null)
	Export HTML pages of SCO. More...
	exportXMLPageObjects ($a_target_dir, &$a_xml_writer, $a_inst, &$expLog)
	exportXMLMediaObjects (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)
	exportFileItems ($a_target_dir, &$expLog)
	export files of file itmes More...
	exportXMLMetaData (&$a_xml_writer)
	getExportFiles ()
	getGlossaryTermIds ()
	Get glossary term ids in sco. More...
Public Member Functions inherited from ilSCORM2004Node
	__construct ($a_slm_object, $a_id=0)
	setTitle ($a_title)
	Set title. More...
	getTitle ()
	Get title. More...
	setDescription ($a_description)
	Set description. More...
	getDescription ()
	Get description. More...
	setType ($a_type)
	Set type. More...
	getType ()
	Get type. More...
	setSLMId ($a_slm_id)
	Set ID of parent Scorm Learning Module Object. More...
	getSLMId ()
	Get ID of parent Scorm Learning Module Object. More...
	setSLMObject ($a_slm_obj)
	Set Scorm Learning Module Object. More...
	getSLMObject ()
	Get scorm learning module object. More...
	getContentObject ()
	Get Scorm Learning Module Object. More...
	setId ($a_id)
	Set Node ID. More...
	getId ()
	Get Node ID. More...
	getImportId ()
	Set Import ID. More...
	setImportId ($a_id)
	Get Import ID. More...
	read ()
	Read Data of Node. More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	setDataRecord ($a_record)
	this method should only be called by class ilSCORM2004NodeFactory More...
	create ($a_upload=false)
	Create Node. More...
	update ()
	Update Node. More...
	delete ()
	Delete Node. More...
	getObjectives ()
	deleteSeqInfo ()
	exportAsScorm12 ()
	exportAsScorm13 ()

Protected Attributes
	$hide_obj_page = false
Protected Attributes inherited from ilSCORM2004Asset
	$tpl
	$lng
	$ctrl
Protected Attributes inherited from ilSCORM2004Node
	$db
	$user

Additional Inherited Members
Static Public Member Functions inherited from ilSCORM2004Asset
static	renderNavigation ($a_tpl, $a_spacer_img="", $a_lang="")
	Render navigation. More...
static	renderMetaPage ($a_tpl, $a_sco, $a_asset_type="", $mode="")
	Render meta page (description/objectives at beginning) More...
static	convertLists ($a_text)
	Convert * and # to lists. More...
Static Public Member Functions inherited from ilSCORM2004Node
static	_lookupTitle ($a_obj_id)
	Lookup Title. More...
static	_lookupType ($a_obj_id)
	Lookup Type. More...
static	_writeTitle ($a_obj_id, $a_title)
	Write Title. More...
static	_writeImportId ($a_id, $a_import_id)
	Write import ID. More...
static	_getIdForImportId ($a_import_id)
	Get Node ID for import ID (static) More...
static	_exists ($a_id)
	Checks wether a node exists. More...
static	_deleteAllSLMNodes ($a_slm_object)
	Delete all nodes of Scorm Learning Module. More...
static	_lookupSLMID ($a_id)
	Lookup Scorm Learning Module ID for node id. More...
static	putInTree ($a_obj, $a_parent_id="", $a_target_node_id="")
	put this object into content object tree More...
static	getTree ($a_slm_obj_id)
	Get scorm module editing tree. More...
static	clipboardCopy ($a_slm_obj_id, $a_ids)
	Copy a set of chapters/pages/scos into the clipboard. More...
static	clipboardCut ($a_slm_obj_id, $a_ids)
	Cut and copy a set of chapters/pages into the clipboard. More...
static	uniqueTypesCheck ($a_items)
	Check for unique types (all pages or all chapters or all scos) More...
static	insertPageClip ($a_slm_obj)
	Insert pages from clipboard. More...
static	insertAssetClip ($a_slm_obj, $a_type="ass")
	Insert assets from clipboard. More...
static	insertScoClip ($a_slm_obj)
	Insert scos from clipboard. More...
static	insertChapterClip ($a_slm_obj, $a_as_sub=false)
	Insert Chapter from clipboard. More...
static	pasteTree ( $a_target_slm, $a_item_id, $a_parent_id, $a_target, $a_insert_time, &$a_copied_nodes, $a_as_copy=false, $a_from_clipboard=true, $a_source_parent_type="")
	Paste item (tree) from clipboard or other learning module to target scorm learning module. More...
Data Fields inherited from ilSCORM2004Asset
	$q_media = null
Data Fields inherited from ilSCORM2004Node
	$slm_id
	$type
	$id
	$slm_object

Detailed Description

Class ilSCORM2004Sco.

SCO class for SCORM 2004 Editing

Author

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

Version

$Id$

Definition at line 17 of file class.ilSCORM2004Sco.php.

Constructor & Destructor Documentation

__construct()

ilSCORM2004Sco::__construct	(		$a_slm_object,
			$a_id = 0
	)

Constructor.

Parameters

object

SCORM LM object

Definition at line 26 of file class.ilSCORM2004Sco.php.

References $DIC, and ilSCORM2004Node\setType().

    {
        global $DIC;

        $this->db = $DIC->database();
        parent::__construct($a_slm_object, $a_id);
        $this->setType("sco");
    }

Here is the call graph for this function:

Member Function Documentation

copy()

ilSCORM2004Sco::copy

(

$a_target_slm

)

Copy sco.

Definition at line 122 of file class.ilSCORM2004Sco.php.

References ilSCORM2004Node\getDescription(), getHideObjectivePage(), ilSCORM2004Node\getId(), ilSCORM2004Node\getSLMId(), ilSCORM2004Node\getTitle(), and ilSCORM2004Node\getType().

    {
        $sco = new ilSCORM2004Sco($a_target_slm);
        $sco->setTitle($this->getTitle());
        $sco->setHideObjectivePage($this->getHideObjectivePage());
        if ($this->getSLMId() != $a_target_slm->getId()) {
            $sco->setImportId("il__sco_" . $this->getId());
        }
        $sco->setSLMId($a_target_slm->getId());
        $sco->setType($this->getType());
        $sco->setDescription($this->getDescription());
        $sco->create(true);
        $a_copied_nodes[$this->getId()] = $sco->getId();

        // copy meta data
        include_once("Services/MetaData/classes/class.ilMD.php");
        $md = new ilMD($this->getSLMId(), $this->getId(), $this->getType());
        $new_md = $md->cloneMD($a_target_slm->getId(), $sco->getId(), $this->getType());

        return $sco;
    }

Here is the call graph for this function:

create()

ilSCORM2004Sco::create	(		$a_upload = false,
			$a_template = false
	)

Create sco.

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

References ilSCORM2004Node\$db, $ilDB, and ilSCORM2004Node\getId().

    {
        $ilDB = $this->db;
        
        parent::create($a_upload, $a_template);
        if (!$a_template) {
            $obj = new ilSCORM2004Objective($this->getId());
            //                  $obj->setObjectiveID("Objective SCO ".$this->getId());
            $obj->setId("local_obj_" . $this->getID() . "_0");
            $obj->update();
        }
        $ilDB->manipulate("INSERT INTO sahs_sc13_sco " .
            "(id, hide_obj_page) VALUES (" .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote($this->getHideObjectivePage(), "integer") .
            ")");
    }

Here is the call graph for this function:

delete()

ilSCORM2004Sco::delete

(

$a_delete_meta_data = true

)

Delete.

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

References ilSCORM2004Node\$db, and $ilDB.

    {
        $ilDB = $this->db;

        parent::delete($a_delete_meta_data);
        $ilDB->manipulate(
            "DELETE FROM sahs_sc13_sco WHERE "
            . " id = " . $ilDB->quote($this->getId(), "integer")
        );
    }

getHideObjectivePage()

ilSCORM2004Sco::getHideObjectivePage

(

)

Get hide objective page.

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

References $hide_obj_page.

Referenced by copy().

    {
        return $this->hide_obj_page;
    }

Here is the caller graph for this function:

getMainObjectiveText()

ilSCORM2004Sco::getMainObjectiveText

(

)

Get main objective.

Todo:

: This should be saved in a better way in the future

Definition at line 149 of file class.ilSCORM2004Sco.php.

References $map, and ilSCORM2004Node\getObjectives().

    {
        $objectives = $this->getObjectives();

        foreach ($objectives as $ob) {
            // map info
            $mappings = $ob->getMappings();
            $mapinfo = null;
            foreach ($mappings as $map) {
                $mapinfo .= $map->getTargetObjectiveID();
            }

            if ($mapinfo == null) {
                $mapinfo = "local";
            } else {
                $mapinfo = "global to " . $mapinfo;
            }

            if ($mapinfo == "local") {
                return $ob->getObjectiveID();
            }
        }
    }

Here is the call graph for this function:

read()

ilSCORM2004Sco::read

(

)

Read data from database.

Definition at line 77 of file class.ilSCORM2004Sco.php.

References ilSCORM2004Node\$db, $ilDB, and setHideObjectivePage().

    {
        $ilDB = $this->db;

        parent::read();
        $set = $ilDB->query(
            "SELECT * FROM sahs_sc13_sco WHERE " .
            " id = " . $ilDB->quote($this->getId(), "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        $this->setHideObjectivePage($rec["hide_obj_page"]);
    }

Here is the call graph for this function:

setHideObjectivePage()

ilSCORM2004Sco::setHideObjectivePage

(

$a_val

)

Set hide objective page.

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

Referenced by read().

    {
        $this->hide_obj_page = $a_val;
    }

Here is the caller graph for this function:

update()

ilSCORM2004Sco::update

(

)

Update.

Definition at line 93 of file class.ilSCORM2004Sco.php.

References ilSCORM2004Node\$db, $ilDB, and League\Flysystem\Adapter\Polyfill\update().

    {
        $ilDB = $this->db;

        parent::update();
        $ilDB->manipulate(
            "UPDATE sahs_sc13_sco SET " .
            " hide_obj_page = " . $ilDB->quote($this->getHideObjectivePage(), "integer") .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer")
        );
    }

Here is the call graph for this function:

Field Documentation

$hide_obj_page

ilSCORM2004Sco::$hide_obj_page = false

protected

Definition at line 19 of file class.ilSCORM2004Sco.php.

Referenced by getHideObjectivePage().

---

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

• Modules/Scorm2004/classes/class.ilSCORM2004Sco.php