ilSaxParser Class Reference

Base class for sax-based expat parsing extended classes need to overwrite the method setHandlers and implement their own handler methods. More...

Inheritance diagram for ilSaxParser:

Collaboration diagram for ilSaxParser:

Public Member Functions
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object public. More...
	setXMLContent ($a_xml_content)
	getXMLContent ()
	getInputType ()
	startParsing ()
	stores xml data in array More...
	createParser ()
	create parser More...
	setOptions ($a_xml_parser)
	set parser options More...
	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...
	openXMLFile ()
	open xml file More...
	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...
	freeParser ($a_xml_parser)
	free xml parser handle More...
	setThrowException ($throwException)
	set error handling More...
Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...
	_PEAR ()
	Destructor (the emulated type of...). More...
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...
	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...
	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...
	popExpect ()
	This method pops one element off the expected error codes stack. More...
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...
&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...
	popErrorHandling ()
	Pop the last error handler used. More...
	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
	$input_type = null
	$xml_content = ''
	$ilias
	$lng
	$xml_file
	$throwException = false
Data Fields inherited from PEAR
	$_debug = false
	$_default_error_mode = null
	$_default_error_options = null
	$_default_error_handler = ''
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Protected Member Functions
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...
static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Detailed Description

Base class for sax-based expat parsing extended classes need to overwrite the method setHandlers and implement their own handler methods.

Author

Stefan Meyer <smeyer>

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilSaxParser::__construct	(		$a_xml_file = '',
			$throwException = false
	)

Constructor setup ILIAS global object public.

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

References $ilias, $lng, and $throwException.

    {
        global $ilias, $lng;

        if ($a_xml_file) {
            $this->xml_file = $a_xml_file;
            $this->input_type = 'file';
        }

        $this->throwException = $throwException;
        $this->ilias = &$ilias;
        $this->lng = &$lng;
    }

Member Function Documentation

createParser()

ilSaxParser::createParser

(

)

create parser

private

Exceptions

ilSaxParserException

or ILIAS Error

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

References handleError().

Referenced by startParsing().

    {
        $xml_parser = xml_parser_create("UTF-8");

        if ($xml_parser == false) {
            $this->handleError("Cannot create an XML parser handle", $this->ilias->error_obj->FATAL);
        }
        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

)

free xml parser handle

private

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

Referenced by startParsing().

    {
        if (!xml_parser_free($a_xml_parser)) {
            $this->ilias->raiseError("Error freeing xml parser handle ", $this->ilias->error_obj->FATAL);
        }
    }

Here is the caller graph for this function:

getInputType()

ilSaxParser::getInputType

(

)

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

References $input_type.

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

    {
        return $this->input_type;
    }

Here is the caller graph for this function:

getXMLContent()

ilSaxParser::getXMLContent

(

)

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

References $xml_content.

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

    {
        return $this->xml_content;
    }

Here is the caller graph for this function:

handleError()

ilSaxParser::handleError (   $message,   $code  )

protected

use given error handler to handle error message or internal ilias error message handle

Parameters

string	$message
string	$code

Exceptions

ilSaxParserException

or ILIAS Error

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

References $message.

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

    {
        if ($this->throwException) {
            require_once('./Services/Xml/exceptions/class.ilSaxParserException.php');
            throw new ilSaxParserException($message, $code);
        } else {
            if (is_object($this->ilias)) {
                $this->ilias->raiseError($message, $code);
            } else {
                die($message);
            }
        }
        return false;
    }

Here is the caller graph for this function:

openXMLFile()

ilSaxParser::openXMLFile

(

)

open xml file

private

Exceptions

ilSaxParserException

or ILIAS Error

Definition at line 168 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 . "\"", $this->ilias->error_obj->FATAL);
        }
        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
	)

parse xml file

private

Exceptions

ilSaxParserException

or ILIAS Error

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

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

