PHPerKaigi 2024

Основы работы с модулем SimpleXML

Часть примеров этого руководства включает XML-строку. Чтобы не повторять строку в каждом примере, её помещают в файл, который и включают в каждый пример. Строка приведена в следующем примере. Кроме этого можно создать XML-документ и считывать его функцией simplexml_load_file().

Пример #1 Файл example.php с XML строкой

<?php
$xmlstr
= <<<XML
<?xml version='1.0' standalone='yes'?>
<movies>
<movie>
<title>PHP: Появление Парсера</title>
<characters>
<character>
<name>Ms. Coder</name>
<actor>Onlivia Actora</actor>
</character>
<character>
<name>Mr. Coder</name>
<actor>El Act&#211;r</actor>
</character>
</characters>
<plot>
Таким образом, это язык. Это всё равно язык программирования. Или
это скриптовый язык? Обо всём рассказывает этот документальный фильм,
похожий на фильм ужасов.
</plot>
<great-lines>
<line>PHP решает все мои проблемы в вебе</line>
</great-lines>
<rating type="thumbs">7</rating>
<rating type="stars">5</rating>
</movie>
</movies>
XML;
?>

Пользоваться модулем SimpleXML очень просто! Попробуйте получить какую-нибудь строку или число из базового XML-документа.

Пример #2 Получение части документа <plot>

<?php

include 'example.php';

$movies = new SimpleXMLElement($xmlstr);

echo
$movies->movie[0]->plot;

?>

Результат выполнения приведённого примера:


   Таким образом, это язык. Это всё равно язык программирования. Или
   это скриптовый язык? Обо всём рассказывает этот документальный фильм,
   похожий на фильм ужасов.

В PHP получить доступ к элементу в XML-документе, который содержит в названии недопустимые символы (например, дефис), можно путём заключения имени элемента в фигурные скобки и апострофы.

Пример #3 Получение строки <line>

<?php

include 'example.php';

$movies = new SimpleXMLElement($xmlstr);

echo
$movies->movie->{'great-lines'}->line;

?>

Результат выполнения приведённого примера:

PHP решает все мои проблемы в вебе

Пример #4 Доступ к неуникальным элементам в SimpleXML

В том случае, если существует несколько экземпляров дочерних элементов в одном родительском элементе, нужно применять стандартные методы итерации.

<?php

include 'example.php';

$movies = new SimpleXMLElement($xmlstr);

/* Для каждого узла <character>, мы отдельно выведем имя <name>. */
foreach ($movies->movie->characters->character as $character) {
echo
$character->name, ' играет ', $character->actor, PHP_EOL;
}

?>

Результат выполнения приведённого примера:

Ms. Coder играет Onlivia Actora
Mr. Coder играет El ActÓr

Замечание:

Свойства ($movies->movie в предыдущем примере) — не массивы. Это итерируемый объект в виде массива.

Пример #5 Работа с атрибутами

До сих пор мы только получали названия и значения элементов. SimpleXML также умеет получать доступ к атрибутам элемента. Получить доступ к атрибуту элемента можно так же, как к элементам массива (array).

<?php

include 'example.php';

$movies = new SimpleXMLElement($xmlstr);

/* Доступ к узлу <rating> первого фильма.
* Так же выведем шкалу оценок. */
foreach ($movies->movie[0]->rating as $rating) {
switch((string)
$rating['type']) { // Получение атрибутов элемента по индексу
case 'thumbs':
echo
$rating, ' thumbs up';
break;
case
'stars':
echo
$rating, ' stars';
break;
}
}

?>

Результат выполнения приведённого примера:

7 thumbs up5 stars

Пример #6 Сравнение элементов и атрибутов с текстом

Для сравнения элемента или атрибута со строкой или для передачи в функцию в качестве текста, необходимо привести его к строке через оператор приведения (string). В противном случае PHP будет рассматривать элемент как объект.

<?php

include 'example.php';

$movies = new SimpleXMLElement($xmlstr);

if ((string)
$movies->movie->title == 'PHP: Появление Парсера') {
print
'Мой любимый фильм.';
}

echo
htmlentities((string) $movies->movie->title);

?>

Результат выполнения приведённого примера:

Мой любимый фильм.PHP: Появление Парсера

Пример #7 Сравнение двух элементов

Два элемента SimpleXMLElements признаются разными, даже если они указывают на один и тот же объект.

<?php

include 'example.php';

$movies1 = new SimpleXMLElement($xmlstr);
$movies2 = new SimpleXMLElement($xmlstr);
var_dump($movies1 == $movies2); // false

?>

Результат выполнения приведённого примера:

bool(false)

Пример #8 XPath — язык запросов к элементам XML-документа

SimpleXML включает встроенную поддержку языка XPath. Поиск элементов <character>:

<?php

include 'example.php';

$movies = new SimpleXMLElement($xmlstr);

foreach (
$movies->xpath('//character') as $character) {
echo
$character->name, ' играет ', $character->actor, PHP_EOL;
}

