Inheritance diagram for ilLearningSequenceXMLParser:

Collaboration diagram for ilLearningSequenceXMLParser:

Public Member Functions
	__construct (protected 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 Attributes
array	$object

array	$ls_item_data

array	$settings

array	$lp_settings

int	$counter

string	$actual_name

string	$cdata = ''

string	$current_container_setting = ''

bool	$in_item_conditions = false

array	$current_condition = null

array	$current_table = null

array	$current_row = null

string	$current_col_name = ''

bool	$in_col = false

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        parent::__construct();
 
        $this->setXMLContent($xml);
 
        $this->object = [];
        $this->ls_item_data = [];
        $this->settings = [];
        $this->lp_settings = [];
        $this->lp_settings["lp_item_ref_ids"] = [];
        $this->counter = 0;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ handleBeginTag()

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

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

     : void {
        $this->actual_name = $name;
 
        switch ($name) {
            case Writer::TAG_LSO:
                $this->object["ref_id"] = $attributes["ref_id"];
                $this->settings["members_gallery"] = $attributes['members_gallery'];
                $this->settings["mode"] = $attributes['mode'];
                $this->settings["start_ref_id"] = $attributes['start_ref_id'];
                $this->settings["end_ref_id"] = $attributes['end_ref_id'];
                break;
            case Writer::TAG_LPSETTING:
                $this->lp_settings["lp_type"] = $attributes['type'];
                $this->lp_settings["lp_mode"] = $attributes['mode'];
                $this->lp_settings["lp_item_ref_ids"] = [];
                break;
 
            case Writer::TAG_LSITEM:
                $this->counter = (int) $attributes["ref_id"];
                $this->ls_item_data[$this->counter]["ref_id"] = $attributes["ref_id"];
                if (isset($attributes["position"])) {
                    $this->ls_item_data[$this->counter]["position"] = $attributes["position"];
                }
                break;
 
            case Writer::TAG_CONDITION:
                $this->ls_item_data[$this->counter]["condition_type"] = $attributes["type"];
                $this->ls_item_data[$this->counter]["condition_value"] = '';
                break;
 
            case Writer::TAG_ITEM_CONDITIONS:
                $this->in_item_conditions = true;
                if (!isset($this->ls_item_data[$this->counter]["conditions"])) {
                    $this->ls_item_data[$this->counter]["conditions"] = [];
                }
                break;
 
            case Writer::TAG_ITEM_CONDITION:
                if ($this->in_item_conditions) {
                    $this->current_condition = [
                        'type' => $attributes['type'] ?? '',
                        'subtype' => $attributes['subtype'] ?? null,
                        'data' => [],
                    ];
                }
                break;
 
            case 'Table':
                if ($this->current_condition !== null) {
                    $this->current_table = [
                        'table' => $attributes['name'] ?? '',
                        'fields' => [],
                        'rows' => [],
                    ];
                }
                break;
 
            case 'Field':
                if ($this->current_table !== null) {
                    $field_name = $attributes['name'] ?? '';
                    $meta = $attributes;
                    unset($meta['name']);
                    $this->current_table['fields'][$field_name] = $meta;
                }
                break;
 
            case 'Row':
                if ($this->current_table !== null) {
                    $this->current_row = [];
                }
                break;
 
            case 'Col':
                if ($this->current_row !== null) {
                    $this->current_col_name = $attributes['name'] ?? '';
                    $this->in_col = true;
                }
                break;
 
            case Writer::TAG_CONTAINERSETTING:
                $this->current_container_setting = $attributes['id'];
                break;
 
            default:
                break;
        }
    }

References $counter, ILIAS\Repository\int(), and ILIAS\Repository\settings().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleCharacterData()

ilLearningSequenceXMLParser::handleCharacterData	(	$parser,
		$data
	)

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

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

References $data.

Referenced by setHandlers().

Here is the caller graph for this function:

◆ handleEndTag()

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

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

                                                       : void
    {
        $this->cdata = trim($this->cdata);
 
        switch ($name) {
            case Writer::TAG_LPREFID:
                $this->lp_settings["lp_item_ref_ids"][] = trim($this->cdata);
                break;
 
            case Writer::TAG_CONTAINERSETTING:
                if ($this->current_container_setting) {
                    ilContainer::_writeContainerSetting(
                        $this->obj->getId(),
                        $this->current_container_setting,
                        trim($this->cdata)
                    );
                }
                break;
 
            case Writer::TAG_TITLE:
                $this->obj->setTitle(trim($this->cdata));
                break;
 
            case Writer::TAG_DESCRIPTION:
                $this->obj->setDescription(trim($this->cdata));
                break;
 
            case 'Col':
                if ($this->current_row !== null && $this->in_col) {
                    $this->current_row[$this->current_col_name] = $this->cdata;
                }
                $this->in_col = false;
                $this->current_col_name = '';
                break;
 
            case 'Row':
                if ($this->current_table !== null && $this->current_row !== null) {
                    $this->current_table['rows'][] = $this->current_row;
                }
                $this->current_row = null;
                break;
 
            case 'Table':
                if ($this->current_condition !== null && $this->current_table !== null) {
                    $this->current_condition['data'][] = $this->current_table;
                }
                $this->current_table = null;
                break;
 
            case Writer::TAG_ITEM_CONDITION:
                if ($this->in_item_conditions && $this->current_condition !== null) {
                    $this->ls_item_data[$this->counter]["conditions"][] = $this->current_condition;
                }
                $this->current_condition = null;
                break;
 
            case Writer::TAG_ITEM_CONDITIONS:
                $this->in_item_conditions = false;
                break;
 
            default:
                break;
        }
 
        $this->cdata = '';
    }

References ilContainer\_writeContainerSetting().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilLearningSequenceXMLParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

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

                                              : void
    {
        xml_set_element_handler($a_xml_parser, $this->handleBeginTag(...), $this->handleEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handleCharacterData(...));
    }

References handleBeginTag(), handleCharacterData(), and handleEndTag().

Here is the call graph for this function:

◆ start()

ilLearningSequenceXMLParser::start ( )

Returns: array<string, mixed>

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

                           : array
    {
        $this->startParsing();
        $ret = [];
        $ret["object"] = $this->object;
        $ret["item_data"] = $this->ls_item_data;
        $ret["settings"] = $this->settings;
        $ret["lp_settings"] = $this->lp_settings;
 
        return $ret;
    }