XML checker. More...

Inheritance diagram for ilXMLChecker:

Collaboration diagram for ilXMLChecker:

Public Member Functions
	ilXMLChecker ($a_xml_file= '')
	Constructor.
	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private
	startParsing ()
	start the parser
	parse ($a_xml_parser, $a_fp=null)
	parse xml file
	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element
	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element
	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data
	getErrorCode ()
	getErrorLine ()
	getErrorColumn ()
	getErrorMessage ()
	getFullError ()
	getXMLSize ()
	getXMLElements ()
	getXMLAttributes ()
	getXMLTextSections ()
	getXMLTextSize ()
	hasError ()
Public Member Functions inherited from ilSaxParser
	ilSaxParser ($a_xml_file= '', $throwException=false)
	Constructor setup ILIAS global object public.
	setXMLContent ($a_xml_content)
	getXMLContent ()
	getInputType ()
	createParser ()
	create parser
	setOptions ($a_xml_parser)
	set parser options
	openXMLFile ()
	open xml file
	freeParser ($a_xml_parser)
	free xml parser handle
	setThrowException ($throwException)
	set error handling
Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor.
	_PEAR ()
	Destructor (the emulated type of...).
&	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.
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes.
	isError ($data, $code=null)
	Tell whether a value is a PEAR error.
	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled.
	expectError ($code= '*')
	This method is used to tell which errors you expect to get.
	popExpect ()
	This method pops one element off the expected error codes stack.
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available.
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack.
&	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.
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options.
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack.
	popErrorHandling ()
	Pop the last error handler used.
	loadExtension ($ext)
	OS independant PHP extension load.

Data Fields
	$error_code
	$error_line
	$error_col
	$error_msg
	$has_error
	$size
	$elements
	$attributes
	$texts
	$text_size
Data Fields inherited from ilSaxParser
	$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()

Additional Inherited Members
Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle

Detailed Description

XML checker.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version

Id:: class.ilXmlChecker.php 18157 2008-12-03 17:06:40Z hschottm

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

Member Function Documentation

ilXMLChecker::getErrorCode ( )

Definition at line 140 of file class.ilXmlChecker.php.

References $error_code.

        {
    return $this->error_code; 
  }

ilXMLChecker::getErrorColumn ( )

Definition at line 150 of file class.ilXmlChecker.php.

References $error_col.

        {
    return $this->error_col; 
  }

ilXMLChecker::getErrorLine ( )

Definition at line 145 of file class.ilXmlChecker.php.

References $error_line.

        {
    return $this->error_line; 
  }

ilXMLChecker::getErrorMessage ( )

Definition at line 155 of file class.ilXmlChecker.php.

References $error_msg.

        {
    return $this->error_msg; 
  }

ilXMLChecker::getFullError ( )

Definition at line 160 of file class.ilXmlChecker.php.

References $error_col.

        {
    return "Error: ".$this->error_msg." at line:".$this->error_line ." column:".$this->error_col;
  }

ilXMLChecker::getXMLAttributes ( )

Definition at line 175 of file class.ilXmlChecker.php.

References $attributes.

        {
    return $this->attributes; 
  }

ilXMLChecker::getXMLElements ( )

Definition at line 170 of file class.ilXmlChecker.php.

References $elements.

        {
    return $this->elements; 
  }

ilXMLChecker::getXMLSize ( )

Definition at line 165 of file class.ilXmlChecker.php.

References $size.

        {
    return $this->size; 
  }

ilXMLChecker::getXMLTextSections ( )

Definition at line 180 of file class.ilXmlChecker.php.

References $texts.

        {
    return $this->texts; 
  }

ilXMLChecker::getXMLTextSize ( )

Definition at line 185 of file class.ilXmlChecker.php.

References $text_size.

        {
    return $this->text_size; 
  }

ilXMLChecker::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

handler for begin of element

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

        {
    $this->elements++;
    $this->attributes+=count($a_attribs);
        }

ilXMLChecker::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

Definition at line 134 of file class.ilXmlChecker.php.

        {
    $this->texts++;
    $this->text_size+=strlen($a_data);
        }

ilXMLChecker::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

Definition at line 127 of file class.ilXmlChecker.php.

{

}

ilXMLChecker::hasError ( )

Definition at line 190 of file class.ilXmlChecker.php.

References $has_error.

        {
    return $this->has_error; 
  }

ilXMLChecker::ilXMLChecker ( $a_xml_file = '' )

Constructor.

Parameters

string $a_xml_file xml file

public

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

References ilSaxParser\ilSaxParser().

        {
                parent::ilSaxParser($a_xml_file);
                $this->has_error = FALSE;
        }

Here is the call graph for this function:

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

parse xml file

private

Reimplemented from ilSaxParser.

Definition at line 86 of file class.ilXmlChecker.php.

References $data, ilSaxParser\getInputType(), and ilSaxParser\getXMLContent().

        {
                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->error_code = xml_get_error_code($a_xml_parser);
      $this->error_line = xml_get_current_line_number($a_xml_parser);
      $this->error_col = xml_get_current_column_number($a_xml_parser);
      $this->error_msg = xml_error_string($a_xml_parser);
                        $this->has_error = TRUE;
                        return false;
                }
                return true;
        }

Here is the call graph for this function:

ilXMLChecker::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class private

Reimplemented from ilSaxParser.

Definition at line 66 of file class.ilXmlChecker.php.

        {
                xml_set_object($a_xml_parser,$this);
                xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
                xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
        }

ilXMLChecker::startParsing ( )

start the parser

Reimplemented from ilSaxParser.

Definition at line 76 of file class.ilXmlChecker.php.

        {
                parent::startParsing();
        }

Field Documentation

ilXMLChecker::$attributes

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

Referenced by getXMLAttributes().

ilXMLChecker::$elements

Definition at line 43 of file class.ilXmlChecker.php.

Referenced by getXMLElements().

ilXMLChecker::$error_code

Definition at line 37 of file class.ilXmlChecker.php.

Referenced by getErrorCode().

ilXMLChecker::$error_col

Definition at line 39 of file class.ilXmlChecker.php.

Referenced by getErrorColumn(), and getFullError().

ilXMLChecker::$error_line

Definition at line 38 of file class.ilXmlChecker.php.

Referenced by getErrorLine().

ilXMLChecker::$error_msg

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

Referenced by getErrorMessage().

ilXMLChecker::$has_error

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

Referenced by hasError().

ilXMLChecker::$size

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

Referenced by getXMLSize().

ilXMLChecker::$text_size

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

Referenced by getXMLTextSize().

ilXMLChecker::$texts

Definition at line 45 of file class.ilXmlChecker.php.

Referenced by getXMLTextSections().

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

Services/Certificate/classes/class.ilXmlChecker.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation