class.ilLearningSequenceXMLParser.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ilLearningSequenceXMLWriter as Writer;

class ilLearningSequenceXMLParser extends ilSaxParser
{
    protected array $object;

    protected array $ls_item_data;

    protected array $settings;

    protected array $lp_settings;
    protected int $counter;
    protected string $actual_name;
    protected string $cdata = '';
    protected string $current_container_setting = '';

    public function __construct(
        protected ilObjLearningSequence $obj,
        string $xml
    ) {
        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;
    }

    public function start(): 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;
    }

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

    public function handleBeginTag(
        $parser,
        string $name,
        array $attributes
    ): 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'];
                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"];
                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_CONTAINERSETTING:
                $this->current_container_setting = $attributes['id'];
                break;

            default:
                break;
        }
    }

    public function handleEndTag($parser, string $name): 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;

            default:
                break;
        }

        $this->cdata = '';
    }

    public function handleCharacterData($parser, $data): void
    {
        $this->cdata .= ($data ?? "");
    }
}