The XMLReader class

(PHP 5 >= 5.1.0, PHP 7)

Introducción

La extensión XMLReader es un analizador de XML. El lector actúa como un cursor yendo hacia adelante en la corriente del documento y deteniéndose en cada nodo del camino.

Sinopsis de la Clase

XMLReader {

/* Constantes */

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 ;

/* Propiedades */

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 ;

/* Métodos */

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 ) : bool

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

}

Propiedades

attributeCount: El número de atributos en el nodo
baseURI: La base URI del nodo
depth: La profundidad del nodo en el árbol, empezando en 0
hasAttributes: Indica si el nodo tiene atributos
hasValue: Indica si el nodo tiene un valor de texto
isDefault: Indica si el atributo está por defecto del DTD
isEmptyElement: Indica si el nodo es un elemento vacio de etiqueta
localName: El nombre local del nodo
name: El nombre calificado del nodo
namespaceURI: El URI del namespace asociado con el nodo
nodeType: El tipo de nodo para el nodo
prefix: El prefijo del namespace asociado con el nodo
value: El valor de texto del nodo
xmlLang: El xml: El lang scope el cual el nodo reside

Constantes predefinidas

XMLReader Node Types

XMLReader::NONE: Sin tipo de nodo
XMLReader::ELEMENT: Empieza el eleménto
XMLReader::ATTRIBUTE: El atributo del nodo
XMLReader::TEXT: El nodo de texto
XMLReader::CDATA: El CDATA del nodo
XMLReader::ENTITY_REF: La entidad de refencia del nodo
XMLReader::ENTITY: La entidad de declaración del nodo
XMLReader::PI: La instrucción de proceso del nodo
XMLReader::COMMENT: El comentario del nodo
XMLReader::DOC: El documento del nodo
XMLReader::DOC_TYPE: El tipo de documento del nodo
XMLReader::DOC_FRAGMENT: El fragmento del documento del nodo
XMLReader::NOTATION: La notación del nodo
XMLReader::WHITESPACE: El espacio en blanco del nodo
XMLReader::SIGNIFICANT_WHITESPACE: El espacio en blanco significante del nodo
XMLReader::END_ELEMENT: El fin del eleménto
XMLReader::END_ENTITY: La entidad final
XMLReader::XML_DECLARATION: La declaración XML del nodo

XMLReader Parser Options

XMLReader::LOADDTD: Carga el DTD pero no lo valida
XMLReader::DEFAULTATTRS: Carga el DTD y los atributos por defecto pero no los valida
XMLReader::VALIDATE: Carga el DTD y valida el analizado en blanco
XMLReader::SUBST_ENTITIES: Substituye las entidades y expande las referencias

Tabla de contenidos

XMLReader::close — Cierra la entrada del XMLReader
XMLReader::expand — Devuelve una copia del actual nodo como un objeto DOM
XMLReader::getAttribute — Obtiener el valor del atributo nombrado
XMLReader::getAttributeNo — Obtiene el valor de un atributo por el indice
XMLReader::getAttributeNs — Obtiene el valor de un atributo por su nombre local y URI
XMLReader::getParserProperty — Indica si la porpiedad especificada ha sido establecida
XMLReader::isValid — Indica si el documento analizado es válido
XMLReader::lookupNamespace — Busca el namespace para un prefijo
XMLReader::moveToAttribute — Mueve el cursor a un atributo nombrado
XMLReader::moveToAttributeNo — Mueve el cursor a un atributo por su índice
XMLReader::moveToAttributeNs — Mover el cursor a un atributo dado
XMLReader::moveToElement — Posiciona el cursor en el eleménto padre del actual atributo
XMLReader::moveToFirstAttribute — Posiciona el cursor en el primer atributo
XMLReader::moveToNextAttribute — Posiciona el cursor en el siguiente atributo
XMLReader::next — Mueve el cursor al siguiente nodo saltandose todos los subárboles
XMLReader::open — Establece el URI conteniendo el XML a analizar
XMLReader::read — Se mueve al siguiente nodo en el documento
XMLReader::readInnerXML — Recupera el XML del actual nodo
XMLReader::readOuterXML — Recupera el XML del actual nodo, incluyendo él mismo
XMLReader::readString — Lee el contenido del nodo actual como string
XMLReader::setParserProperty — Establecer las opciones del analizador
XMLReader::setRelaxNGSchema — Establece el nomb re del archivo o el URI para un esquema RelaxNG
XMLReader::setRelaxNGSchemaSource — Establece los datos contenidos en un esquema RelaxNG
XMLReader::setSchema — Valida el documento en contra del XSD
XMLReader::XML — Establece el contenido del XML a analizar