Inheritance diagram for ilSCORMPackageParser:

Collaboration diagram for ilSCORMPackageParser:

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

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

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

	getPackageTitle ()

	beginElement ($a_name)

	endElement ($a_name)

	getCurrentElement ()

	getAncestorElement ($nr=1)

	getOpenCount ($a_name)

	buildTag ($type, $name, $attr="")
	generate a tag with given name and attributes More...

	getCurrentParent ()

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

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

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

Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object @access public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

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

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

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

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling More...

Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
	$cnt

	$current_element

	$slm_object

	$parent_stack

	$tree_created

	$scorm_tree

	$current_organization

	$current_resource

	$item_stack

	$package_title = ""

Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Detailed Description

SCORM Package Parser.

Author

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSCORMPackageParser::__construct	(	&	$a_slm_object,
			$a_xml_file
	)

Constructor.

Parameters

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

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

    {
        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();
    }

Member Function Documentation

◆ beginElement()

ilSCORMPackageParser::beginElement ( $a_name )

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

    {
        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;
    }

Referenced by handlerBeginTag().

Here is the caller graph for this function:

◆ buildTag()

ilSCORMPackageParser::buildTag	(	$type,
		$name,
		$attr = `""`
	)

generate a tag with given name and attributes

Parameters

string	"start" \| "end" for starting or ending tag
string	element/tag name
array	array of attributes

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

    {
        $tag = "<";
 
        if ($type == "end") {
            $tag.= "/";
        }
 
        $tag.= $name;
 
        if (is_array($attr)) {
            while (list($k, $v) = each($attr)) {
                $tag.= " " . $k . "=\"$v\"";
            }
        }
 
        $tag.= ">";
 
        return $tag;
    }

References $name, $tag, and $type.

◆ endElement()

ilSCORMPackageParser::endElement ( $a_name )

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

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

Referenced by handlerEndTag().

Here is the caller graph for this function:

◆ getAncestorElement()

ilSCORMPackageParser::getAncestorElement ( $nr = 1 )

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

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

Referenced by handlerCharacterData().

Here is the caller graph for this function:

◆ getCurrentElement()

ilSCORMPackageParser::getCurrentElement ( )

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

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

Referenced by handlerCharacterData().

Here is the caller graph for this function:

◆ getCurrentParent()

ilSCORMPackageParser::getCurrentParent ( )

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

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

◆ getOpenCount()

ilSCORMPackageParser::getOpenCount ( $a_name )

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

    {
        if (isset($this->cnt[$a_name])) {
            return $this->cnt[$a_name];
        } else {
            return 0;
        }
    }

◆ getPackageTitle()

ilSCORMPackageParser::getPackageTitle ( )

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

    {
        return $this->package_title;
    }

References $package_title.

◆ handlerBeginTag()

ilSCORMPackageParser::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

handler for begin of element

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

    {
        //echo "<br>handlerBeginTag:".$a_name;
        switch ($a_name) {
            case "manifest":
                $manifest = new ilSCORMManifest();
                $manifest->setSLMId($this->slm_object->getId());
                $manifest->setImportId($a_attribs["identifier"]);
                $manifest->setVersion($a_attribs["version"]);
                $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());
                }
                array_push($this->parent_stack, $manifest->getId());
                break;
 
            case "organizations":
                $organizations = new ilSCORMOrganizations();
                $organizations->setSLMId($this->slm_object->getId());
                $organizations->setDefaultOrganization($a_attribs["default"]);
                $organizations->create();
                $this->sc_tree->insertNode($organizations->getId(), $this->getCurrentParent());
                array_push($this->parent_stack, $organizations->getId());
                break;
 
            case "organization":
                $organization = new ilSCORMOrganization();
                $organization->setSLMId($this->slm_object->getId());
                $organization->setImportId($a_attribs["identifier"]);
                $organization->setStructure($a_attribs["structure"]);
                $organization->create();
                $this->current_organization =&$organization;
                $this->sc_tree->insertNode($organization->getId(), $this->getCurrentParent());
                array_push($this->parent_stack, $organization->getId());
                break;
 
            case "item":
                $item = new ilSCORMItem();
                $item->setSLMId($this->slm_object->getId());
                $item->setImportId($a_attribs["identifier"]);
                $item->setIdentifierRef($a_attribs["identifierref"]);
                if (strtolower($a_attribs["isvisible"]) != "false") {
                    $item->setVisible(true);
                } else {
                    $item->setVisible(false);
                }
                $item->setParameters($a_attribs["parameters"]);
                $item->create();
                $this->sc_tree->insertNode($item->getId(), $this->getCurrentParent());
                array_push($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());
                $resources->setXmlBase($a_attribs["xml:base"]);
                $resources->create();
                $this->sc_tree->insertNode($resources->getId(), $this->getCurrentParent());
                array_push($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"]);
                $resource->setScormType($a_attribs["adlcp:scormtype"]);
                $resource->setXmlBase($a_attribs["xml:base"]);
                $resource->setHRef($a_attribs["href"]);
                $resource->create();
                $this->current_resource =&$resource;
                $this->sc_tree->insertNode($resource->getId(), $this->getCurrentParent());
                array_push($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);
    }

References $file, $organizations, and beginElement().

Here is the call graph for this function:

◆ handlerCharacterData()

ilSCORMPackageParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

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

    {
        //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(
                                $this->current_organization->getTitle() . $a_data
                            );
                            $this->package_title = $this->current_organization->getTitle();
                            break;
 
                        case "item":
                            $this->item_stack[count($this->item_stack) - 1]->setTitle(
                                $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;
 
            }
        }
    }

References getAncestorElement(), and getCurrentElement().

Here is the call graph for this function:

◆ handlerEndTag()

ilSCORMPackageParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

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

    {
        //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);
    }

References endElement().

Here is the call graph for this function:

◆ setHandlers()

ilSCORMPackageParser::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class @access private

Reimplemented from ilSaxParser.

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

    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
    }

◆ startParsing()

ilSCORMPackageParser::startParsing ( )

stores xml data in array

@access private

Exceptions

ilSaxParserException or ILIAS Error

Reimplemented from ilSaxParser.

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

    {
        parent::startParsing();
    }

Field Documentation

◆ $cnt

ilSCORMPackageParser::$cnt

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

◆ $current_element

ilSCORMPackageParser::$current_element

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

◆ $current_organization

ilSCORMPackageParser::$current_organization

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

◆ $current_resource

ilSCORMPackageParser::$current_resource

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

◆ $item_stack

ilSCORMPackageParser::$item_stack

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

◆ $package_title

ilSCORMPackageParser::$package_title = ""

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

Referenced by getPackageTitle().

◆ $parent_stack

ilSCORMPackageParser::$parent_stack

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

◆ $scorm_tree

ilSCORMPackageParser::$scorm_tree

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

◆ $slm_object

ilSCORMPackageParser::$slm_object

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

◆ $tree_created

ilSCORMPackageParser::$tree_created

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

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

Modules/ScormAicc/classes/SCORM/class.ilSCORMPackageParser.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beginElement()

◆ buildTag()

◆ endElement()

◆ getAncestorElement()

◆ getCurrentElement()

◆ getCurrentParent()

◆ getOpenCount()

◆ getPackageTitle()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setHandlers()

◆ startParsing()

Field Documentation

◆ $cnt

◆ $current_element

◆ $current_organization

◆ $current_resource

◆ $item_stack

◆ $package_title

◆ $parent_stack

◆ $scorm_tree

◆ $slm_object

◆ $tree_created