php8.5
/
Download
Home/ Manual/ reference / xmlreader/ The XMLReader class

The XMLReader class

Guide Edit on GitHub ✎

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.

Intro

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

class XMLReader { }

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

Changelog

VersionDescription
8.4.0The class constants are now typed.

Xmlreader

In this section

XMLReader::XML

Set the data containing the XML to parse

XMLReader::close

Close the XMLReader input

XMLReader::expand

Returns a copy of the current node as a DOM object

XMLReader::fromStream

Creates an XMLReader from a stream to read from

XMLReader::fromString

Creates an XMLReader from an XML string

XMLReader::fromUri

Creates an XMLReader from a URI to read from

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 itself

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

Source: reference/xmlreader/xmlreader.xml · from the official PHP manual (php/doc-en)