The XMLReader class

(PHP 5 >= 5.1.0)

Introduction

The XMLReader extension is an XML Pull parser. The reader acts as a cursor going forward on the document stream and stopping at each node on the way.

Class synopsis

XMLReader {

/* Constants */

const int NONE = 0 ;

const int ELEMENT = 1 ;

const int ATTRIBUTE = 2 ;

const int TEXT = 3 ;

const int CDATA = 4 ;

const int ENTITY_REF = 5 ;

const int ENTITY = 6 ;

const int PI = 7 ;

const int COMMENT = 8 ;

const int DOC = 9 ;

const int DOC_TYPE = 10 ;

const int DOC_FRAGMENT = 11 ;

const int NOTATION = 12 ;

const int WHITESPACE = 13 ;

const int SIGNIFICANT_WHITESPACE = 14 ;

const int END_ELEMENT = 15 ;

const int END_ENTITY = 16 ;

const int XML_DECLARATION = 17 ;

const int LOADDTD = 1 ;

const int DEFAULTATTRS = 2 ;

const int VALIDATE = 3 ;

const int SUBST_ENTITIES = 4 ;

/* Properties */

public readonly int $attributeCount ;

public readonly string $baseURI ;

public readonly int $depth ;

public readonly bool $hasAttributes ;

public readonly bool $hasValue ;

public readonly bool $isDefault ;

public readonly bool $isEmptyElement ;

public readonly string $localName ;

public readonly string $name ;

public readonly string $namespaceURI ;

public readonly int $nodeType ;

public readonly string $prefix ;

public readonly string $value ;

public readonly string $xmlLang ;

/* Methods */

public bool close ( void )

public DOMNode expand ([ DOMNode $basenode ] )

public string getAttribute ( string $name )

public string getAttributeNo ( int $index )

public string getAttributeNs ( string $localName , string $namespaceURI )

public bool getParserProperty ( int $property )

public bool isValid ( void )

public bool lookupNamespace ( string $prefix )

public bool moveToAttribute ( string $name )

public bool moveToAttributeNo ( int $index )

public bool moveToAttributeNs ( string $localName , string $namespaceURI )

public bool moveToElement ( void )

public bool moveToFirstAttribute ( void )

public bool moveToNextAttribute ( void )

public bool next ([ string $localname ] )

public bool open ( string $URI [, string $encoding [, int $options = 0 ]] )

public bool read ( void )

public string readInnerXML ( void )

public string readOuterXML ( void )

public string readString ( void )

public bool setParserProperty ( int $property , bool $value )

public bool setRelaxNGSchema ( string $filename )

public bool setRelaxNGSchemaSource ( string $source )

public bool setSchema ( string $filename )

public bool xml ( string $source [, string $encoding [, int $options = 0 ]] )

}

Properties

attributeCount: The number of attributes on the node
baseURI: The base URI of the node
depth: Depth of the node in the tree, starting at 0
hasAttributes: Indicates if node has attributes
hasValue: Indicates if node has a text value
isDefault: Indicates if attribute is defaulted from DTD
isEmptyElement: Indicates if node is an empty element tag
localName: The local name of the node
name: The qualified name of the node
namespaceURI: The URI of the namespace associated with the node
nodeType: The node type for the node
prefix: The prefix of the namespace associated with the node
value: The text value of the node
xmlLang: The xml:lang scope which the node resides

Predefined Constants

XMLReader Node Types

XMLReader::NONE: No node type
XMLReader::ELEMENT: Start element
XMLReader::ATTRIBUTE: Attribute node
XMLReader::TEXT: Text node
XMLReader::CDATA: CDATA node
XMLReader::ENTITY_REF: Entity Reference node
XMLReader::ENTITY: Entity Declaration node
XMLReader::PI: Processing Instruction node
XMLReader::COMMENT: Comment node
XMLReader::DOC: Document node
XMLReader::DOC_TYPE: Document Type node
XMLReader::DOC_FRAGMENT: Document Fragment node
XMLReader::NOTATION: Notation node
XMLReader::WHITESPACE: Whitespace node
XMLReader::SIGNIFICANT_WHITESPACE: Significant Whitespace node
XMLReader::END_ELEMENT: End Element
XMLReader::END_ENTITY: End Entity
XMLReader::XML_DECLARATION: XML Declaration node

XMLReader Parser Options

XMLReader::LOADDTD: Load DTD but do not validate
XMLReader::DEFAULTATTRS: Load DTD and default attributes but do not validate
XMLReader::VALIDATE: Load DTD and validate while parsing
XMLReader::SUBST_ENTITIES: Substitute entities and expand references

XMLReader::close — Close the XMLReader input
XMLReader::expand — Returns a copy of the current node as a DOM object
XMLReader::getAttribute — Get the value of a named attribute
XMLReader::getAttributeNo — Get the value of an attribute by index
XMLReader::getAttributeNs — Get the value of an attribute by localname and URI
XMLReader::getParserProperty — Indicates if specified property has been set
XMLReader::isValid — Indicates if the parsed document is valid
XMLReader::lookupNamespace — Lookup namespace for a prefix
XMLReader::moveToAttribute — Move cursor to a named attribute
XMLReader::moveToAttributeNo — Move cursor to an attribute by index
XMLReader::moveToAttributeNs — Move cursor to a named attribute
XMLReader::moveToElement — Position cursor on the parent Element of current Attribute
XMLReader::moveToFirstAttribute — Position cursor on the first Attribute
XMLReader::moveToNextAttribute — Position cursor on the next Attribute
XMLReader::next — Move cursor to next node skipping all subtrees
XMLReader::open — Set the URI containing the XML to parse
XMLReader::read — Move to next node in document
XMLReader::readInnerXML — Retrieve XML from current node
XMLReader::readOuterXML — Retrieve XML from current node, including it self
XMLReader::readString — Reads the contents of the current node as a string
XMLReader::setParserProperty — Set parser options
XMLReader::setRelaxNGSchema — Set the filename or URI for a RelaxNG Schema
XMLReader::setRelaxNGSchemaSource — Set the data containing a RelaxNG Schema
XMLReader::setSchema — Validate document against XSD
XMLReader::XML — Set the data containing the XML to parse