Класс XMLReader

(PHP 5 >= 5.1.0, PHP 7)

Введение

Расширение XMLReader - синтаксический анализатор XML. Класс-читатель выступает в качестве курсора, следует по потоку документа и останавливается на каждом узле на этом пути.

Обзор классов

XMLReader {

/* Константы */

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 ;

/* Свойства */

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 ;

/* Методы */

public close ( ) : bool

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

public getAttribute ( string $name ) : string|null

public getAttributeNo ( int $index ) : string|null

public getAttributeNs ( string $name , string $namespace ) : string|null

public getParserProperty ( int $property ) : bool

public isValid ( ) : bool

public lookupNamespace ( string $prefix ) : string|null

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|null $name = null ) : bool

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

public read ( ) : bool

public readInnerXml ( ) : string

public readOuterXml ( ) : string

public readString ( ) : string

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

public setRelaxNGSchema ( string|null $filename ) : bool

public setRelaxNGSchemaSource ( string|null $source ) : bool

public setSchema ( string|null $filename ) : bool

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

}

Свойства

attributeCount: Количество атрибутов в узле
baseURI: Базовый URI узла
depth: Глубина узла в дереве, начиная с 0
hasAttributes: Показывает, есть ли у узла атрибуты
hasValue: Показывает, имеет ли узел текстовое значение
isDefault: Показывает, является ли атрибутом по умолчанию из DTD
isEmptyElement: Показывает, является ли узел пустым тегом
localName: Локальное имя узла
name: Полностью определенное имя узла
namespaceURI: URI пространства имён связанный с узлом
nodeType: Тип узла
prefix: Префикс пространства имён связанный с узлом
value: Текстовое значение узла
xmlLang: Контекст xml:lang, в котором находится узел

Предопределенные константы

Типы узлов XMLReader

XMLReader::NONE: Нет типа узла
XMLReader::ELEMENT: Начальный элемент
XMLReader::ATTRIBUTE: Узел атрибута
XMLReader::TEXT: Текстовый узел
XMLReader::CDATA: Узел CDATA
XMLReader::ENTITY_REF: Узел ссылки на сущность
XMLReader::ENTITY: Узел объявления объекта
XMLReader::PI: Узел инструкций обработки
XMLReader::COMMENT: Узел комментария
XMLReader::DOC: Узел документа
XMLReader::DOC_TYPE: Узел типа документа
XMLReader::DOC_FRAGMENT: Узел фрагмента документа
XMLReader::NOTATION: Узел нотации
XMLReader::WHITESPACE: Пробельный узел
XMLReader::SIGNIFICANT_WHITESPACE: Существенный пробельный узел
XMLReader::END_ELEMENT: Завершение элемента
XMLReader::END_ENTITY: Завершение объекта
XMLReader::XML_DECLARATION: Узел XML объявления

Опции анализатора XMLReader

XMLReader::LOADDTD: Загружать DTD, но не проверять
XMLReader::DEFAULTATTRS: Загружать DTD и атрибуты по умолчанию, но не проверять
XMLReader::VALIDATE: Загружать DTD и проверять при разборе
XMLReader::SUBST_ENTITIES: Заменять объекты и разворачивать ссылки

Содержание

XMLReader::close — Закрыть ввод XMLReader
XMLReader::expand — Возвратить копию текущего узла в виде объекта DOM
XMLReader::getAttribute — Получить значение атрибута с определённым именем
XMLReader::getAttributeNo — Получить значение атрибута по индексу
XMLReader::getAttributeNs — Получить значение атрибута по localname и URI
XMLReader::getParserProperty — Указывает, было ли определенное свойство установлено
XMLReader::isValid — Показать, является ли разбираемый документ синтаксически правильным
XMLReader::lookupNamespace — Найти пространство имён для префикса
XMLReader::moveToAttribute — Переместить курсор к атрибуту с заданным именем
XMLReader::moveToAttributeNo — Переместить курсор на атрибут по индексу
XMLReader::moveToAttributeNs — Переместить курсор к именованному атрибуту
XMLReader::moveToElement — Позиционировать курсор на родительском элементе текущего атрибута
XMLReader::moveToFirstAttribute — Переместить позицию курсора на первый атрибут
XMLReader::moveToNextAttribute — Переместить позицию курсора на следующий атрибут
XMLReader::next — Переместить курсор на следующий узел, пропуская все поддеревья
XMLReader::open — Установить URI, содержащий XML-документ для разбора
XMLReader::read — Переместиться к следующему узлу в документе
XMLReader::readInnerXml — Извлечь XML из текущего узла
XMLReader::readOuterXml — Получить XML из текущего узла, включая сам узел
XMLReader::readString — Прочитать содержимое текущего узла как строку
XMLReader::setParserProperty — Устанавливает опцию парсера
XMLReader::setRelaxNGSchema — Установить имя файла или URI для схемы RelaxNG
XMLReader::setRelaxNGSchemaSource — Устанавливает данные, содержащие схему RelaxNG
XMLReader::setSchema — Проверить документ, используя XSD
XMLReader::XML — Установить данные, содержащие XML для разбора