The XMLReader class

(PHP 5 >= 5.1.0, PHP 7)

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.

PHP: XMLReader - Manual Home of Manuel PHP Contents Haut

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 close ( void ) : bool

public expand ([ DOMNode $basenode ] ) : DOMNode

public getAttribute ( string $name ) : string

public getAttributeNo ( int $index ) : string

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

public getParserProperty ( int $property ) : bool

public isValid ( void ) : bool

public lookupNamespace ( string $prefix ) : string

public moveToAttribute ( string $name ) : bool

public moveToAttributeNo ( int $index ) : bool

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

public moveToElement ( void ) : bool

public moveToFirstAttribute ( void ) : bool

public moveToNextAttribute ( void ) : bool

public next ([ string $localname ] ) : bool

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

public read ( void ) : bool

public readInnerXml ( void ) : string

public readOuterXml ( void ) : string

public readString ( void ) : string

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

public setRelaxNGSchema ( string $filename ) : bool

public setRelaxNGSchemaSource ( string $source ) : bool

public setSchema ( string $filename ) : bool

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

}

PHP: XMLReader - Manual Home of Manuel PHP Contents Haut

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

PHP: XMLReader - Manual Home of Manuel PHP Contents Haut

Predefined Constants

PHP: XMLReader - Manual Home of Manuel PHP Contents Haut

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

PHP: XMLReader - Manual Home of Manuel PHP Contents Haut

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

PHP: XMLReader - Manual Home of Manuel PHP Contents Haut

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 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
XMLReader::XML — Set the data containing the XML to parse

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.xmlreader.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

The XMLReader class

Introduction

Class synopsis

Properties

Predefined Constants

XMLReader Node Types

XMLReader Parser Options

Table of Contents

References