Inheritance diagram for ilLearningSequenceXMLParser:

Collaboration diagram for ilLearningSequenceXMLParser:

Public Member Functions
	__construct (ilObjLearningSequence $obj, string $xml)

	start ()

	setHandlers ($a_xml_parser)

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

	handleEndTag ($parser, string $name)

	handleCharacterData ($parser, $data)

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)

Protected Member Functions
	beginStoreCData ()

	endStoreCData ()

	storeData ()

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
ilObjLearningSequence	$obj

bool	$storing = false

array	$object = []

array	$ls_item_data = []

array	$settings = []

array	$lp_settings = []

int	$counter = 0

string	$actual_name

string	$cdata = ''

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

    {
        parent::__construct();
 
        $this->obj = $obj;
        $this->setXMLContent($xml);
        $this->lp_settings["lp_item_ref_ids"] = [];
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ beginStoreCData()

ilLearningSequenceXMLParser::beginStoreCData ( )

protected

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

                                        : void
    {
        $this->storing = true;
    }

Referenced by handleBeginTag().

Here is the caller graph for this function:

◆ endStoreCData()

ilLearningSequenceXMLParser::endStoreCData ( )

protected

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

                                      : void
    {
        $this->storing = false;
    }

◆ handleBeginTag()

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

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

     : void {
        $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;
        }
    }

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

Here is the call graph for this function:

◆ handleCharacterData()

ilLearningSequenceXMLParser::handleCharacterData	(	$parser,
		$data
	)

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

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

References $data.

◆ handleEndTag()

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

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

                                                       : void
    {
        $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 = '';
    }

References $name, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ setHandlers()

ilLearningSequenceXMLParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

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

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

◆ start()

ilLearningSequenceXMLParser::start ( )

Returns: array<string, mixed>

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

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

References $lp_settings, $ls_item_data, $object, $settings, and ilSaxParser\startParsing().

Here is the call graph for this function:

◆ storeData()

ilLearningSequenceXMLParser::storeData ( )

protected

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

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