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

Inheritance diagram for ilSaxParser:

Collaboration diagram for ilSaxParser:

Public Member Functions
	__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)

Data Fields
string	$xml_file

bool	$throw_exception = false

Protected Member Functions
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
ilLanguage	$lng = null

Private Member Functions
	setOptions ($a_xml_parser)

	freeParser ($a_xml_parser)

Private Attributes
const	TYPE_FILE = 'file'

const	TYPE_STRING = 'string'

string	$input_type
	XML-Content type 'file' or 'string' If you choose file set the filename in constructor If you choose 'String' call the constructor with no argument and use setXMLContent() More...

string	$xml_content
	XML-Content in case of content type 'string'. More...

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 Base class for sax-based expat parsing extended classes need to overwrite the method setHandlers and implement their own handler methods

Deprecated:: We should move to native XML-Parsing

Definition at line 25 of file class.ilSaxParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilSaxParser::__construct	(	?string	$path_to_file = `''`,
		?bool	$throw_exception = `false`
	)

Definition at line 49 of file class.ilSaxParser.php.

References $DIC, and ILIAS\Repository\lng().

       {
         global $DIC;
 
         if ($path_to_file !== null && $path_to_file !== '') {
             $this->xml_file = $path_to_file;
             $this->input_type = self::TYPE_FILE;
         } else {
             $this->input_type = self::TYPE_STRING;
             $this->xml_content = '';
         }
 
         $this->throw_exception = $throw_exception ?? false;
         $this->lng = $DIC->isDependencyAvailable('language')
             ? $DIC->language()
             : null;
     }

Here is the call graph for this function:

Member Function Documentation

◆ createParser()

ilSaxParser::createParser ( )

Returns: resource

Exceptions

ilSaxParserException or ILIAS Error

Definition at line 118 of file class.ilSaxParser.php.

References handleError().

