SCORM Package Parser. More...

Inheritance diagram for ilSCORMPackageParser:

Collaboration diagram for ilSCORMPackageParser:

Public Member Functions
	__construct (object $a_slm_object, string $a_xml_file)
	Constructor. More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class More...

	startParsing ()

	getPackageTitle ()

	beginElement (string $a_name)
	update parsing status for a element begin More...

	endElement (string $a_name)
	update parsing status for an element ending More...

	getCurrentElement ()
	returns current element More...

	getAncestorElement (int $nr=1)

	buildTag (string $type, string $name, ?array $attr=null)
	generate a tag with given name and attributes More...

	getCurrentParent ()

	handlerBeginTag (XMLParser $a_xml_parser, string $a_name, array $a_attribs)
	handler for begin of element More...

	handlerEndTag (XMLParser $a_xml_parser, string $a_name)
	handler for end of element More...

	handlerCharacterData (XMLParser $a_xml_parser, ?string $a_data)
	handler for character data More...

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Data Fields
array	$current_element

object	$slm_object

array	$parent_stack

bool	$tree_created

object	$scorm_tree

object	$current_organization

object	$current_resource

array	$item_stack

string	$package_title = ""

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Private Attributes
ilSCORMTree	$sc_tree

Additional Inherited Members
Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Detailed Description

SCORM Package Parser.

Author

Version: $Id$

\

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

Constructor & Destructor Documentation

◆ __construct()

ilSCORMPackageParser::__construct	(	object	$a_slm_object,
		string	$a_xml_file
	)

Constructor.

Parameters

object	$a_lm_object	must be of type ilObjLearningModule
string	$a_xml_file	xml file

Definition at line 47 of file class.ilSCORMPackageParser.php.

References ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct($a_xml_file);
         //        $this->cnt = array();
         $this->current_element = array();
         $this->slm_object = $a_slm_object;
         $this->tree_created = false;
         $this->parent_stack = array();
         $this->item_stack = array();
     }

Here is the call graph for this function:

Member Function Documentation

◆ beginElement()

ilSCORMPackageParser::beginElement ( string $a_name )

update parsing status for a element begin

Definition at line 87 of file class.ilSCORMPackageParser.php.

Referenced by handlerBeginTag().

                                                 : void
     {
         //        if (!isset($this->status["$a_name"])) {
         //            $this->cnt[$a_name] == 1;
         //        } else {
         //            $this->cnt[$a_name]++;
         //        }
         $this->current_element[count($this->current_element)] = $a_name;
     }

Here is the caller graph for this function:

◆ buildTag()

ilSCORMPackageParser::buildTag	(	string	$type,
		string	$name,
		?array	$attr = `null`
	)

generate a tag with given name and attributes

Definition at line 134 of file class.ilSCORMPackageParser.php.

                                                                              : string
     {
         $tag = "<";
 
         if ($type === "end") {
             $tag .= "/";
         }
 
         $tag .= $name;
 
         if (is_array($attr)) {
             foreach ($attr as $k => $v) {
                 $tag .= " " . $k . "=\"$v\"";
             }
         }
 
         $tag .= ">";
 
         return $tag;
     }

◆ endElement()

ilSCORMPackageParser::endElement ( string $a_name )

update parsing status for an element ending

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

Referenced by handlerEndTag().

                                               : void
     {
         //        $this->cnt[$a_name]--;
         unset($this->current_element[count($this->current_element) - 1]);
     }

Here is the caller graph for this function:

◆ getAncestorElement()

ilSCORMPackageParser::getAncestorElement ( int $nr = 1 )

Definition at line 114 of file class.ilSCORMPackageParser.php.

Referenced by handlerCharacterData().

                                                    : ?string
     {
         return ($this->current_element[count($this->current_element) - 1 - $nr]);
     }

Here is the caller graph for this function:

◆ getCurrentElement()

ilSCORMPackageParser::getCurrentElement ( )

returns current element

Definition at line 109 of file class.ilSCORMPackageParser.php.

Referenced by handlerCharacterData().

                                        : ?string
     {
         return ($this->current_element[count($this->current_element) - 1]);
     }

Here is the caller graph for this function:

◆ getCurrentParent()

ilSCORMPackageParser::getCurrentParent ( )

Definition at line 155 of file class.ilSCORMPackageParser.php.

Referenced by handlerBeginTag().

                                       : int
     {
         return $this->parent_stack[count($this->parent_stack) - 1];
     }

Here is the caller graph for this function:

◆ getPackageTitle()

ilSCORMPackageParser::getPackageTitle ( )

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

References ilUtil\stripSlashes().

                                      : string
     {
         return ilUtil::stripSlashes($this->package_title);
     }

Here is the call graph for this function:

◆ handlerBeginTag()

