Class ilSCORM2004Chapter. More...

Inheritance diagram for ilSCORM2004SeqTemplate:

Collaboration diagram for ilSCORM2004SeqTemplate:

Public Member Functions
	__construct ($a_identifier)

	getMetadataProperties ()
	function getMetadataProperties More...

	getIdentifier ()
	function getIdentifier More...

	insertTemplateForObjectAtParent ($a_object, $a_parent, $a_target)

	importTemplate ($a_target, $a_object, $a_parent, $node)
	function import Template More...

	insert ($a_insert_node=false)

	getSeqNodeId ()

	getId ()

	setSeqNodeId ($a_seqnodeid)

	setId ($a_id)

Public Member Functions inherited from ilSCORM2004SeqNode
	__construct ()
	Constructor public. More...

	getNodeName ()

	getTreenodeId ()

	setNodeName ($a_nodeName)

	setTreenodeId ($a_treenodeId)

	insert ()

	update ($a_seq_node_id)

Static Public Member Functions
static	availableTemplates ()

static	getFileNameForIdentifier ($a_identifier)

static	templateForChapter ($a_chapter_id)

Data Fields
const	SEQ_TEMPLATE_DIR = './Modules/Scorm2004/templates/editor/seq_templates'

const	SEQ_TEMPLATE_XSL = './Modules/Scorm2004/templates/editor/seq_templates/xsl/normalize_seqtemplate.xsl'

const	SEQ_TEMPLATE_XSD = './Modules/Scorm2004/templates/editor/seq_templates/xsd/seq_template.xsd'

Private Member Functions
	generateObjIds ($a_dom)

Private Attributes
	$template

	$template_file

	$normalized_template

	$tree_node

	$diagnostic = array ()

	$parentchapter = true

	$importId

	$id = null

	$seqNodeId = null

	$sahs_sc13_treeId = null

	$importid

Additional Inherited Members
Protected Attributes inherited from ilSCORM2004SeqNode
	$db = null

Detailed Description

Class ilSCORM2004Chapter.

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 20 of file class.ilSCORM2004SeqTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCORM2004SeqTemplate::__construct ( $a_identifier )

Definition at line 42 of file class.ilSCORM2004SeqTemplate.php.