Referenced by startParsing().

     {
         $xml_parser = xml_parser_create("UTF-8");
         if (!is_resource($xml_parser) && !is_object($xml_parser)) {
             $this->handleError("Cannot create an XML parser handle");
         }
         return $xml_parser;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freeParser()

ilSaxParser::freeParser ( $a_xml_parser )

private

Parameters

resource $a_xml_parser

Exceptions

ilSaxParserException

Definition at line 198 of file class.ilSaxParser.php.

References handleError().

Referenced by startParsing().

                                               : void
     {
         if (!xml_parser_free($a_xml_parser)) {
             $this->handleError("Error freeing xml parser handle");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInputType()

ilSaxParser::getInputType ( )

Definition at line 80 of file class.ilSaxParser.php.

References $input_type.

Referenced by SurveyImportParser\parse(), parse(), ilPluginReader\startParsing(), and startParsing().

                                   : string
     {
         return $this->input_type;
     }

Here is the caller graph for this function:

◆ getXMLContent()

ilSaxParser::getXMLContent ( )

Definition at line 75 of file class.ilSaxParser.php.

References $xml_content.

Referenced by SurveyImportParser\parse(), and parse().

                                    : string
     {
         return $this->xml_content;
     }

Here is the caller graph for this function:

◆ handleError()

ilSaxParser::handleError ( string $message )

protected

Exceptions

ilSaxParserException

Definition at line 187 of file class.ilSaxParser.php.

Referenced by createParser(), freeParser(), openXMLFile(), parse(), and startParsing().

                                                    : void
     {
         if ($this->throw_exception) {
             throw new ilSaxParserException($message);
         }
     }

Here is the caller graph for this function:

◆ openXMLFile()

ilSaxParser::openXMLFile ( )

protected

Returns: resource

Exceptions

ilSaxParserException

Definition at line 143 of file class.ilSaxParser.php.

References handleError().

Referenced by startParsing().

     {
         if (!($fp = fopen($this->xml_file, 'r'))) {
             $this->handleError("Cannot open xml file \"" . $this->xml_file . "\"");
         }
         return $fp;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilSaxParser::parse	(	$a_xml_parser,
		$a_fp = `null`
	)

Parameters

resource	$a_xml_parser
resource \| null	$a_fp

Exceptions

ilSaxParserException

Definition at line 156 of file class.ilSaxParser.php.

References $data, getInputType(), getXMLContent(), and handleError().

Referenced by startParsing().

                                                       : void
     {
         $parse_status = true;
         switch ($this->getInputType()) {
             case self::TYPE_FILE:
                 while ($data = fread($a_fp, 4096)) {
                     $parse_status = xml_parse($a_xml_parser, $data, feof($a_fp));
                 }
                 break;
 
             case self::TYPE_STRING:
                 $parse_status = xml_parse($a_xml_parser, $this->getXMLContent());
                 break;
         }
         $error_code = xml_get_error_code($a_xml_parser);
         if (!$parse_status && ($error_code !== XML_ERROR_NONE)) {
             $error = sprintf(
                 "XML Parse Error: %s at line %s, col %s (Code: %s)",
                 xml_error_string($error_code),
                 xml_get_current_line_number($a_xml_parser),
                 xml_get_current_column_number($a_xml_parser),
                 $error_code
             );
 
             $this->handleError($error);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilSaxParser::setHandlers ( $a_xml_parser )

abstract

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Referenced by setOptions(), and startParsing().

Here is the caller graph for this function:

◆ setOptions()

ilSaxParser::setOptions ( $a_xml_parser )

private

Definition at line 128 of file class.ilSaxParser.php.

References setHandlers().

Referenced by startParsing().

                                               : void
     {
         xml_parser_set_option($a_xml_parser, XML_OPTION_CASE_FOLDING, false);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setThrowException()

ilSaxParser::setThrowException ( bool $throw_exception )

protected

Definition at line 206 of file class.ilSaxParser.php.

References $throw_exception.

Referenced by ilSoapMailXmlParser\__construct(), ilFolderXmlParser\__construct(), and ilWebLinkXmlParser\__construct().

                                                                : void
     {
         $this->throw_exception = $throw_exception;
     }

Here is the caller graph for this function:

◆ setXMLContent()

ilSaxParser::setXMLContent ( string $a_xml_content )

Definition at line 69 of file class.ilSaxParser.php.

                                                         : void
     {
         $this->xml_content = $a_xml_content;
         $this->input_type = self::TYPE_STRING;
     }

Here is the caller graph for this function:

◆ startParsing()

ilSaxParser::startParsing ( )

stores xml data in array

Exceptions

ilSaxParserException

Definition at line 89 of file class.ilSaxParser.php.

References createParser(), freeParser(), getInputType(), handleError(), openXMLFile(), parse(), setHandlers(), and setOptions().

Referenced by ilManifestParser\__construct(), ilDataSetImportParser\__construct(), ilSoapMailXmlParser\start(), ilFolderXmlParser\start(), ilLearningSequenceXMLParser\start(), ilExerciseXMLParser\start(), and ilFileXMLParser\start().

                                   : void
     {
         $xml_parser = $this->createParser();
         $this->setOptions($xml_parser);
         $this->setHandlers($xml_parser);
 
         switch ($this->getInputType()) {
             case self::TYPE_FILE:
                 $fp = $this->openXMLFile();
                 $this->parse($xml_parser, $fp);
                 break;
 
             case self::TYPE_STRING:
                 $this->parse($xml_parser);
                 break;
 
             default:
                 $this->handleError(
                     "No input type given. Set filename in constructor or choose setXMLContent()"
                 );
                 break;
         }
         $this->freeParser($xml_parser);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $input_type

string ilSaxParser::$input_type

private

XML-Content type 'file' or 'string' If you choose file set the filename in constructor If you choose 'String' call the constructor with no argument and use setXMLContent()

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

Referenced by getInputType().

◆ $lng

ilLanguage ilSaxParser::$lng = null

protected

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

Referenced by ilQuestionPageParser\__construct(), ilQTIParser\__construct(), ilUserImportParser\getProtocolAsHTML(), ilUserImportParser\importBeginTag(), ilUserImportParser\importEndTag(), ilUserImportParser\verifyBeginTag(), and ilUserImportParser\verifyEndTag().

◆ $throw_exception

bool ilSaxParser::$throw_exception = false

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

Referenced by ilObjectXMLParser\__construct(), and setThrowException().

◆ $xml_content

string ilSaxParser::$xml_content

private

XML-Content in case of content type 'string'.

Definition at line 40 of file class.ilSaxParser.php.

Referenced by getXMLContent().

◆ $xml_file

string ilSaxParser::$xml_file

Definition at line 44 of file class.ilSaxParser.php.

◆ TYPE_FILE

const ilSaxParser::TYPE_FILE = 'file'

private

Definition at line 27 of file class.ilSaxParser.php.

◆ TYPE_STRING

const ilSaxParser::TYPE_STRING = 'string'

private

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

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

Services/Xml/classes/class.ilSaxParser.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createParser()

◆ freeParser()

◆ getInputType()

◆ getXMLContent()

◆ handleError()

◆ openXMLFile()

◆ parse()

◆ setHandlers()

◆ setOptions()

◆ setThrowException()

◆ setXMLContent()

◆ startParsing()

Field Documentation

◆ $input_type

◆ $lng

◆ $throw_exception

◆ $xml_content

◆ $xml_file

◆ TYPE_FILE

◆ TYPE_STRING