class.ilSaxParser.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilSaxParser
{
        var $input_type = null;

        var $xml_content = '';

        var $ilias;

        var $lng;

        var $xml_file;

        var $throwException = false;
        function __construct($a_xml_file = '', $throwException = false)
        {
                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;
        }

        function setXMLContent($a_xml_content)
        {
                $this->xml_content = $a_xml_content;
                $this->input_type = 'string';
        }
        
        function getXMLContent()
        {
                return $this->xml_content;
        }

        function getInputType()
        {
                return $this->input_type;
        }

        function startParsing()
        {
                $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);
        }
        function createParser()
        {
                $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;
        }
        function setOptions($a_xml_parser)
        {
                xml_parser_set_option($a_xml_parser,XML_OPTION_CASE_FOLDING,false);
        }
        function setHandlers($a_xml_parser)
        {
                echo 'ilSaxParser::setHandlers() must be overwritten';
        }
        function openXMLFile()
        {
                if(!($fp = fopen($this->xml_file,'r')))
                {
                        $this->handleError("Cannot open xml file \"".$this->xml_file."\"",$this->ilias->error_obj->FATAL);
                }
                return $fp;
        }
        function parse($a_xml_parser,$a_fp = null)
        {
                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;
                                
        }
        
        protected function handleError($message, $code) {
                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;
        }
        function freeParser($a_xml_parser)
        {
                if(!xml_parser_free($a_xml_parser))
                {
                        $this->ilias->raiseError("Error freeing xml parser handle ",$this->ilias->error_obj->FATAL);
                }
        }
        
        public function setThrowException ($throwException) 
        {
                $this->throwException = $throwException;
        }
}
?>