class.ilSaxController.php

Go to the documentation of this file.

<?php

/******************************************************************************
 *
 * This file is part of ILIAS, a powerful learning management system.
 *
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 *
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 *      https://www.ilias.de
 *      https://github.com/ILIAS-eLearning
 *
 *****************************************************************************/
class ilSaxController
{
    protected ?ilSaxSubsetParser $default_handler = null;
    protected array $element_handlers = [];
    protected array $handlers_in_use = [];
    protected $handler_in_use = null;
    protected ?ilSaxSubsetParser $current_handler;

    public function setHandlers($a_xml_parser): void
    {
        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');
    }

    public function setDefaultElementHandler(ilSaxSubsetParser $a_default_parser): void
    {
        $this->default_handler = $a_default_parser;
    }

    public function setElementHandler(ilSaxSubsetParser $a_parser, string $a_element): void
    {
        $this->element_handlers[$a_element] = $a_parser;
        $this->handlers_in_use[$a_element] = false;
    }

    public function handlerBeginTag($a_xml_parser, string $a_name, array $a_attribs): void
    {
        if (isset($this->element_handlers[$a_name]) or $this->handler_in_use) {
            if (!$this->handler_in_use) {
                $this->handler_in_use = $this->element_handlers[$a_name];
            }
            // Forward to handler
            $this->current_handler = $this->handler_in_use;
            $this->current_handler->handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
            return;
        }
        // Call default handler
        $this->handler_in_use = false;
        $this->current_handler = $this->default_handler;
        $this->default_handler->handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
    }

    public function handlerEndTag($a_xml_parser, string $a_name): void
    {
        if (isset($this->element_handlers[$a_name])) {
            $this->handler_in_use = false;
            $this->current_handler = $this->element_handlers[$a_name];
            $this->element_handlers[$a_name]->handlerEndTag($a_xml_parser, $a_name);
            return;
        } elseif ($this->handler_in_use) {
            $this->current_handler = $this->handler_in_use;
            $this->current_handler->handlerEndTag($a_xml_parser, $a_name);
            return;
        }
        $this->handler_in_use = false;
        $this->current_handler = $this->default_handler;
        $this->default_handler->handlerEndTag($a_xml_parser, $a_name);
    }

    public function handlerCharacterData(
        $a_xml_parser,
        string $a_data
    ): void {
        $this->current_handler->handlerCharacterData(
            $a_xml_parser,
            $a_data
        );
    }
}