classes/class.ilSaxParser.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


class ilSaxParser
{
        var $input_type = null;

        var $xml_content = '';

        var $ilias;

        var $lng;

        var $xml_file;

        function ilSaxParser($a_xml_file = '')
        {
                global $ilias, $lng;

                if($a_xml_file)
                {
                        $this->xml_file = $a_xml_file;
                        $this->input_type = 'file';
                }
                
                $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->ilias->raiseError("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->ilias->raiseError("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->ilias->raiseError("Cannot open 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))
                {
                        $this->ilias->raiseError("XML Parse Error: ".xml_get_error_code($a_xml_parser),$this->ilias->error_obj->FATAL);
                }
                return true;
                                
        }
        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);
                }
        }
}
?>