Referenced by startParsing().

    {
        switch ($this->getInputType()) {
            case 'file':

                while ($data = fread($a_fp, 4096)) {
                    $parseOk = xml_parse($a_xml_parser, $data, feof($a_fp));
                }
                break;
                
            case 'string':
                $parseOk = xml_parse($a_xml_parser, $this->getXMLContent());
                break;
        }
        if (!$parseOk
           && (xml_get_error_code($a_xml_parser) != XML_ERROR_NONE)) {
            $errorCode = xml_get_error_code($a_xml_parser);
            $line = xml_get_current_line_number($a_xml_parser);
            $col = xml_get_current_column_number($a_xml_parser);
            $this->handleError("XML Parse Error: " . xml_error_string($errorCode) . " at line " . $line . ", col " . $col . " (Code: " . $errorCode . ")", $this->ilias->error_obj->FATAL);
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setHandlers()

ilSaxParser::setHandlers

(

$a_xml_parser

)

set event handler should be overwritten by inherited class private

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

Referenced by startParsing().

    {
        echo 'ilSaxParser::setHandlers() must be overwritten';
    }

Here is the caller graph for this function:

setOptions()

ilSaxParser::setOptions

(

$a_xml_parser

)

set parser options

private

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

Referenced by startParsing().

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

Here is the caller graph for this function:

setThrowException()

ilSaxParser::setThrowException

(

$throwException

)

set error handling

Parameters

$error_handler

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

References $throwException.

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

    {
        $this->throwException = $throwException;
    }

Here is the caller graph for this function:

setXMLContent()

ilSaxParser::setXMLContent

(

$a_xml_content

)

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

Referenced by ilMDXMLParser\__construct(), ilMD5295XMLParser\__construct(), ilSoapMailXmlParser\__construct(), ilLearningSequenceXMLParser\__construct(), ilCopyWizardSettingsXMLParser\__construct(), ilDataSetImportParser\__construct(), ilForumXMLParser\__construct(), ilWebLinkXmlParser\__construct(), ilFolderXmlParser\__construct(), ilMDXMLCopier\__construct(), ilXMLResultSetParser\__construct(), ilObjectXMLParser\__construct(), ilCategoryXmlParser\__construct(), ilExerciseXMLParser\__construct(), ilContainerReferenceXmlParser\__construct(), ilGroupXMLParser\__construct(), ilChatroomXMLParser\__construct(), and ilFileXMLParser\__construct().

    {
        $this->xml_content = $a_xml_content;
        $this->input_type = 'string';
    }

Here is the caller graph for this function:

startParsing()

ilSaxParser::startParsing

(

)

stores xml data in array

private

Exceptions

ilSaxParserException

or ILIAS Error

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

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

Referenced by ilModuleReader\getModules(), ilServiceReader\getServices(), ilLearningSequenceXMLParser\start(), ilSoapMailXmlParser\start(), ilFolderXmlParser\start(), ilWebLinkXmlParser\start(), ilExerciseXMLParser\start(), ilFileXMLParser\start(), and ilForumXMLParser\start().

    {
        $xml_parser = $this->createParser();
        $this->setOptions($xml_parser);
        $this->setHandlers($xml_parser);

        switch ($this->getInputType()) {
            case 'file':
                $fp = $this->openXMLFile();
                $this->parse($xml_parser, $fp);
                break;

            case 'string':
                $this->parse($xml_parser);
                break;

            default:
                $this->handleError(
                    "No input type given. Set filename in constructor or choose setXMLContent()",
                    $this->ilias->error_obj->FATAL
                );
                break;
        }
        $this->freeParser($xml_parser);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ilias

ilSaxParser::$ilias

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

Referenced by ilGroupXMLParser\__assignMembers(), __construct(), ilGroupXMLParser\__parseId(), ilCourseXMLParser\__parseId(), ilUserImportParser\importBeginTag(), and ilUserImportParser\importEndTag().

$input_type

ilSaxParser::$input_type = null

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

Referenced by getInputType().

$lng

ilSaxParser::$lng

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

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

$throwException

ilSaxParser::$throwException = false

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

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

$xml_content

ilSaxParser::$xml_content = ''

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

Referenced by getXMLContent().

$xml_file

ilSaxParser::$xml_file

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

---

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

• Services/Xml/classes/class.ilSaxParser.php