MediaWiki
1.30.0
|
Public Member Functions | |
__construct ( $input, $filterCallback=null, $isFile=true, $options=[]) | |
Allow filtering an XML file. More... | |
getRootElement () | |
Get the root element. More... | |
XmlErrorHandler ( $errno, $errstr) | |
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... | |
mixed | $filterMatchType = false |
Will contain the type of filter hit 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 = null | |
Will be set to true or false to indicate whether the file is well-formed XML. More... | |
Protected Attributes | |
$elementData = [] | |
A stack of strings containing the data of each xml element as it's processed. More... | |
$elementDataContext = [] | |
A stack of element names and attributes, as we process them. More... | |
$stackDepth = 0 | |
Current depth of the data stack. More... | |
Private Member Functions | |
checkDTDIsSafe ( $internalSubset) | |
Check if the internal subset of the DTD is safe. More... | |
DTDHandler (XMLReader $reader) | |
Handle coming across a <!DOCTYPE declaration. More... | |
elementClose () | |
elementData ( $data) | |
elementOpen ( $name, $attribs) | |
expandNS ( $name, $namespaceURI) | |
getAttributesArray (XMLReader $r) | |
Get all of the attributes for an XMLReader's current node. More... | |
parseDTD ( $dtd) | |
Parse DTD into parts. More... | |
processingInstructionHandler ( $target, $data) | |
readNext (XMLReader $reader) | |
validate ( $reader) | |
validateFromInput ( $xml, $isFile) | |
Private Attributes | |
$parserOptions | |
Additional parsing options. More... | |
Definition at line 28 of file XmlTypeCheck.php.
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.
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, 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 107 of file XmlTypeCheck.php.
References $input, $options, and validateFromInput().
|
private |
Check if the internal subset of the DTD is safe.
We whitelist an extremely restricted subset of DTD features.
Safe is defined as:
string | $internalSubset | The internal subset of the DTD |
Definition at line 435 of file XmlTypeCheck.php.
References $res.
Referenced by DTDHandler().
|
private |
Handle coming across a <!DOCTYPE declaration.
XMLReader | $reader | Reader currently pointing at DOCTYPE node. |
Definition at line 372 of file XmlTypeCheck.php.
References checkDTDIsSafe(), and parseDTD().
Referenced by validate().
|
private |
Definition at line 319 of file XmlTypeCheck.php.
References $attribs, $name, elementData(), and list.
Referenced by validate().
|
private |
string | $data |
Definition at line 343 of file XmlTypeCheck.php.
Referenced by elementClose(), elementOpen(), and validate().
|
private |
string | $name | |
string | $attribs |
Definition at line 313 of file XmlTypeCheck.php.
References $attribs, $name, and elementData().
Referenced by validate().
|
private |
string | $name | element or attribute name, maybe with a full or short prefix |
string | $namespaceURI | the namespaceURI |
Definition at line 300 of file XmlTypeCheck.php.
References $name.
Referenced by getAttributesArray(), and validate().
|
private |
Get all of the attributes for an XMLReader's current node.
XMLReader | $r |
Definition at line 281 of file XmlTypeCheck.php.
References $name, and expandNS().
Referenced by validate().
XmlTypeCheck::getRootElement | ( | ) |
Get the root element.
Simple accessor to $rootElement
Definition at line 148 of file XmlTypeCheck.php.
References $rootElement.
|
static |
Alternative constructor: from filename.
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 |
Definition at line 124 of file XmlTypeCheck.php.
|
static |
Alternative constructor: from string.
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 |
Definition at line 139 of file XmlTypeCheck.php.
References false.
|
private |
Parse DTD into parts.
If there is an error parsing the dtd, sets wellFormed to false.
string | $dtd |
Definition at line 458 of file XmlTypeCheck.php.
References $res, $value, and as.
Referenced by DTDHandler().
|
private |
string | $target | |
string | $data |
Definition at line 352 of file XmlTypeCheck.php.
Referenced by validate().
|
private |
|
private |
Definition at line 194 of file XmlTypeCheck.php.
References $name, DTDHandler(), elementClose(), elementData(), elementOpen(), expandNS(), getAttributesArray(), processingInstructionHandler(), and readNext().
Referenced by validateFromInput().
|
private |
string | $fname | the filename |
Definition at line 155 of file XmlTypeCheck.php.
References $e, $s, and validate().
Referenced by __construct().
XmlTypeCheck::XmlErrorHandler | ( | $errno, | |
$errstr | |||
) |
Definition at line 190 of file XmlTypeCheck.php.
|
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.
|
protected |
A stack of element names and attributes, as we process them.
Definition at line 64 of file XmlTypeCheck.php.
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.
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.
|
private |
Additional parsing options.
Definition at line 74 of file XmlTypeCheck.php.
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().
|
protected |
Current depth of the data stack.
Definition at line 69 of file XmlTypeCheck.php.
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.