Class ilSCORM2004Condition. More...

Inheritance diagram for ilSCORM2004Item:

Collaboration diagram for ilSCORM2004Item:

Public Member Functions
	__construct ($a_treeid=null, $a_rootlevel=false)
	Constructor public. More...

	getSeqNodeId ()

	getTreeNodeId ()

	getSequencingId ()

	getImportId ()

	getNocopy ()

	getNodelete ()

	getNomove ()

	getSeqXml ()

	getRoolLevel ()

	getImportSeqXml ()
	Get import seq xml. More...

	setImportSeqXml ($a_val)
	Set import seq xml. More...

	setSeqNodeId ($a_seqnodeid)

	setTreeNodeId ($a_tree_node)

	setSequencingId ($a_seq_id)

	setNocopy ($a_nocopy)

	setNodelete ($a_nodelete)

	setNomove ($a_nomove)

	setImportId ($a_importid)

	setSeqXml ($a_seqxml)

	setDom ($a_dom)

	setRootLevel ($a_rootlevel)

	initDom ()
	Init dom. More...

	setDefaultXml ($a_def_control_mode=false)
	Set default xml. More...

	exportAsXML ($add_prefix=true)
	Get sequencing information for export (use imsss namespace prefix) More...

	loadItem ()
	Read data from DB into object. More...

	update ()
	Update item. More...

	delete ($a_insert_node=false)
	Delete item. More...

	insert ($import=false)
	Insert/replace sequencing item in db. More...

Static Public Member Functions
static	getAllowedActions ($a_node_id)

Protected Attributes
	$dom = null

	$log

Private Attributes
	$id = null

	$seqNodeId = null

	$treeNodeId = null

	$sequencingId = null

	$nocopy = false

	$nodelete = false

	$nomove = false

	$importId = null

	$seqXml = null

	$importSeqXml = null

	$rootLevel = false

Detailed Description

Class ilSCORM2004Condition.

Sequencing Template class for SCORM 2004 Editing

Author: Hendrik Holtmann holtm.nosp@m.ann@.nosp@m.me.co.nosp@m.m

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSCORM2004Item::__construct	(	$a_treeid = `null`,
		$a_rootlevel = `false`
	)

Constructor public.

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

