ilSaxController Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSaxController:

Public Member Functions
	setHandlers ($a_xml_parser)
	Set handlers. More...
	setDefaultElementHandler (ilSaxSubsetParser $a_default_parser)
	Set default element handler. More...
	setElementHandler (ilSaxSubsetParser $a_parser, string $a_element)
	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	default handlerBeginTag More...
	handlerEndTag ($a_xml_parser, string $a_name)
	handler for end of element More...
	handlerCharacterData ( $a_xml_parser, string $a_data)
	handler for character data More...

Protected Attributes
ilSaxSubsetParser	$default_handler = null
array	$element_handlers = []
array	$handlers_in_use = []
	$handler_in_use = null
ilSaxSubsetParser	$current_handler

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

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 Controller class for sax element handlers. Could be used to split the xml handling in different responsible classes. Use the methods addElementHandler, addDefaultElementHandler

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 26 of file class.ilSaxController.php.

Member Function Documentation

handlerBeginTag()

ilSaxController::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

default handlerBeginTag

@access public

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name
array	$a_attribs	element attributes array

Definition at line 74 of file class.ilSaxController.php.

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

References $default_handler, $handler_in_use, and ilSaxSubsetParser\handlerBeginTag().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

handlerCharacterData()

ilSaxController::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

Definition at line 120 of file class.ilSaxController.php.

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

Referenced by setHandlers().

Here is the caller graph for this function:

handlerEndTag()

ilSaxController::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

Definition at line 97 of file class.ilSaxController.php.

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

References $default_handler, $handler_in_use, and ilSaxSubsetParser\handlerEndTag().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

setDefaultElementHandler()

ilSaxController::setDefaultElementHandler

(

ilSaxSubsetParser

$a_default_parser

)

Set default element handler.

Definition at line 51 of file class.ilSaxController.php.

                                                                                 : void
    {
        $this->default_handler = $a_default_parser;
    }

setElementHandler()

ilSaxController::setElementHandler	(	ilSaxSubsetParser	$a_parser,
		string	$a_element
	)

Parameters

ilSaxSubsetParser	$a_parser	object that parses the xmlsubset must implement interface ilSaxSubsetParser
string	$a_element	element name that triggers the handler

Definition at line 60 of file class.ilSaxController.php.

                                                                                     : void
    {
        $this->element_handlers[$a_element] = $a_parser;
        $this->handlers_in_use[$a_element] = false;
    }

setHandlers()

ilSaxController::setHandlers

(

$a_xml_parser

)

Set handlers.

Parameters

resource

xml_parser instance

Definition at line 42 of file class.ilSaxController.php.

                                              : void
    {
        xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
    }

References handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

Here is the call graph for this function:

Field Documentation

$current_handler

ilSaxSubsetParser ilSaxController::$current_handler

protected

Definition at line 35 of file class.ilSaxController.php.

$default_handler

ilSaxSubsetParser ilSaxController::$default_handler = null

protected

Definition at line 28 of file class.ilSaxController.php.

Referenced by handlerBeginTag(), and handlerEndTag().

$element_handlers

array ilSaxController::$element_handlers = []

protected

Definition at line 29 of file class.ilSaxController.php.

$handler_in_use

ilSaxController::$handler_in_use = null

protected

Definition at line 34 of file class.ilSaxController.php.

Referenced by handlerBeginTag(), and handlerEndTag().

$handlers_in_use

array ilSaxController::$handlers_in_use = []

protected

Definition at line 30 of file class.ilSaxController.php.

---

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

• components/ILIAS/Xml/classes/class.ilSaxController.php