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

	getRootElement ()
	Get the root element.

	XmlErrorHandler ( $errno, $errstr)

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.

Private Member Functions
	checkDTDIsSafe ( $internalSubset)
	Check if the internal subset of the DTD is safe.

	DTDHandler (XMLReader $reader)
	Handle coming across a <!DOCTYPE declaration.

	elementClose ()

	elementData ( $data)

	elementOpen ( $name, $attribs)

	expandNS ( $name, $namespaceURI)

	getAttributesArray (XMLReader $r)
	Get all of the attributes for an XMLReader's current node.

	parseDTD ( $dtd)
	Parse DTD into parts.

	processingInstructionHandler ( $target, $data)

	readNext (XMLReader $reader)

	validate ( $reader)

	validateFromInput ( $xml, $isFile)

Private Attributes
array	$parserOptions
	Additional parsing options.

Detailed Description

Definition at line 28 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 110 of file XmlTypeCheck.php.

References $filterCallback, and validateFromInput().

Member Function Documentation

◆ checkDTDIsSafe()

XmlTypeCheck::checkDTDIsSafe ( $internalSubset )

private

Check if the internal subset of the DTD is safe.

We whitelist an extremely restricted subset of DTD features.

Safe is defined as:

Only contains entity definitions (e.g. No <!ATLIST )
Entity definitions are not "system" entities
Entity definitions are not "parameter" (i.e. %) entities
Entity definitions do not reference other entities except & and quotes. Entity aliases (where the entity contains only another entity are allowed)
Entity references aren't overly long (>255 bytes).
<!ATTLIST svg xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> allowed if matched exactly for compatibility with graphviz
Comments.

Parameters

string $internalSubset The internal subset of the DTD

Returns: bool true if safe.

Definition at line 440 of file XmlTypeCheck.php.

References $res.

Referenced by DTDHandler().

◆ DTDHandler()

XmlTypeCheck::DTDHandler ( XMLReader $reader )

private

Handle coming across a <!DOCTYPE declaration.

Parameters

XMLReader $reader Reader currently pointing at DOCTYPE node.

Definition at line 377 of file XmlTypeCheck.php.

References checkDTDIsSafe(), and parseDTD().

Referenced by validate().

◆ elementClose()

XmlTypeCheck::elementClose ( )

private

Definition at line 323 of file XmlTypeCheck.php.

References elementData().

Referenced by validate().

◆ elementData()

XmlTypeCheck::elementData ( $data )

private

Parameters

string $data

Definition at line 347 of file XmlTypeCheck.php.

References elementData().

Referenced by elementClose(), elementData(), elementOpen(), and validate().

◆ elementOpen()

XmlTypeCheck::elementOpen	(	$name,
		$attribs
	)

private

Parameters

string	$name
array	$attribs

Definition at line 317 of file XmlTypeCheck.php.

References elementData().

Referenced by validate().

◆ expandNS()

XmlTypeCheck::expandNS	(	$name,
		$namespaceURI
	)

private

Parameters

string	$name	element or attribute name, maybe with a full or short prefix
string	$namespaceURI

Returns: string the name prefixed with namespaceURI

Definition at line 304 of file XmlTypeCheck.php.

Referenced by getAttributesArray(), and validate().

◆ getAttributesArray()

XmlTypeCheck::getAttributesArray ( XMLReader $r )

private

Get all of the attributes for an XMLReader's current node.

Parameters

XMLReader $r

Returns: array of attributes

Definition at line 285 of file XmlTypeCheck.php.

References expandNS().

Referenced by validate().

◆ getRootElement()

XmlTypeCheck::getRootElement ( )

Get the root element.

Simple accessor to $rootElement

Returns: string

Definition at line 151 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 127 of file XmlTypeCheck.php.

References $filterCallback, and true.

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

References $filterCallback.

◆ parseDTD()

XmlTypeCheck::parseDTD ( $dtd )

private

Parse DTD into parts.

If there is an error parsing the dtd, sets wellFormed to false.

Parameters

string $dtd

Returns: array Possibly containing keys publicid, systemid, type and internal.

Definition at line 463 of file XmlTypeCheck.php.

References $res.

Referenced by DTDHandler().

◆ processingInstructionHandler()

XmlTypeCheck::processingInstructionHandler	(	$target,
		$data
	)

private

Parameters

string	$target
string	$data

Definition at line 356 of file XmlTypeCheck.php.

Referenced by validate().

◆ readNext()

XmlTypeCheck::readNext ( XMLReader $reader )

private

Definition at line 187 of file XmlTypeCheck.php.

Referenced by validate().

◆ validate()

XmlTypeCheck::validate ( $reader )

private

Definition at line 198 of file XmlTypeCheck.php.

References DTDHandler(), elementClose(), elementData(), elementOpen(), expandNS(), getAttributesArray(), processingInstructionHandler(), and readNext().

Referenced by validateFromInput().

◆ validateFromInput()

XmlTypeCheck::validateFromInput	(	$xml,
		$isFile
	)

private

Parameters

string	$xml
bool	$isFile

Definition at line 159 of file XmlTypeCheck.php.

References $s, and validate().

Referenced by __construct().

◆ XmlErrorHandler()

XmlTypeCheck::XmlErrorHandler	(	$errno,
		$errstr
	)

Definition at line 194 of file XmlTypeCheck.php.

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

◆ $elementDataContext

array XmlTypeCheck::$elementDataContext = []

protected

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

Definition at line 64 of file XmlTypeCheck.php.

◆ $filterCallback

callable null XmlTypeCheck::$filterCallback

protected

Definition at line 72 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 39 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 46 of file XmlTypeCheck.php.

◆ $parserOptions

array XmlTypeCheck::$parserOptions

private

Initial value:

= [
        'processing_instruction_handler' => null,
        'external_dtd_handler' => '',
        'dtd_handler' => '',
        'require_safe_dtd' => true
    ]

Additional parsing options.

Definition at line 77 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 52 of file XmlTypeCheck.php.

Referenced by getRootElement().

◆ $stackDepth

int XmlTypeCheck::$stackDepth = 0

protected

Current depth of the data stack.

Definition at line 69 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 33 of file XmlTypeCheck.php.

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

includes/libs/mime/XmlTypeCheck.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDTDIsSafe()

◆ DTDHandler()

◆ elementClose()

◆ elementData()

◆ elementOpen()

◆ expandNS()

◆ getAttributesArray()

◆ getRootElement()

◆ newFromFilename()

◆ newFromString()

◆ parseDTD()

◆ processingInstructionHandler()

◆ readNext()

◆ validate()

◆ validateFromInput()

◆ XmlErrorHandler()

Member Data Documentation

◆ $elementData

◆ $elementDataContext

◆ $filterCallback

◆ $filterMatch

◆ $filterMatchType

◆ $parserOptions

◆ $rootElement

◆ $stackDepth

◆ $wellFormed