A classe XMLReader

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Introdução

A extensão XMLReader é um analisador XML Pull. O leitor atua como um cursor que avança no fluxo de documentos e para em cada nó ao longo do caminho.

Resumo da classe

class XMLReader {

/* Constantes */

public const int NONE;

public const int ELEMENT;

public const int ATTRIBUTE;

public const int TEXT;

public const int CDATA;

public const int ENTITY_REF;

public const int ENTITY;

public const int PI;

public const int COMMENT;

public const int DOC;

public const int DOC_TYPE;

public const int DOC_FRAGMENT;

public const int NOTATION;

public const int WHITESPACE;

public const int SIGNIFICANT_WHITESPACE;

public const int END_ELEMENT;

public const int END_ENTITY;

public const int XML_DECLARATION;

public const int LOADDTD;

public const int DEFAULTATTRS;

public const int VALIDATE;

public const int SUBST_ENTITIES;

/* Propriedades */

public int $attributeCount;

public string $baseURI;

public int $depth;

public bool $hasAttributes;

public bool $hasValue;

public bool $isDefault;

public bool $isEmptyElement;

public string $localName;

public string $name;

public string $namespaceURI;

public int $nodeType;

public string $prefix;

public string $value;

public string $xmlLang;

/* Métodos */

public close(): true

public expand(?DOMNode $baseNode = null): DOMNode|false

public static fromStream(
    resource $stream,
    ?string $encoding = null,
    int $flags = 0,
    ?string $documentUri = null
): static

public static fromString(string $source, ?string $encoding = null, int $flags = 0): static

public static fromUri(string $uri, ?string $encoding = null, int $flags = 0): static

public getAttribute(string $name): ?string

public getAttributeNo(int $index): ?string

public getAttributeNs(string $name, string $namespace): ?string

public getParserProperty(int $property): bool

public isValid(): bool

public lookupNamespace(string $prefix): ?string

public moveToAttribute(string $name): bool

public moveToAttributeNo(int $index): bool

public moveToAttributeNs(string $name, string $namespace): bool

public moveToElement(): bool

public moveToFirstAttribute(): bool

public moveToNextAttribute(): bool

public next(?string $name = null): bool

public static open(string $uri, ?string $encoding = null, int $flags = 0): XMLReader

public open(string $uri, ?string $encoding = null, int $flags = 0): bool

public read(): bool

public readInnerXml(): string

public readOuterXml(): string

public readString(): string

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

public setRelaxNGSchema(?string $filename): bool

public setRelaxNGSchemaSource(?string $source): bool

public setSchema(?string $filename): bool

public static XML(string $source, ?string $encoding = null, int $flags = 0): XMLReader

public XML(string $source, ?string $encoding = null, int $flags = 0): bool

}

Propriedades

attributeCount: O número de atributos no nó
baseURI: O URI base do nó
depth: Profundidade do nó na árvore, começando em 0
hasAttributes: Indica se o nó possui atributos
hasValue: Indica se o nó possui um valor de texto
isDefault: Indica se o atributo é definido por padrão a partir do DTD
isEmptyElement: Indica se o nó é uma tag de elemento vazia
localName: O nome local do nó
name: O nome qualificado do nó
namespaceURI: O URI do namespace associado ao nó
nodeType: O tipo de nó para o nó
prefix: O prefixo do namespace associado ao nó
value: O valor de texto do nó
xmlLang: O escopo xml:lang no qual o nó reside

Constantes predefinidas

Tipos de nós XMLReader

XMLReader::NONE: Nenhum tipo de nó
XMLReader::ELEMENT: Elemento inicial
XMLReader::ATTRIBUTE: Nó de atributo
XMLReader::TEXT: Nó de texto
XMLReader::CDATA: Nó CDATA
XMLReader::ENTITY_REF: Nó Referência de Entidade
XMLReader::ENTITY: Nó Declaração de Entidade
XMLReader::PI: Nó de Instrução de Processamento
XMLReader::COMMENT: Nó de Comentário
XMLReader::DOC: Nó de Documento
XMLReader::DOC_TYPE: Nó Tipo de Documento
XMLReader::DOC_FRAGMENT: Nó Fragmento de Documento
XMLReader::NOTATION: Nó Notação
XMLReader::WHITESPACE: Nó de espaço em branco
XMLReader::SIGNIFICANT_WHITESPACE: Nó de espaço em branco significativo
XMLReader::END_ELEMENT: Elemento final
XMLReader::END_ENTITY: Entidade Final
XMLReader::XML_DECLARATION: Nó de Declaração XML

Opções do analisador XMLReader

XMLReader::LOADDTD: Carregar DTD, mas não validar
XMLReader::DEFAULTATTRS: Carregar DTD e atributos padrão, mas não validar
XMLReader::VALIDATE: Carregar DTD e validar enquanto analisa
XMLReader::SUBST_ENTITIES: Substituir entidades e expandir referências

Registro de Alterações

Versão	Descrição
8.4.0	As constantes de classe agora são tipadas.

Índice

XMLReader::close — Fecha a entrada XMLReader
XMLReader::expand — Retorna uma cópia do nó atual como um objeto DOM
XMLReader::fromStream — Cria um XMLReader a partir de um fluxo para leitura
XMLReader::fromString — Cria um XMLReader a partir de uma string XML
XMLReader::fromUri — Cria um XMLReader a partir de um URI para leitura
XMLReader::getAttribute — Obtém o valor de um atributo nomeado
XMLReader::getAttributeNo — Obtém o valor de um atributo pelo índice
XMLReader::getAttributeNs — Obtém o valor de um atributo pelo nome local e URI do namespace
XMLReader::getParserProperty — Indica se a propriedade especificada foi definida
XMLReader::isValid — Indica se o documento analisado é válido
XMLReader::lookupNamespace — Busca namespace para um prefixo
XMLReader::moveToAttribute — Move o cursor para um atributo nomeado
XMLReader::moveToAttributeNo — Move o cursor para um atributo pelo índice
XMLReader::moveToAttributeNs — Move o cursor para um atributo nomeado
XMLReader::moveToElement — Posiciona o cursor no elemento pai do atributo atual
XMLReader::moveToFirstAttribute — Posiciona o cursor no primeiro atributo
XMLReader::moveToNextAttribute — Posiciona o cursor no próximo atributo
XMLReader::next — Move o cursor para o próximo nó pulando todas as subárvores
XMLReader::open — Define o URI que contém o XML a ser analisado
XMLReader::read — Move para o próximo nó no documento
XMLReader::readInnerXml — Obtém XML do nó atual
XMLReader::readOuterXml — Obtém XML do nó atual, incluindo ele mesmo
XMLReader::readString — Lê o conteúdo do nó atual como uma string
XMLReader::setParserProperty — Define opções do analisador
XMLReader::setRelaxNGSchema — Define o nome do arquivo ou URI para um esquema RelaxNG
XMLReader::setRelaxNGSchemaSource — Define os dados contendo um esquema RelaxNG
XMLReader::setSchema — Valida documento contra XSD
XMLReader::XML — Define os dados contendo o XML a ser analisado