XML checker. More...

Inheritance diagram for ilXMLChecker:

Collaboration diagram for ilXMLChecker:

Public Member Functions
	__construct ($a_xml_file='', $throwException=false)
	Constructor. More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	startParsing ()
	start the parser More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element More...

	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data More...

	getErrorCode ()

	getErrorLine ()

	getErrorColumn ()

	getErrorMessage ()

	getFullError ()

	getXMLSize ()

	getXMLElements ()

	getXMLAttributes ()

	getXMLTextSections ()

	getXMLTextSize ()

	hasError ()

Public Member Functions inherited from ilSaxParser
	__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
	$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
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...

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

Detailed Description

XML checker.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilXMLChecker::__construct	(	$a_xml_file = `''`,
		$throwException = `false`
	)

Constructor.

Parameters

string $a_xml_file xml file

public

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

References ilSaxParser\$throwException.

     {
         parent::__construct($a_xml_file, $throwException);
         $this->has_error = false;
     }

Member Function Documentation

◆ getErrorCode()

ilXMLChecker::getErrorCode ( )

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

References $error_code.

     {
         return $this->error_code;
     }

◆ getErrorColumn()

ilXMLChecker::getErrorColumn ( )

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

References $error_col.

     {
         return $this->error_col;
     }

◆ getErrorLine()

ilXMLChecker::getErrorLine ( )

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

References $error_line.

     {
         return $this->error_line;
     }

◆ getErrorMessage()

ilXMLChecker::getErrorMessage ( )

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

References $error_msg.

     {
         return $this->error_msg;
     }

◆ getFullError()

ilXMLChecker::getFullError ( )

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

References $error_col.

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

◆ getXMLAttributes()

ilXMLChecker::getXMLAttributes ( )

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

References $attributes.

     {
         return $this->attributes;
     }

◆ getXMLElements()

ilXMLChecker::getXMLElements ( )

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

References $elements.

     {
         return $this->elements;
     }

◆ getXMLSize()

ilXMLChecker::getXMLSize ( )

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

References $size.

     {
         return $this->size;
     }

◆ getXMLTextSections()

ilXMLChecker::getXMLTextSections ( )

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

References $texts.

     {
         return $this->texts;
     }

◆ getXMLTextSize()

ilXMLChecker::getXMLTextSize ( )

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

References $text_size.

     {
         return $this->text_size;
     }

◆ handlerBeginTag()

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

handler for begin of element

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

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

◆ handlerCharacterData()

ilXMLChecker::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

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

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

◆ handlerEndTag()

ilXMLChecker::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

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

125 {

126 }

◆ hasError()

ilXMLChecker::hasError ( )

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

References $has_error.

     {
         return $this->has_error;
     }

◆ parse()

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

parse xml file

private

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:

◆ setHandlers()

ilXMLChecker::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class private

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');
     }

◆ startParsing()

ilXMLChecker::startParsing ( )

start the parser

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

     {
         parent::startParsing();
     }

Field Documentation

◆ $attributes

ilXMLChecker::$attributes

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

Referenced by getXMLAttributes().

◆ $elements

ilXMLChecker::$elements

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

Referenced by getXMLElements().

◆ $error_code

ilXMLChecker::$error_code

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

Referenced by getErrorCode().

◆ $error_col

ilXMLChecker::$error_col

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

Referenced by getErrorColumn(), and getFullError().

◆ $error_line

ilXMLChecker::$error_line

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

Referenced by getErrorLine().

◆ $error_msg

ilXMLChecker::$error_msg

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

Referenced by getErrorMessage().

◆ $has_error

ilXMLChecker::$has_error

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

Referenced by hasError().

◆ $size

ilXMLChecker::$size

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

Referenced by getXMLSize().

◆ $text_size

ilXMLChecker::$text_size

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

Referenced by getXMLTextSize().

◆ $texts

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