References $_SESSION, $test, ilSCORM2004SeqNode\setNodeName(), and template.

         {
                 
                 parent::__construct();
                 $this->setNodeName("seqtemplate");
                 
                 if ($a_identifier==null) {return;}
                 $t_file = self::getFileNameForIdentifier($a_identifier);
                                 
                 $this->template = new DOMDocument;
                 $this->template->async = false;
                 
 
                 //look for template in lang_dir, fallback to en
                 $test = self::SEQ_TEMPLATE_DIR."/".$_SESSION["lang"]."/".$t_file;
                 if (file_exists($test))
                 {
                         $this->template_file = $test;
                 } else {
                         $this->template_file = self::SEQ_TEMPLATE_DIR."/en/".$t_file;
                 }       
                 if (!@$this->template->load($this->template_file))
                 {
                         $this->diagnostic[] = 'Template not wellformed';
                         $test = $this->template->saveXML();
                         return false;
                 } else {
                         return true;
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ availableTemplates()

static ilSCORM2004SeqTemplate::availableTemplates ( )

static

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

References $ilDB, $query, $result, $row, and array.

Referenced by ilObjSCORM2004LearningModuleGUI\insertScenarioGUI().

         {
                 global $ilDB;
                 $arr_templates = array();
                 $query = "SELECT * FROM sahs_sc13_seq_templts ORDER BY identifier";
                 $result = $ilDB->query($query);
                 while($row = $ilDB->fetchAssoc($result)) 
                 {       
                         if($row['identifier']!="pretestpost") { //temporarily deactivated
                                 array_push($arr_templates,new ilScorm2004SeqTemplate($row['identifier']));
                         }
                 }
                 return $arr_templates;
         }

Here is the caller graph for this function:

◆ generateObjIds()

ilSCORM2004SeqTemplate::generateObjIds ( $a_dom )

private

Definition at line 232 of file class.ilSCORM2004SeqTemplate.php.

                                                 {
                 
         }

◆ getFileNameForIdentifier()

static ilSCORM2004SeqTemplate::getFileNameForIdentifier ( $a_identifier )

static

Definition at line 283 of file class.ilSCORM2004SeqTemplate.php.

References $ilDB, and $query.

         {
                 global $ilDB;
                 $query = "SELECT * FROM sahs_sc13_seq_templts WHERE identifier = ".
                         $ilDB->quote($a_identifier, "text");
                 $obj_set = $ilDB->query($query);
                 $obj_rec = $ilDB->fetchAssoc($obj_set);
                 return $obj_rec["fileName"];    // fixed, switch to all lowercase fields and tables in the future for mdb2 compliance
                 return $obj_rec["filename"];
         }

◆ getId()

ilSCORM2004SeqTemplate::getId ( )

Definition at line 262 of file class.ilSCORM2004SeqTemplate.php.

References $id.

         {
                 return $this->id;
         }

◆ getIdentifier()

ilSCORM2004SeqTemplate::getIdentifier ( )

function getIdentifier

Returns: get identifier for template

Author: Hendrik Holtmann

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

         {
                 $seqtemplate = $this->template->getElementsByTagName("seqTemplate");
                 return $seqtemplate->item(0)->getAttribute("identifier");;
         }

◆ getMetadataProperties()

ilSCORM2004SeqTemplate::getMetadataProperties ( )

function getMetadataProperties

Returns: hash of metadata for the template

Author: Hendrik Holtmann

Definition at line 80 of file class.ilSCORM2004SeqTemplate.php.

References array.

         {
                 $array_metad = array();
                 $metadata = $this->template->getElementsByTagName("metadata");
                 $nodes = $metadata->item(0)->childNodes;
                 for ($i = 0; $i < $nodes->length; $i++ ) {
                         $curNode = $nodes->item($i);
                         $array_metad[$curNode->localName] = $curNode->nodeValue;
                 }
                 return $array_metad;
         }

◆ getSeqNodeId()

ilSCORM2004SeqTemplate::getSeqNodeId ( )

Definition at line 257 of file class.ilSCORM2004SeqTemplate.php.

References $seqNodeId.

         {
                 return $this->seqNodeId;
         }

◆ importTemplate()

ilSCORM2004SeqTemplate::importTemplate	(	$a_target,
		$a_object,
		$a_parent,
		$node
	)

function import Template

Returns: success of import

Author: Hendrik Holtmann

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

References $ilDB, $importId, $sahs_sc13_treeId, $target, $title, and ilSCORM2004Node\putInTree().

Referenced by insertTemplateForObjectAtParent().

                                                                             {
                 global $ilDB;
                                 
                 switch($node->getAttribute('type'))
         {
                         case "lesson":
                                 if ($this->parentchapter==true) 
                                 {
                                         $chap = new ilSCORM2004SeqChapter($a_object);
                                 } else {
                                         $chap = new ilSCORM2004Chapter($a_object);
                                 }
                                 $chap->setTitle($node->getElementsByTagName("title")->item(0)->nodeValue);
                                 $chap->setSLMId($a_object->getId());
                                 $chap->create();
                                 $this->sahs_sc13_treeId = $chap->getId();
                                 ilSCORM2004Node::putInTree($chap, $a_parent,$a_target);
                                 $a_parent = $this->sahs_sc13_treeId;
                                 if ($this->parentchapter==true) 
                         {
                                 $ilDB->manipulate("INSERT INTO sahs_sc13_seq_assign (identifier, sahs_sc13_tree_node_id) VALUES ".
                                         "(".$ilDB->quote($this->getIdentifier(), "text").",".
                                                 $ilDB->quote($this->sahs_sc13_treeId, "integer").")");
                                 $this->parentchapter = false;
                         }
                                 $new_id = $chap->getId();
                         break;
                         case "sco" :
                                 $sco = new ilSCORM2004Sco($a_object);
                         $sco->setTitle($node->getElementsByTagName("title")->item(0)->nodeValue);
                         $sco->setSLMId($a_object->getId());
                         $sco->create(false,true);
                         $this->sahs_sc13_treeId = $sco->getId();
                         ilSCORM2004Node::putInTree($sco, $a_parent, $target);
                                 $new_id = $sco->getId();
                                 break;  
                 }
                 
                 $seq_node = $node->getElementsByTagName("sequencing")->item(0);
                 
                 $obj_node = $seq_node->getElementsByTagName("objectives")->item(0);
                 //addtitle
                 if ($obj_node) {
                         foreach ($obj_node->childNodes as $objchild ) {
                                 if ($objchild->nodeName === "objective" || $objchild->nodeName === "primaryObjective") {
                                 $title = $objchild->getAttribute('objectiveID');
                                         $objchild->setAttribute("title",$title);
                                         $i++;
                                 }
                         }
                 }
                 
                 $seq_item = new ilSCORM2004Item();
                 $seq_item->setTreeNodeId($this->sahs_sc13_treeId);
                 $seq_item->setImportid($this->importId);
                 $seq_item->setNocopy($seq_node->getAttribute('nocopy'));
                 $seq_item->setNodelete($seq_node->getAttribute('nodelete'));
                 $seq_item->setNomove($seq_node->getAttribute('nomove'));
                 
                 $seq_doc = new DOMDocument();
                 $toadd = $seq_doc->importNode($seq_node, true);
                 $seq_doc->appendChild($toadd);
                 
                 //generate Unique ObjectiveIDs for context
 
                 //@targetObjectiveID
                 $xpath_obj = new DOMXPath($seq_doc);
                 
                 $found_nodes = $xpath_obj->query('//@objectiveID | //@referencedObjective | //@targetObjectiveID');
                 for ($i=0; $i<$found_nodes->length; $i++) {
                         $element = null;
                         $val = $found_nodes->item($i)->value;
                         $uid = $this->sahs_sc13_treeId;
                         if ($found_nodes->item($i)->name == "targetObjectiveID") {
                                 $uid = $this->importId;
                         }
                         $val = strtolower(preg_replace('/ +/','_',$val)."_".$uid);
                         $element = $found_nodes->item($i)->ownerElement;
                         $element->setAttribute($found_nodes->item($i)->name,$val);
                 }
                 
                 $seq_item->setDom($seq_doc);
                 
                 $seq_item->insert();
                 
                 foreach($node->childNodes as $child)
             {   if ($child->nodeName === "item") {
                         $this->importTemplate($a_target,$a_object,$a_parent,$child);
                         }
             }
                 
                 return $new_id;
         }       

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilSCORM2004SeqTemplate::insert ( $a_insert_node = false )

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

References $result, and setSeqNodeId().

         {
                 if ($a_insert_node==true) {$this->setSeqNodeId(parent::insert());}
                 $sql = "INSERT INTO sahs_sc13_seq_templ (seqnodeid,id)".
                                 " values(".
                                 $this->db->quote($this->seqNodeId, "integer").",".
                                 $this->db->quote($this->id, "text").");";
                 $result = $this->db->manipulate($sql);
                 return true;
         }

Here is the call graph for this function:

◆ insertTemplateForObjectAtParent()

ilSCORM2004SeqTemplate::insertTemplateForObjectAtParent	(	$a_object,
		$a_parent,
		$a_target
	)

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

References importTemplate(), and template.

         {
                 $this->importId = uniqid();
                 return $this->importTemplate($a_target,$a_object,$a_parent, $this->template->getElementsByTagName("item")->item(0));    
         }

Here is the call graph for this function:

◆ setId()

ilSCORM2004SeqTemplate::setId ( $a_id )

Definition at line 276 of file class.ilSCORM2004SeqTemplate.php.

         {
                 $this->id = $a_id;
         }

◆ setSeqNodeId()

ilSCORM2004SeqTemplate::setSeqNodeId ( $a_seqnodeid )

Definition at line 271 of file class.ilSCORM2004SeqTemplate.php.

Referenced by insert().

         {
                 $this->seqNodeId = $a_seqnodeid;
         }

Here is the caller graph for this function:

◆ templateForChapter()

static ilSCORM2004SeqTemplate::templateForChapter ( $a_chapter_id )

static

Definition at line 294 of file class.ilSCORM2004SeqTemplate.php.

References $ilDB, $query, and $template.

Referenced by ilSCORM2004Utilities\parentHasSeqTemplate(), and ilSCORM2004ChapterGUI\showProperties().

         {
                 global $ilDB;
                 $template = null;
                 $query = "SELECT * FROM sahs_sc13_seq_assign WHERE sahs_sc13_tree_node_id = ".
                         $ilDB->quote($a_chapter_id, "integer");
                 $obj_set = $ilDB->query($query);
                 $obj_rec = $ilDB->fetchAssoc($obj_set);
                 if ($obj_rec['identifier']) {
                         $template = new ilScorm2004SeqTemplate($obj_rec['identifier']);
                 } 
                 return $template;
         }