ilLearningSequenceXMLParser Class Reference

Inheritance diagram for ilLearningSequenceXMLParser:

Collaboration diagram for ilLearningSequenceXMLParser:

Public Member Functions
	__construct (ilObjLearningSequence $obj, string $xml)
	start ()
	setHandlers ($parser)
	handleBeginTag ( $parser, string $name, array $attributes)
	handleEndTag ($parser, string $name)
	handleCharacterData ($parser, $data)
Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object 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 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...

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

Protected Attributes
	$storing
	$counter

Private Attributes
	$cdata = ''

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...
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()

Detailed Description

Author

Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

Definition at line 8 of file class.ilLearningSequenceXMLParser.php.

Constructor & Destructor Documentation

__construct()

ilLearningSequenceXMLParser::__construct	(	ilObjLearningSequence	$obj,
		string	$xml
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), settings(), and ilSaxParser\setXMLContent().

    {
        parent::__construct();

        $this->obj = $obj;
        $this->storing = false;
        $this->setXMLContent($xml);

        $this->object = array();
        $this->ls_item_data = array();
        $this->settings = array();
        $this->lp_settings = array();
        $this->lp_settings["lp_item_ref_ids"] = array();
        $this->counter = 0;
    }

Here is the call graph for this function:

Member Function Documentation

beginStoreCData()

ilLearningSequenceXMLParser::beginStoreCData ( )

protected

Definition at line 139 of file class.ilLearningSequenceXMLParser.php.

Referenced by handleBeginTag().

    {
        $this->storing = true;
    }

Here is the caller graph for this function:

endStoreCData()

ilLearningSequenceXMLParser::endStoreCData ( )

protected

Definition at line 144 of file class.ilLearningSequenceXMLParser.php.

Referenced by handleEndTag().

    {
        $this->storing = false;
    }

Here is the caller graph for this function:

handleBeginTag()

ilLearningSequenceXMLParser::handleBeginTag	(		$parser,
		string	$name,
		array	$attributes
	)

Definition at line 59 of file class.ilLearningSequenceXMLParser.php.

References $counter, $name, and beginStoreCData().

      {
        $this->actual_name = $name;

        switch ($name) {
            case "lso":
                $this->object["ref_id"] = $attributes["ref_id"];
                break;
            case "ls_item":
                $this->ls_item_data[$this->counter]["id"] = $attributes["id"];
                $this->beginStoreCData();
                break;
            default:
                break;
        }
    }

Here is the call graph for this function:

handleCharacterData()

ilLearningSequenceXMLParser::handleCharacterData	(		$parser,
			$data
	)

Definition at line 133 of file class.ilLearningSequenceXMLParser.php.

References $data, and storeData().

    {
        $this->cdata .= ($data ?? "");
        $this->storeData();
    }

Here is the call graph for this function:

handleEndTag()

ilLearningSequenceXMLParser::handleEndTag	(		$parser,
		string	$name
	)

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

References endStoreCData(), and settings().

    {
        $this->cdata = trim($this->cdata);

        switch ($name) {
            case "title":
                $this->obj->setTitle(trim($this->cdata));
                break;
            case "description":
                $this->obj->setDescription(trim($this->cdata));
                break;
            case "ls_item":
                $this->endStoreCData();
                break;
            case "ls_item_order_number":
                $this->counter++;
                break;
            case "abstract":
                $this->settings["abstract"] = base64_decode(trim($this->cdata));
                break;
            case "extro":
                $this->settings["extro"] = base64_decode(trim($this->cdata));
                break;
            case "abstract_img":
                $this->settings["abstract_img"] = trim($this->cdata);
                break;
            case "extro_img":
                $this->settings["extro_img"] = trim($this->cdata);
                break;
            case "abstract_img_data":
                $this->settings["abstract_img_data"] = trim($this->cdata);
                break;
            case "extro_img_data":
                $this->settings["extro_img_data"] = trim($this->cdata);
                break;
            case "members_gallery":
                $this->settings["members_gallery"] = trim($this->cdata);
                break;
            case "lp_item_ref_id":
                $this->lp_settings["lp_item_ref_ids"][] = trim($this->cdata);
                break;
            case "lp_type":
                $this->lp_settings["lp_type"] = trim($this->cdata);
                break;
            case "lp_mode":
                $this->lp_settings["lp_mode"] = trim($this->cdata);
                break;
            default:
                break;
        }

        $this->cdata = '';
    }

Here is the call graph for this function:

setHandlers()

ilLearningSequenceXMLParser::setHandlers

(

$parser

)

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

References $parser.

    {
        xml_set_object($parser, $this);
        xml_set_element_handler($parser, "handleBeginTag", "handleEndTag");
        xml_set_character_data_handler($parser, 'handleCharacterData');
    }

start()

ilLearningSequenceXMLParser::start

(

)

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

References $ret, and ilSaxParser\startParsing().

                            : array
    {
        $this->startParsing();

        $ret = array();
        $ret["object"] = $this->object;
        $ret["item_data"] = $this->ls_item_data;
        $ret["settings"] = $this->settings;
        $ret["lp_settings"] = $this->lp_settings;

        return $ret;
    }

Here is the call graph for this function:

storeData()

ilLearningSequenceXMLParser::storeData ( )

protected

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

References $counter.

Referenced by handleCharacterData().

    {
        if ($this->storing) {
            $this->ls_item_data[$this->counter][$this->actual_name] = $this->cdata ?? "";
        }
    }

Here is the caller graph for this function:

Field Documentation

$cdata

ilLearningSequenceXMLParser::$cdata = ''

private

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

$counter

ilLearningSequenceXMLParser::$counter

protected

Definition at line 18 of file class.ilLearningSequenceXMLParser.php.

Referenced by handleBeginTag(), and storeData().

$storing

ilLearningSequenceXMLParser::$storing

protected

Definition at line 13 of file class.ilLearningSequenceXMLParser.php.

---

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

• Modules/LearningSequence/classes/Xml/class.ilLearningSequenceXMLParser.php