?>

Запись «//» работает как подстановочный знак, или шаблон. Чтобы указать абсолютный путь, один слеш опускают.

Результат выполнения приведённого примера:

Ms. Coder играет Onlivia Actora
Mr. Coder играет by El ActÓr

Пример #9 Установка значений

Данные в SimpleXML не обязаны быть неизменяемыми. Объект разрешает манипулировать всеми элементами.

<?php

include 'example.php';
$movies = new SimpleXMLElement($xmlstr);

$movies->movie[0]->characters->character[0]->name = 'Miss Coder';

echo
$movies->asXML();

?>

Результат выполнения приведённого примера:

<?xml version="1.0" standalone="yes"?>
<movies>
 <movie>
  <title>PHP: Появление Парсера</title>
  <characters>
   <character>
    <name>Miss Coder</name>
    <actor>Onlivia Actora</actor>
   </character>
   <character>
    <name>Mr. Coder</name>
    <actor>El Act&#xD3;r</actor>
   </character>
  </characters>
  <plot>
   Таким образом, это язык. Это всё равно язык программирования. Или
   это скриптовый язык? Обо всём рассказывает этот документальный фильм,
   похожий на фильм ужасов.
  </plot>
  <great-lines>
   <line>PHP решает все мои задачи в вебе</line>
  </great-lines>
  <rating type="thumbs">7</rating>
  <rating type="stars">5</rating>
 </movie>
</movies>

Пример #10 Добавление элементов и атрибутов

SimpleXML умеет легко добавлять дочерние элементы и атрибуты.

<?php

include 'example.php';
$movies = new SimpleXMLElement($xmlstr);

$character = $movies->movie[0]->characters->addChild('character');
$character->addChild('name', 'Mr. Parser');
$character->addChild('actor', 'John Doe');

$rating = $movies->movie[0]->addChild('rating', 'PG');
$rating->addAttribute('type', 'mpaa');

echo
$movies->asXML();

?>

Результат выполнения приведённого примера:

<?xml version="1.0" standalone="yes"?>
<movies>
 <movie>
  <title>PHP: Появление Парсера</title>
  <characters>
   <character>
    <name>Ms. Coder</name>
    <actor>Onlivia Actora</actor>
   </character>
   <character>
    <name>Mr. Coder</name>
    <actor>El Act&#xD3;r</actor>
   </character>
  <character><name>Mr. Parser</name><actor>John Doe</actor></character></characters>
  <plot>
   Таким образом, это язык. Это всё равно язык программирования. Или
   это скриптовый язык? Обо всём рассказывает этот документальный фильм,
   похожий на фильм ужасов.
  </plot>
  <great-lines>
   <line>PHP решает все мои задачи в вебе</line>
  </great-lines>
  <rating type="thumbs">7</rating>
  <rating type="stars">5</rating>
 <rating type="mpaa">PG</rating></movie>
</movies>

Пример #11 Взаимодействие с DOM

PHP умеет преобразовывать XML-узлы из SimpleXML в формат DOM и наоборот. Пример показывает, как можно изменить DOM-элемент в SimpleXML.

<?php

$dom
= new DOMDocument;
$dom->loadXML('<books><book><title>чепуха</title></book></books>');
if (!
$dom) {
echo
'Ошибка при разборе документа';
exit;
}

$books = simplexml_import_dom($dom);

echo
$books->book[0]->title;

?>

Результат выполнения приведённого примера:

чепуха

add a note

User Contributed Notes 10 notes

up
81
rowan dot collins at gmail dot com
8 years ago
There is a common "trick" often proposed to convert a SimpleXML object to an array, by running it through json_encode() and then json_decode(). I'd like to explain why this is a bad idea.

Most simply, because the whole point of SimpleXML is to be easier to use and more powerful than a plain array. For instance, you can write <?php $foo->bar->baz['bing'] ?> and it means the same thing as <?php $foo->bar[0]->baz[0]['bing'] ?>, regardless of how many bar or baz elements there are in the XML; and if you write <?php (string)$foo->bar[0]->baz[0] ?> you get all the string content of that node - including CDATA sections - regardless of whether it also has child elements or attributes. You also have access to namespace information, the ability to make simple edits to the XML, and even the ability to "import" into a DOM object, for much more powerful manipulation. All of this is lost by turning the object into an array rather than reading understanding the examples on this page.

Additionally, because it is not designed for this purpose, the conversion to JSON and back will actually lose information in some situations. For instance, any elements or attributes in a namespace will simply be discarded, and any text content will be discarded if an element also has children or attributes. Sometimes, this won't matter, but if you get in the habit of converting everything to arrays, it's going to sting you eventually.

Of course, you could write a smarter conversion, which didn't have these limitations, but at that point, you are getting no value out of SimpleXML at all, and should just use the lower level XML Parser functions, or the XMLReader class, to create your structure. You still won't have the extra convenience functionality of SimpleXML, but that's your loss.
up
70
jishcem at gmail dot com
10 years ago
For me it was easier to use arrays than objects,

