XmlTypeCheck Class Reference

Public Member Functions
	__construct ( $input, $filterCallback=null, $isFile=true, $options=array())
	getRootElement ()
	Get the root element. More...

Static Public Member Functions
static	newFromFilename ( $fname, $filterCallback=null)
	Alternative constructor: from filename. More...
static	newFromString ( $string, $filterCallback=null)
	Alternative constructor: from string. More...

Public Attributes
	$filterMatch = false
	Will be set to true if the optional element filter returned a match at some point. More...
	$rootElement = ''
	Name of the document's root element, including any namespace as an expanded URL. More...
	$wellFormed = false
	Will be set to true or false to indicate whether the file is well-formed XML. More...

Private Member Functions
	elementOpen ( $parser, $name, $attribs)
	getParser ()
	Get an XML parser with the root element handler. More...
	processingInstructionHandler ( $parser, $target, $data)
	rootElementOpen ( $parser, $name, $attribs)
	validateFromFile ( $fname)
	validateFromString ( $string)

Private Attributes
	$parserOptions
	Additional parsing options. More...

Detailed Description

Definition at line 23 of file XmlTypeCheck.php.

Constructor & Destructor Documentation

__construct()

XmlTypeCheck::__construct	(		$input,
			$filterCallback = null,
			$isFile = true,
			$options = array()
	)

Parameters

string	$input	a filename or string containing the XML element
callable	$filterCallback	(optional) Function to call to do additional custom validity checks from the SAX element handler event. This gives you access to the element namespace, name, and attributes, but not to text contents. Filter should return 'true' to toggle on $this->filterMatch
boolean	$isFile	(optional) indicates if the first parameter is a filename (default, true) or if it is a string (false)
array	$options	list of additional parsing options: processing_instruction_handler: Callback for xml_set_processing_instruction_handler

Definition at line 61 of file XmlTypeCheck.php.

References $options, validateFromFile(), and validateFromString().

Member Function Documentation

elementOpen()

XmlTypeCheck::elementOpen (   $parser,   $name,   $attribs  )

private

Parameters

$parser
$name
$attribs

Definition at line 195 of file XmlTypeCheck.php.

References $attribs, and $name.

Referenced by rootElementOpen().

getParser()

XmlTypeCheck::getParser ( )

private

Get an XML parser with the root element handler.

See also

XmlTypeCheck::rootElementOpen()

Returns

resource a resource handle for the XML parser

Definition at line 116 of file XmlTypeCheck.php.

References $parser, and array().

Referenced by validateFromFile(), and validateFromString().

getRootElement()

XmlTypeCheck::getRootElement

(

)

Get the root element.

Simple accessor to $rootElement

Returns

string

Definition at line 107 of file XmlTypeCheck.php.

References $rootElement.

newFromFilename()

static XmlTypeCheck::newFromFilename (   $fname,   $filterCallback = null  )

static

Alternative constructor: from filename.

Parameters

string	$fname	the filename of an XML document
callable	$filterCallback	(optional) Function to call to do additional custom validity checks from the SAX element handler event. This gives you access to the element namespace, name, and attributes, but not to text contents. Filter should return 'true' to toggle on $this->filterMatch

Returns

XmlTypeCheck

Definition at line 83 of file XmlTypeCheck.php.

References $fname, and true.

newFromString()

static XmlTypeCheck::newFromString (   $string,   $filterCallback = null  )

static

Alternative constructor: from string.

Parameters

string	$string	a string containing an XML element
callable	$filterCallback	(optional) Function to call to do additional custom validity checks from the SAX element handler event. This gives you access to the element namespace, name, and attributes, but not to text contents. Filter should return 'true' to toggle on $this->filterMatch

Returns

XmlTypeCheck

Definition at line 98 of file XmlTypeCheck.php.

References false.

Referenced by XmlTypeCheckTest\testMalFormedXML(), and XmlTypeCheckTest\testWellFormedXML().

processingInstructionHandler()

XmlTypeCheck::processingInstructionHandler (   $parser,   $target,   $data  )

private

Parameters

$parser
$target
$data

Definition at line 207 of file XmlTypeCheck.php.

rootElementOpen()

XmlTypeCheck::rootElementOpen (   $parser,   $name,   $attribs  )

private

Parameters

$parser
$name
$attribs

Definition at line 178 of file XmlTypeCheck.php.

References $attribs, $name, $parser, array(), and elementOpen().

validateFromFile()

XmlTypeCheck::validateFromFile (   $fname )

private

Parameters

string

$fname

the filename

Definition at line 133 of file XmlTypeCheck.php.

References $file, $fname, $parser, $ret, and getParser().

Referenced by __construct().

validateFromString()

XmlTypeCheck::validateFromString (   $string )

private

Parameters

string

$string

the XML-input-string to be checked.

Definition at line 162 of file XmlTypeCheck.php.

References $parser, $ret, and getParser().

Referenced by __construct().

Member Data Documentation

$filterMatch

XmlTypeCheck::$filterMatch = false

Will be set to true if the optional element filter returned a match at some point.

Definition at line 34 of file XmlTypeCheck.php.

$parserOptions

XmlTypeCheck::$parserOptions

private

Initial value:

= array(
        'processing_instruction_handler' => '',
    )

Additional parsing options.

Definition at line 45 of file XmlTypeCheck.php.

$rootElement

XmlTypeCheck::$rootElement = ''

Name of the document's root element, including any namespace as an expanded URL.

Definition at line 40 of file XmlTypeCheck.php.

Referenced by getRootElement().

$wellFormed

XmlTypeCheck::$wellFormed = false

Will be set to true or false to indicate whether the file is well-formed XML.

Note that this doesn't check schema validity.

Definition at line 28 of file XmlTypeCheck.php.

---

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

• includes/libs/XmlTypeCheck.php