MediaWiki  1.23.14
XmlTypeCheck Class Reference

Public Member Functions

 __construct ( $input, $filterCallback=null, $isFile=true, $options=array())
 
 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...
 
 $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 = array()
 A stack of strings containing the data of each xml element as it's processed. More...
 
 $elementDataContext = array()
 A stack of element names and attributes, as we process them. More...
 
 $stackDepth = 0
 Current depth of the data stack. More...
 

Private Member Functions

 elementClose ()
 
 elementData ( $data)
 
 elementOpen ( $name, $attribs)
 
 expandNS ( $name, $namespaceURI)
 
 getAttributesArray (XMLReader $r)
 Get all of the attributes for an XMLReader's current node. More...
 
 processingInstructionHandler ( $target, $data)
 
 readNext (XMLReader $reader)
 
 validate ( $reader)
 
 validateFromInput ( $xml, $isFile)
 

Private Attributes

 $parserOptions
 Additional parsing options. More...
 

Detailed Description

Definition at line 28 of file XmlTypeCheck.php.

Constructor & Destructor Documentation

◆ __construct()

XmlTypeCheck::__construct (   $input,
  $filterCallback = null,
  $isFile = true,
  $options = array() 
)
Parameters
string$inputa 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 '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$optionslist of additional parsing options: processing_instruction_handler: Callback for xml_set_processing_instruction_handler

Definition at line 83 of file XmlTypeCheck.php.

References $options, and validateFromInput().

Member Function Documentation

◆ elementClose()

XmlTypeCheck::elementClose ( )
private

Definition at line 293 of file XmlTypeCheck.php.

References $attribs, $name, elementData(), and list.

Referenced by validate().

◆ elementData()

XmlTypeCheck::elementData (   $data)
private
Parameters
$data

Definition at line 314 of file XmlTypeCheck.php.

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

◆ elementOpen()

XmlTypeCheck::elementOpen (   $name,
  $attribs 
)
private
Parameters
$name
$attribs

Definition at line 285 of file XmlTypeCheck.php.

References $attribs, $name, array(), and elementData().

Referenced by validate().

◆ expandNS()

XmlTypeCheck::expandNS (   $name,
  $namespaceURI 
)
private
Parameters
$nameelement or attribute name, maybe with a full or short prefix
$namespaceURIthe namespaceURI
Returns
string the name prefixed with namespaceURI

Definition at line 272 of file XmlTypeCheck.php.

References $name.

Referenced by getAttributesArray(), and validate().

◆ getAttributesArray()

XmlTypeCheck::getAttributesArray ( XMLReader  $r)
private

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

Parameters
$rXMLReader
Returns
array of attributes

Definition at line 253 of file XmlTypeCheck.php.

References $name, array(), and expandNS().

Referenced by validate().

◆ getRootElement()

XmlTypeCheck::getRootElement ( )

Get the root element.

Simple accessor to $rootElement

Returns
string

Definition at line 124 of file XmlTypeCheck.php.

References $rootElement.

◆ newFromFilename()

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

Alternative constructor: from filename.

Parameters
string$fnamethe 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 100 of file XmlTypeCheck.php.

References $fname, and true.

◆ newFromString()

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

Alternative constructor: from string.

Parameters
string$stringa 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 115 of file XmlTypeCheck.php.

References false.

◆ processingInstructionHandler()

XmlTypeCheck::processingInstructionHandler (   $target,
  $data 
)
private
Parameters
$target
$data

Definition at line 323 of file XmlTypeCheck.php.

Referenced by validate().

◆ readNext()

XmlTypeCheck::readNext ( XMLReader  $reader)
private

Definition at line 160 of file XmlTypeCheck.php.

References $ret, and array().

Referenced by validate().

◆ validate()

XmlTypeCheck::validate (   $reader)
private

◆ validateFromInput()

XmlTypeCheck::validateFromInput (   $xml,
  $isFile 
)
private
Parameters
string$fnamethe filename

Definition at line 132 of file XmlTypeCheck.php.

References $e, $s, and validate().

Referenced by __construct().

◆ XmlErrorHandler()

XmlTypeCheck::XmlErrorHandler (   $errno,
  $errstr 
)

Definition at line 167 of file XmlTypeCheck.php.

Member Data Documentation

◆ $elementData

XmlTypeCheck::$elementData = array()
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 52 of file XmlTypeCheck.php.

◆ $elementDataContext

XmlTypeCheck::$elementDataContext = array()
protected

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

Definition at line 57 of file XmlTypeCheck.php.

◆ $filterMatch

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.

◆ $parserOptions

XmlTypeCheck::$parserOptions
private
Initial value:
'processing_instruction_handler' => '',
)

Additional parsing options.

Definition at line 67 of file XmlTypeCheck.php.

◆ $rootElement

XmlTypeCheck::$rootElement = ''

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

Definition at line 45 of file XmlTypeCheck.php.

Referenced by getRootElement().

◆ $stackDepth

XmlTypeCheck::$stackDepth = 0
protected

Current depth of the data stack.

Definition at line 62 of file XmlTypeCheck.php.

◆ $wellFormed

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:
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.