ilSCORMPackageParser::handlerBeginTag	(	XMLParser	$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

handler for begin of element

Parameters

resource \| XMLParser	$a_xml_parser
string	$a_name
array	$a_attribs

Returns: void

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

References $resources, ilTree\addTree(), beginElement(), and getCurrentParent().

Referenced by setHandlers().

                                                                                               : void
     {
         //echo "<br>handlerBeginTag:".$a_name;
         switch ($a_name) {
             case "manifest":
                 $mVersion = "";
                 if (isset($a_attribs["version"])) {
                     $mVersion = $a_attribs["version"];
                 }
                 $manifest = new ilSCORMManifest();
                 $manifest->setSLMId($this->slm_object->getId());
                 $manifest->setImportId($a_attribs["identifier"]);
                 $manifest->setVersion($mVersion);
                 if (isset($a_attribs["xml:base"])) {
                     $manifest->setXmlBase($a_attribs["xml:base"]);
                 }
                 $manifest->create();
                 if (!$this->tree_created) {
                     $this->sc_tree = new ilSCORMTree($this->slm_object->getId());
                     $this->sc_tree->addTree($this->slm_object->getId(), $manifest->getId());
                 } else {
                     $this->sc_tree->insertNode($manifest->getId(), $this->getCurrentParent());
                 }
                 $this->parent_stack[] = $manifest->getId();
                 break;
 
             case "organizations":
                 $organizations = new ilSCORMOrganizations();
                 $organizations->setSLMId($this->slm_object->getId());
                 if (isset($a_attribs["default"])) {
                     $organizations->setDefaultOrganization($a_attribs["default"]);
                 } else {
                     $organizations->setDefaultOrganization("");
                 }
                 $organizations->create();
                 $this->sc_tree->insertNode($organizations->getId(), $this->getCurrentParent());
                 $this->parent_stack[] = $organizations->getId();
                 break;
 
             case "organization":
                 $organization = new ilSCORMOrganization();
                 $organization->setSLMId($this->slm_object->getId());
                 $organization->setImportId($a_attribs["identifier"]);
                 if (isset($a_attribs["structure"])) {
                     $organization->setStructure($a_attribs["structure"]);
                 }
                 $organization->create();
                 $this->current_organization = &$organization;
                 $this->sc_tree->insertNode($organization->getId(), $this->getCurrentParent());
                 $this->parent_stack[] = $organization->getId();
                 break;
 
             case "item":
                 $item = new ilSCORMItem();
                 $item->setSLMId($this->slm_object->getId());
                 $item->setImportId($a_attribs["identifier"]);
                 $item->setIdentifierRef((string) $a_attribs["identifierref"]);
                 if (isset($a_attribs["isvisible"])) {
                     if (strtolower((string) $a_attribs["isvisible"]) !== "false") {
                         $item->setVisible(true);
                     } else {
                         $item->setVisible(false);
                     }
                 }
                 if (isset($a_attribs["parameters"])) {
                     $item->setParameters($a_attribs["parameters"]);
                 }
                 $item->create();
                 $this->sc_tree->insertNode($item->getId(), $this->getCurrentParent());
                 $this->parent_stack[] = $item->getId();
                 $this->item_stack[count($this->item_stack)] = &$item;
                 break;
 
             case "adlcp:prerequisites":
                 $this->item_stack[count($this->item_stack) - 1]->setPrereqType($a_attribs["type"]);
                 break;
 
             case "resources":
                 $resources = new ilSCORMResources();
                 $resources->setSLMId($this->slm_object->getId());
                 if (isset($a_attribs["xml:base"])) {
                     $resources->setXmlBase($a_attribs["xml:base"]);
                 }
                 $resources->create();
                 $this->sc_tree->insertNode($resources->getId(), $this->getCurrentParent());
                 $this->parent_stack[] = $resources->getId();
                 break;
 
             case "resource":
                 $resource = new ilSCORMResource();
                 $resource->setSLMId($this->slm_object->getId());
                 $resource->setImportId($a_attribs["identifier"]);
                 $resource->setResourceType($a_attribs["type"]);
                 if (isset($a_attribs["adlcp:scormtype"])) {
                     $resource->setScormType($a_attribs["adlcp:scormtype"]);
                 }
                 if (isset($a_attribs["xml:base"])) {
                     $resource->setXmlBase($a_attribs["xml:base"]);
                 }
                 if (isset($a_attribs["href"])) {
                     $resource->setHRef($a_attribs["href"]);
                 }
                 $resource->create();
                 $this->current_resource = &$resource;
                 $this->sc_tree->insertNode($resource->getId(), $this->getCurrentParent());
                 $this->parent_stack[] = $resource->getId();
                 break;
 
             case "file":
                 $file = new ilSCORMResourceFile();
                 $file->setHRef($a_attribs["href"]);
                 $this->current_resource->addFile($file);
                 break;
 
             case "dependency":
                 $dependency = new ilSCORMResourceDependency();
                 $dependency->setIdentifierRef($a_attribs["identifierref"]);
                 $this->current_resource->addDependency($dependency);
                 break;
 
         }
         $this->beginElement($a_name);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handlerCharacterData()

ilSCORMPackageParser::handlerCharacterData	(	XMLParser	$a_xml_parser,
		?string	$a_data
	)

handler for character data

Parameters

resource \| XMLParser	$a_xml_parser
string \| null	$a_data

Returns: void

Definition at line 334 of file class.ilSCORMPackageParser.php.

References getAncestorElement(), getCurrentElement(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ilUtil\stripSlashes().

Referenced by setHandlers().

                                                                                   : void
     {
         //echo "<br>handlerCharacterData:".$this->getCurrentElement().":".$a_data;
         // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
         $a_data = preg_replace("/\n/", "", $a_data);
         $a_data = preg_replace("/\t+/", "", $a_data);
         if (!empty($a_data)) {
             switch ($this->getCurrentElement()) {
                 case "title":
                     switch ($this->getAncestorElement(1)) {
                         case "organization":
                             $this->current_organization->setTitle(
                                 ilUtil::stripSlashes($this->current_organization->getTitle() . $a_data)
                             );
                             $this->package_title = ilUtil::stripSlashes($this->current_organization->getTitle());
                             break;
 
                         case "item":
                             $this->item_stack[count($this->item_stack) - 1]->setTitle(
                                 ilUtil::stripSlashes($this->item_stack[count($this->item_stack) - 1]->getTitle() . $a_data)
                             );
                             break;
                     }
                     break;
 
                 case "adlcp:prerequisites":
                     $this->item_stack[count($this->item_stack) - 1]->setPrerequisites($a_data);
                     break;
 
                 case "adlcp:maxtimeallowed":
                     $this->item_stack[count($this->item_stack) - 1]->setMaxTimeAllowed($a_data);
                     break;
 
                 case "adlcp:timelimitaction":
                     $this->item_stack[count($this->item_stack) - 1]->setTimeLimitAction($a_data);
                     break;
 
                 case "adlcp:datafromlms":
                     $this->item_stack[count($this->item_stack) - 1]->setDataFromLms($a_data);
                     break;
 
                 case "adlcp:masteryscore":
                     $this->item_stack[count($this->item_stack) - 1]->setMasteryScore($a_data);
                     break;
 
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handlerEndTag()

ilSCORMPackageParser::handlerEndTag	(	XMLParser	$a_xml_parser,
		string	$a_name
	)

handler for end of element

Parameters

resource \| XMLParser	$a_xml_parser
string	$a_name

Returns: void

Definition at line 297 of file class.ilSCORMPackageParser.php.

References endElement().

Referenced by setHandlers().

                                                                           : void
     {
         //echo "<br>handlerEndTag:".$a_name;
 
         switch ($a_name) {
             case "manifest":
             case "organizations":
             case "resources":
                 array_pop($this->parent_stack);
                 break;
 
             case "organization":
                 $this->current_organization->update();
                 array_pop($this->parent_stack);
                 break;
 
             case "item":
                 $this->item_stack[count($this->item_stack) - 1]->update();
                 unset($this->item_stack[count($this->item_stack) - 1]);
                 array_pop($this->parent_stack);
                 break;
 
             case "resource":
                 $this->current_resource->update();
                 array_pop($this->parent_stack);
                 break;
 
         }
         $this->endElement($a_name);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilSCORMPackageParser::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class

Parameters

resource | XMLParser $a_xml_parser

Returns: void

Definition at line 65 of file class.ilSCORMPackageParser.php.

References handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

                                               : void
     {
         xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
         xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
     }

Here is the call graph for this function:

◆ startParsing()

ilSCORMPackageParser::startParsing ( )

Exceptions

ilSaxParserException

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

                                   : void
     {
         parent::startParsing();
     }

Field Documentation

◆ $current_element

array ilSCORMPackageParser::$current_element

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

◆ $current_organization

object ilSCORMPackageParser::$current_organization

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

◆ $current_resource

object ilSCORMPackageParser::$current_resource

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

◆ $item_stack

array ilSCORMPackageParser::$item_stack

Definition at line 39 of file class.ilSCORMPackageParser.php.

◆ $package_title

string ilSCORMPackageParser::$package_title = ""

Definition at line 40 of file class.ilSCORMPackageParser.php.

◆ $parent_stack

array ilSCORMPackageParser::$parent_stack

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

◆ $sc_tree

ilSCORMTree ilSCORMPackageParser::$sc_tree

private

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

◆ $scorm_tree

object ilSCORMPackageParser::$scorm_tree

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

◆ $slm_object

object ilSCORMPackageParser::$slm_object

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

◆ $tree_created

bool ilSCORMPackageParser::$tree_created

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

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

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

Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beginElement()

◆ buildTag()

◆ endElement()

◆ getAncestorElement()

◆ getCurrentElement()

◆ getCurrentParent()

◆ getPackageTitle()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setHandlers()

◆ startParsing()

Field Documentation

◆ $current_element

◆ $current_organization

◆ $current_resource

◆ $item_stack

◆ $package_title

◆ $parent_stack

◆ $sc_tree

◆ $scorm_tree

◆ $slm_object

◆ $tree_created