So, I used this code,

$xml = simplexml_load_file('xml_file.xml');

$json_string = json_encode($xml);

$result_array = json_decode($json_string, TRUE);

Hope it would help someone
up
9
Anonymous
6 years ago
If your xml string contains booleans encoded with "0" and "1", you will run into problems when you cast the element directly to bool:

$xmlstr = <<<XML
<?xml version='1.0' standalone='yes'?>
<values>
<truevalue>1</truevalue>
<falsevalue>0</falsevalue>
</values>
XML;
$values = new SimpleXMLElement($xmlstr);
$truevalue = (bool)$values->truevalue; // true
$falsevalue = (bool)$values->falsevalue; // also true!!!

Instead you need to cast to string or int first:

$truevalue = (bool)(int)$values->truevalue; // true
$falsevalue = (bool)(int)$values->falsevalue; // false
up
17
ie dot raymond at gmail dot com
13 years ago
If you need to output valid xml in your response, don't forget to set your header content type to xml in addition to echoing out the result of asXML():

<?php

$xml
=simplexml_load_file('...');
...
...
xml stuff
...

//output xml in your response:
header('Content-Type: text/xml');
echo
$xml->asXML();
?>
up
11
gkokmdam at zonnet dot nl
13 years ago
A quick tip on xpath queries and default namespaces. It looks like the XML-system behind SimpleXML has the same workings as I believe the XML-system .NET uses: when one needs to address something in the default namespace, one will have to declare the namespace using registerXPathNamespace and then use its prefix to address the otherwise in the default namespace living element.

<?php
$string
= <<<XML
<?xml version='1.0'?>
<document xmlns="http://www.w3.org/2005/Atom">
<title>Forty What?</title>
<from>Joe</from>
<to>Jane</to>
<body>
I know that's the answer -- but what's the question?
</body>
</document>
XML;

$xml = simplexml_load_string($string);
$xml->registerXPathNamespace("def", "http://www.w3.org/2005/Atom");

$nodes = $xml->xpath("//def:document/def:title");

?>
up
8
kdos
13 years ago
Using stuff like: is_object($xml->module->admin) to check if there actually is a node called "admin", doesn't seem to work as expected, since simplexml always returns an object- in that case an empty one - even if a particular node does not exist.
For me good old empty() function seems to work just fine in such cases.

Cheers
up
1
Josef
2 years ago
How to find out if a Node exists:

<?xml version='1.0' standalone='yes'?>
<book>
<author>Josef</author>
<isbn></isbn>
</book>

empty($xml->isbn) will be true
isset($xml->isbn) will be true

empty($xml->title) will be true
isset($xml->title) will be false
up
5
Max K.
13 years ago
From the README file:

SimpleXML is meant to be an easy way to access XML data.

SimpleXML objects follow four basic rules:

1) properties denote element iterators
2) numeric indices denote elements
3) non numeric indices denote attributes
4) string conversion allows to access TEXT data

When iterating properties then the extension always iterates over
all nodes with that element name. Thus method children() must be
called to iterate over subnodes. But also doing the following:
foreach ($obj->node_name as $elem) {
// do something with $elem
}
always results in iteration of 'node_name' elements. So no further
check is needed to distinguish the number of nodes of that type.

When an elements TEXT data is being accessed through a property
then the result does not include the TEXT data of subelements.

Known issues
============

Due to engine problems it is currently not possible to access
a subelement by index 0: $object->property[0].
up
-1
php at keith tyler dot com
14 years ago
[Editor's Note: The SimpleXMLIterator class, however, does implement these methods.]

While SimpleXMLElement claims to be iterable, it does not seem to implement the standard Iterator interface functions like ::next and ::reset properly. Therefore while foreach() works, functions like next(), current(), or each() don't seem to work as you would expect -- the pointer never seems to move or keeps getting reset.
up
-9
radams at circlepix com
14 years ago
To test whether an element exists:

<?php

$xml
= <<<EOT
<?xml version='1.0' standalone='yes'?>
<root>
<test1></test1>
<test2 />
<test4> </test4>
</root>
EOT;

$xmlDoc = new SimpleXMLElement($xml);

echo
"Test1: \n";
var_dump($xmlDoc->test1);
echo
"\n(" . (bool)$xmlDoc->test1 . ")";
echo
"\n\n";

echo
"Test2: \n";
var_dump($xmlDoc->test2);
echo
"\n(" . (bool)$xmlDoc->test2 . ")";
echo
"\n\n";

echo
"Test3: \n";
var_dump($xmlDoc->test3);
echo
"\n(" . (bool)$xmlDoc->test3 . ")";
echo
"\n\n";

echo
"Test4: \n";
var_dump($xmlDoc->test4);
echo
"\n(" . (bool)$xmlDoc->test4 . ")";
echo
"\n\n";

?>

The var_dumps for test1, test2, and test3 are identical, but the (bool) test gives a '1' for test1 and test2, and a '' for test3.
To Top