XmlTypeCheck Class Reference

XML syntax and type checker. More...

Public Member Functions
	__construct ( $input, $filterCallback=null, $isFile=true, $options=[])
	Allow filtering an XML file.
	getRootElement ()
	Get the root element.

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

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

Protected Attributes
string[]	$elementData = []
	A stack of strings containing the data of each xml element as it's processed.
array	$elementDataContext = []
	A stack of element names and attributes, as we process them.
callable null	$filterCallback
int	$stackDepth = 0
	Current depth of the data stack.

Detailed Description

XML syntax and type checker.

Since MediaWiki 1.24.2, this uses XMLReader instead of xml_parse, which gives us more control over the expansion of XML entities. When passed to the callback, entities will be fully expanded, but may report the XML is invalid if expanding the entities are likely to cause a DoS.

Stability: newable

Since

1.12.0

Definition at line 33 of file XmlTypeCheck.php.

Constructor & Destructor Documentation

__construct()

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

Allow filtering an XML file.

Filters should return either true or a string to indicate something is wrong with the file. $this->filterMatch will store if the file failed validation (true = failed validation). $this->filterMatchType will contain the validation error. $this->wellFormed will contain whether the xml file is well-formed.

Note

If multiple filters are hit, only one of them will have the result stored in $this->filterMatchType.

Parameters

string	$input	a filename or string containing the XML element
callable | null	$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, attributes, and text contents. Filter should return a truthy value describing the error.
bool	$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 external_dtd_handler: Callback for the url of external dtd subset dtd_handler: Callback given the full text of the <!DOCTYPE declaration. require_safe_dtd: Only allow non-recursive entities in internal dtd (default true)

Definition at line 115 of file XmlTypeCheck.php.

References $filterCallback.

Member Function Documentation

getRootElement()

XmlTypeCheck::getRootElement

(

)

Get the root element.

Simple accessor to $rootElement

Returns

string

Definition at line 156 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 | null	$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 132 of file XmlTypeCheck.php.

References $filterCallback.

newFromString()

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

static

Alternative constructor: from string.

Parameters

string	$string	a string containing an XML element
callable | null	$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 147 of file XmlTypeCheck.php.

References $filterCallback.

Member Data Documentation

$elementData

string [] XmlTypeCheck::$elementData = []

protected

A stack of strings containing the data of each xml element as it's processed.

Append data to the top string of the stack, then pop off the string and process it when the element is closed.

Definition at line 64 of file XmlTypeCheck.php.

$elementDataContext

array XmlTypeCheck::$elementDataContext = []

protected

A stack of element names and attributes, as we process them.

Definition at line 69 of file XmlTypeCheck.php.

$filterCallback

callable null XmlTypeCheck::$filterCallback

protected

Definition at line 77 of file XmlTypeCheck.php.

Referenced by __construct(), newFromFilename(), and newFromString().

$filterMatch

bool XmlTypeCheck::$filterMatch = false

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

Definition at line 44 of file XmlTypeCheck.php.

$filterMatchType

mixed XmlTypeCheck::$filterMatchType = false

Will contain the type of filter hit if the optional element filter returned a match at some point.

Definition at line 51 of file XmlTypeCheck.php.

$rootElement

string XmlTypeCheck::$rootElement = ''

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

Definition at line 57 of file XmlTypeCheck.php.

Referenced by getRootElement().

$stackDepth

int XmlTypeCheck::$stackDepth = 0

protected

Current depth of the data stack.

Definition at line 74 of file XmlTypeCheck.php.

$wellFormed

bool null XmlTypeCheck::$wellFormed = null

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 38 of file XmlTypeCheck.php.

---

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

• includes/libs/mime/XmlTypeCheck.php