xml_parse_into_struct

(PHP 4, PHP 5, PHP 7, PHP 8)

xml_parse_into_structРазбор XML-данных и помещение в массив

Описание

xml_parse_into_struct(
    XMLParser$parser,
    string$data,
    array&$values,
    array&$index = null
): int

Эта функция разбирает XML-строку и помещает данные в 2 массива. Массив index содержит указатели на размещение значений в массиве values. Аргументы, задающие массивы, должны передаваться в функцию по ссылке.

Список параметров

parser

Ссылка на используемый XML-анализатор.

data

Строка XML-данных.

values

Массив значений XML-данных.

index

Массив указателей на соответствующие значения в массиве $values.

Возвращаемые значения

xml_parse_into_struct() возвращает 0 при неудачном разборе строки и 1 при успешном. Это не то же самое, что false и true, будьте осторожны с такими операторами, как ===.

Список изменений

ВерсияОписание
8.0.0 Параметр parser ожидает экземпляр класса XMLParser; раньше параметр ждал корректный xml-ресурс (resource).

Примеры

Ниже представлен пример, демонстрирующий внутреннее устройство массивов, генерируемых функцией. XML-строка содержит простой тег note вложенный в тег para. Программа в примере разбирает эту строку и выводит созданные массивы:

Пример #1 Пример использования xml_parse_into_struct()

<?php
$simple
= "<para><note>простое примечание</note></para>";
$p = xml_parser_create();
xml_parse_into_struct($p, $simple, $vals, $index);
xml_parser_free($p);
echo
"Массив index\n";
print_r($index);
echo
"\nМассив vals\n";
print_r($vals);
?>

После обработки программа выведет следующее:

Index array Array ( [PARA] => Array ( [0] => 0 [1] => 2 ) [NOTE] => Array ( [0] => 1 ) ) Массив Vals Array ( [0] => Array ( [tag] => PARA [type] => open [level] => 1 ) [1] => Array ( [tag] => NOTE [type] => complete [level] => 2 [value] => простое примечание ) [2] => Array ( [tag] => PARA [type] => close [level] => 1 ) )

Управляемый событиями разбор (основанный на библиотеке expat) может дать труднообрабатываемый результат в случае, если разбирается составной XML-документ. Эта функция не создаёт DOM-объектов, но создаваемые ею массивы можно преобразовать в древовидную структуру впоследствии. Таким образом можно довольно просто создавать объекты, представляющие содержимое XML-файла. Предположим, что следующий XML файл представляет небольшую базу данных с информацией об аминокислотах:

Пример #2 moldb.xml - небольшая база данных с информацией о молекулах

<?xml version="1.0"?> <moldb> <molecule> <name>Alanine</name> <symbol>ala</symbol> <code>A</code> <type>hydrophobic</type> </molecule> <molecule> <name>Lysine</name> <symbol>lys</symbol> <code>K</code> <type>charged</type> </molecule> </moldb>
Код, разбирающий документ и создающий подходящие объекты:

Пример #3 parsemoldb.php - разбирает moldb.xml и помещает данные в массив молекул

<?php

class AminoAcid {
var
$name; // название аминокислоты
var $symbol; // трёхбуквенное обозначение
var $code; // однобуквенный код
var $type; // гидрофобная, заряженная, нейтральная

function __construct ($aa)
{
foreach (
$aa as $k=>$v)
$this->$k = $aa[$k];
}
}

function
readDatabase($filename)
{
// чтение XML-базы данных аминокислот
$data = file_get_contents($filename);
$parser = xml_parser_create();
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
xml_parse_into_struct($parser, $data, $values, $tags);
xml_parser_free($parser);

// проход через структуры
foreach ($tags as $key=>$val) {
if (
$key == "molecule") {
$molranges = $val;
// каждая смежная пара значений массивов является верхней и
После выполнения parsemoldb.php переменная $db содержит массив объектов AminoAcid, а вывод соответственно следующий:
** База данных аминокислот: Array ( [0] => aminoacid Object ( [name] => Alanine [symbol] => ala [code] => A [type] => hydrophobic ) [1] => aminoacid Object ( [name] => Lysine [symbol] => lys [code] => K [type] => charged ) )
To Top