References ilLoggerFactory\getLogger(), initDom(), and loadItem().

         {
                 $this->log = ilLoggerFactory::getLogger("sc13");
 
                 //different handling for organization level
                 $this->rootLevel = $a_rootlevel;
                 
                 if ($a_treeid != null)
                 {
                         $this->treeNodeId = $a_treeid;
                         $this->loadItem();
                         $this->dom = new DOMDocument();
                         $this->initDom();
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilSCORM2004Item::delete ( $a_insert_node = false )

Delete item.

Definition at line 292 of file class.ilSCORM2004Item.php.

References $ilDB, and $query.

         {
                 global $ilDB;
                 
                 $query = "DELETE FROM sahs_sc13_seq_item"." WHERE (sahs_sc13_tree_node_id = ".$ilDB->quote($this->treeNodeId, "integer").
                                   " AND rootlevel=".$ilDB->quote($this->rootLevel, "integer").")";
                 $obj_set = $ilDB->manipulate($query);   
         }

◆ exportAsXML()

ilSCORM2004Item::exportAsXML ( $add_prefix = true )

Get sequencing information for export (use imsss namespace prefix)

Returns: string sequencing xml

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

References $output.

         {
                 // remove titles
                 // @todo: the objectives (titles) text should be stored outside of
                 // the sequencing information in the future
                 $xpath_obj = new DOMXPath($this->dom);
                 $obj_node_list = $xpath_obj->query('//objective | //primaryObjective');
                 for ($i=0;$i<$obj_node_list->length;$i++) {
                         $obj_node_list->item($i)->removeAttribute("title");
                 }
                 $output = $this->dom->saveXML();
                 
                 $output = preg_replace('/<\?xml version="1.0"\?>/','',$output);
                 if ($add_prefix)
                 {
                         $output = preg_replace('/(<)([a-z]+|[A-Z]+)/','<imsss:$2',$output);
                         $output = preg_replace('/(<\/)([a-z]+|[A-Z]+)/','</imsss:$2',$output);
                 }
                 $output = preg_replace('/\n/','',$output);
 
                 return $output; 
         }

◆ getAllowedActions()

static ilSCORM2004Item::getAllowedActions ( $a_node_id )

static

Definition at line 183 of file class.ilSCORM2004Item.php.

References $ilDB, $ilLog, $query, array, and ilDBConstants\FETCHMODE_ASSOC.

         {
                 global $ilDB,$ilLog;
                 $query = "SELECT * FROM sahs_sc13_seq_item WHERE sahs_sc13_tree_node_id = ".
                         $ilDB->quote($a_node_id, "integer").
                         " AND rootlevel = ".$ilDB->quote(false, "integer");
                 $obj_set = $ilDB->query($query);
                 $obj_rec = $obj_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
                 return array("copy"=>!$obj_rec['nocopy'],"move"=>!$obj_rec['nomove'],"delete"=>!$obj_rec['nodelete']);
         }

◆ getImportId()

ilSCORM2004Item::getImportId ( )

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

References $importId.

         {
                 return $this->importId;
         }

◆ getImportSeqXml()

ilSCORM2004Item::getImportSeqXml ( )

Get import seq xml.

Returns: string xml

Definition at line 113 of file class.ilSCORM2004Item.php.

References $importSeqXml.

Referenced by insert().

         {
                 return $this->importSeqXml;
         }

Here is the caller graph for this function:

◆ getNocopy()

ilSCORM2004Item::getNocopy ( )

Definition at line 83 of file class.ilSCORM2004Item.php.

References $nocopy.

         {
                 return $this->nocopy;
         }

◆ getNodelete()

ilSCORM2004Item::getNodelete ( )

Definition at line 88 of file class.ilSCORM2004Item.php.

References $nodelete.

         {
                 return $this->nodelete;
         }

◆ getNomove()

ilSCORM2004Item::getNomove ( )

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

References $nomove.

         {
                 return $this->nomove;
         }

◆ getRoolLevel()

ilSCORM2004Item::getRoolLevel ( )

Definition at line 103 of file class.ilSCORM2004Item.php.

References $rootLevel.

         {
                 return $this->rootLevel;
         }

◆ getSeqNodeId()

ilSCORM2004Item::getSeqNodeId ( )

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

References $seqNodeId.

         {
                 return $this->seqNodeId;
         }

◆ getSequencingId()

ilSCORM2004Item::getSequencingId ( )

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

References $sequencingId.

         {
                 return $this->sequencingId;
         }

◆ getSeqXml()

ilSCORM2004Item::getSeqXml ( )

Definition at line 98 of file class.ilSCORM2004Item.php.

References $seqXml.

Referenced by initDom().

         {
                 return $this->seqXml;
         }

Here is the caller graph for this function:

◆ getTreeNodeId()

ilSCORM2004Item::getTreeNodeId ( )

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

References $treeNodeId.

         {
                 return $this->treeNodeId;
         }

◆ initDom()

ilSCORM2004Item::initDom ( )

Init dom.

Definition at line 197 of file class.ilSCORM2004Item.php.

References getSeqXml(), and setDefaultXml().

Referenced by __construct().

         {
                 if ($this->getSeqXml() != "")
                 {
                         $this->dom->loadXML($this->getSeqXml());
                 }
                 else
                 {
                         $this->setDefaultXml();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilSCORM2004Item::insert ( $import = false )

Insert/replace sequencing item in db.

Definition at line 304 of file class.ilSCORM2004Item.php.

References $ilDB, array, and getImportSeqXml().

Referenced by update().

         {
                 global $ilDB;
 
                 $ilDB->replace("sahs_sc13_seq_item",
                         array("sahs_sc13_tree_node_id" => array("integer", $this->treeNodeId),
                                 "rootlevel" => array("integer", $this->rootLevel)),
                         array(
                                 "importid" => array("text", $this->importId),
                                 "seqnodeid" => array("integer", (int) $this->seqNodeId),
                                 "sequencingid" => array("text", $this->sequencingId),
                                 "nocopy" => array("integer", $this->nocopy),
                                 "nodelete" => array("integer", $this->nodelete),
                                 "nomove" => array("integer", $this->nomove),
                                 "seqxml" => array("clob", $this->dom->saveXML()),
                                 "importseqxml" => array("clob", $this->getImportSeqXml())
                                 ));
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadItem()

ilSCORM2004Item::loadItem ( )

Read data from DB into object.

Definition at line 266 of file class.ilSCORM2004Item.php.

References $ilDB, and $query.

Referenced by __construct().

         {
                 global $ilDB;
                 $query = "SELECT * FROM sahs_sc13_seq_item WHERE (sahs_sc13_tree_node_id = ".$ilDB->quote($this->treeNodeId, "integer").
                         " AND rootlevel =".$ilDB->quote($this->rootLevel, "integer").")";
                 $obj_set = $ilDB->query($query);
                 $obj_rec = $ilDB->fetchAssoc($obj_set);
                 $this->seqXml = $obj_rec['seqxml'];
                 $this->importSeqXml = $obj_rec['importseqxml'];
                 $this->importId = $obj_rec['importid'];
                 $this->nocopy =  $obj_rec['nocopy'];
                 $this->nomove = $obj_rec['nomove'];
                 $this->nodelete = $obj_rec['nodelete'];
         }

Here is the caller graph for this function:

◆ setDefaultXml()

ilSCORM2004Item::setDefaultXml ( $a_def_control_mode = false )

Set default xml.

Parameters

bool $a_def_control_mode

Definition at line 214 of file class.ilSCORM2004Item.php.

References setSeqXml().

Referenced by initDom().

         {
                 while ($this->dom->hasChildNodes()){
                         $this->dom->removeChild($this->dom->childNodes->item(0));
                 }
 
                 $element = $this->dom->createElement('sequencing');
                 $this->dom->appendChild($element);
 
                 if ($a_def_control_mode)
                 {
                         $cm = $this->dom->createElement('controlMode');
                         $cm->setAttribute("flow", "true");
                         $cm->setAttribute("choice", "true");
                         $cm->setAttribute("forwardOnly", "false");
                         $element->appendChild($cm);
                 }
                 $this->setSeqXml($this->dom->saveXML());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDom()

ilSCORM2004Item::setDom ( $a_dom )

Definition at line 173 of file class.ilSCORM2004Item.php.

         {
                 $this->dom = $a_dom;
         }

◆ setImportId()

ilSCORM2004Item::setImportId ( $a_importid )

Definition at line 162 of file class.ilSCORM2004Item.php.

         {
                 $this->importid = $a_importid;
         }

◆ setImportSeqXml()

ilSCORM2004Item::setImportSeqXml ( $a_val )

Set import seq xml.

Parameters

string $a_val xml

Definition at line 127 of file class.ilSCORM2004Item.php.

         {
                 $this->importSeqXml = $a_val;
         }

◆ setNocopy()

ilSCORM2004Item::setNocopy ( $a_nocopy )

Definition at line 147 of file class.ilSCORM2004Item.php.

         {
                 $this->nocopy = $a_nocopy;
         }

◆ setNodelete()

ilSCORM2004Item::setNodelete ( $a_nodelete )

Definition at line 152 of file class.ilSCORM2004Item.php.

         {
                 $this->nodelete = $a_nodelete ;
         }

◆ setNomove()

ilSCORM2004Item::setNomove ( $a_nomove )

Definition at line 157 of file class.ilSCORM2004Item.php.

         {
                 $this->nomove = $a_nomove;
         }

◆ setRootLevel()

ilSCORM2004Item::setRootLevel ( $a_rootlevel )

Definition at line 178 of file class.ilSCORM2004Item.php.

         {
                 $this->rootLevel = $a_rootlevel;
         }

◆ setSeqNodeId()

ilSCORM2004Item::setSeqNodeId ( $a_seqnodeid )

Definition at line 132 of file class.ilSCORM2004Item.php.

         {
                 $this->seqNodeId = $a_seqnodeid;
         }

◆ setSequencingId()

ilSCORM2004Item::setSequencingId ( $a_seq_id )

Definition at line 142 of file class.ilSCORM2004Item.php.

         {
                 $this->sequencingId = $a_seq_id;
         }

◆ setSeqXml()

ilSCORM2004Item::setSeqXml ( $a_seqxml )

Definition at line 167 of file class.ilSCORM2004Item.php.

Referenced by setDefaultXml().

         {
                 $this->log->debug("seq xml: ".$a_seqxml);
                 $this->seqXml = $a_seqxml;
         }

Here is the caller graph for this function:

◆ setTreeNodeId()

ilSCORM2004Item::setTreeNodeId ( $a_tree_node )

Definition at line 137 of file class.ilSCORM2004Item.php.

         {
                 $this->treeNodeId = $a_tree_node;
         }

◆ update()

ilSCORM2004Item::update ( )

Update item.

Definition at line 284 of file class.ilSCORM2004Item.php.

References insert().

         {
                 $this->insert();
         }

Here is the call graph for this function:

Field Documentation

◆ $dom

ilSCORM2004Item::$dom = null

protected

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

◆ $id

ilSCORM2004Item::$id = null

private

Definition at line 20 of file class.ilSCORM2004Item.php.

◆ $importId

ilSCORM2004Item::$importId = null

private

Definition at line 27 of file class.ilSCORM2004Item.php.

Referenced by getImportId().

◆ $importSeqXml

ilSCORM2004Item::$importSeqXml = null

private

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

Referenced by getImportSeqXml().

◆ $log

ilSCORM2004Item::$log

protected

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

◆ $nocopy

ilSCORM2004Item::$nocopy = false

private

Definition at line 24 of file class.ilSCORM2004Item.php.

Referenced by getNocopy().

◆ $nodelete

ilSCORM2004Item::$nodelete = false

private

Definition at line 25 of file class.ilSCORM2004Item.php.

Referenced by getNodelete().

◆ $nomove

ilSCORM2004Item::$nomove = false

private

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

Referenced by getNomove().

◆ $rootLevel

ilSCORM2004Item::$rootLevel = false

private

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

Referenced by getRoolLevel().

◆ $seqNodeId

ilSCORM2004Item::$seqNodeId = null

private

Definition at line 21 of file class.ilSCORM2004Item.php.

Referenced by getSeqNodeId().

◆ $sequencingId

ilSCORM2004Item::$sequencingId = null

private

Definition at line 23 of file class.ilSCORM2004Item.php.

Referenced by getSequencingId().

◆ $seqXml

ilSCORM2004Item::$seqXml = null

private

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

Referenced by getSeqXml().

◆ $treeNodeId

ilSCORM2004Item::$treeNodeId = null

private

Definition at line 22 of file class.ilSCORM2004Item.php.

Referenced by getTreeNodeId().

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

Modules/Scorm2004/classes/seq_editor/class.ilSCORM2004Item.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ exportAsXML()

◆ getAllowedActions()

◆ getImportId()

◆ getImportSeqXml()

◆ getNocopy()

◆ getNodelete()

◆ getNomove()

◆ getRoolLevel()

◆ getSeqNodeId()

◆ getSequencingId()

◆ getSeqXml()

◆ getTreeNodeId()

◆ initDom()

◆ insert()

◆ loadItem()

◆ setDefaultXml()

◆ setDom()

◆ setImportId()

◆ setImportSeqXml()

◆ setNocopy()

◆ setNodelete()

◆ setNomove()

◆ setRootLevel()

◆ setSeqNodeId()

◆ setSequencingId()

◆ setSeqXml()

◆ setTreeNodeId()

◆ update()

Field Documentation

◆ $dom

◆ $id

◆ $importId

◆ $importSeqXml

◆ $log

◆ $nocopy

◆ $nodelete

◆ $nomove

◆ $rootLevel

◆ $seqNodeId

◆ $sequencingId

◆ $seqXml

◆ $treeNodeId