PHP: полный мануал с примерами, функциями и ООП

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order/>');
$order = $document->documentElement;
$item = $document->createElement('item');
$item->textContent = 'Book';
echo 'До вставки: ', $document->saveXml($order), "\n";
$added = $order->appendChild($item);
$added->setAttribute('sku', 'B1');
echo 'После вставки: ', $document->saveXml($order), "\n";

До вставки: <order/>
После вставки: <order><item sku="B1">Book</item></order>

CreateElement создал отдельный item; запись textContent добавила его текст Book. До appendChild заказ ещё пуст. Метод вызывается у order, получает объект item и возвращает этот же добавленный узел в added. Поэтому setAttribute через added присваивает sku=B1 товару внутри заказа. Изменение видно в полной XML-строке; второй товар от присваивания не появился.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<shop><pending><item>Book</item></pending><ready/></shop>');
$shop = $document->documentElement;
$pending = $shop->firstElementChild;
$ready = $pending->nextElementSibling;
$item = $pending->firstElementChild;
$ready->appendChild($item);
echo $document->saveXml($shop), "\n";
echo 'Теперь товар в: ', $item->parentNode->nodeName, "\n";

<shop><pending/><ready><item>Book</item></ready></shop>
Теперь товар в: ready

FirstElementChild берёт первого ребёнка-элемент, nextElementSibling —следующего соседа-элемент. Ready получает существующий item: appendChild переносит его, не копирует. Pending стал пустым, parentNode у item теперь ready. Если нужно сохранить товар в обоих списках, сначала создайте отдельную копию cloneNode(true).

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order><item>Book</item></order>');
$order = $document->documentElement;
$item = $order->firstChild;
$notice = $document->createElement('notice');
$notice->textContent = 'Check address';
$inserted = $order->insertBefore($notice, $item);
echo 'Вставлено: ', $inserted->textContent, "\n";
echo $document->saveXml($order), "\n";

Вставлено: Check address
<order><notice>Check address</notice><item>Book</item></order>

Item —объект существующего ребёнка, а не строка item. Первый аргумент notice задаёт новый узел, второй item —соседа справа от него. Return попадает в inserted, откуда читается текст добавленной заметки. В этом XML нет пробельных Text между тегами; если они есть, firstChild может оказаться текстом, и для элемента удобнее firstElementChild.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<queue><task>normal</task></queue>');
$queue = $document->documentElement;
$urgent = $document->createElement('task');
$urgent->textContent = 'urgent';
$queue->insertBefore($urgent, $queue->firstChild);
$last = $document->createElement('task');
$last->textContent = 'later';
$queue->insertBefore($last, null);
foreach ($queue->childNodes as $task) {
    echo $task->textContent, "
";
}

urgent
normal
later

null — осознанное отсутствие опорного узла. Чтобы вставить после найденного узла, можно передать его nextSibling; если он последний, это как раз null.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<product><price>100</price></product>');
$product = $document->documentElement;
$newPrice = $document->createElement('price');
$newPrice->textContent = '120';
$oldPrice = $product->replaceChild($newPrice, $product->firstChild);
echo 'Товар после правки: ', $document->saveXml($product), "\n";
echo 'Снятая версия: ', $document->saveXml($oldPrice), "\n";

Товар после правки: <product><price>120</price></product>
Снятая версия: <price>100</price>

Аргументы идут в порядке новый, старый. Но return —именно снятый старый price100, сохранённый в oldPrice. SaveXml может прочитать его и после отсоединения. Новая цена120 уже в product. Старый узел остался связан с ownerDocument, но больше не является ребёнком product; ниже этот возврат позволяет откатить локальную правку.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<product><price>100</price></product>');
$product = $document->documentElement;
$replacement = $document->createElement('price');
$replacement->textContent = '-20';
$old = $product->replaceChild($replacement, $product->firstChild);
if ((int) $replacement->textContent < 0) {
    $product->replaceChild($old, $replacement);
}
echo $product->textContent, "
";

100

Это откат только двух узлов в памяти, не транзакция базы данных и не общая отмена произвольного импорта. Практичнее проверять цену до мутации; пример показывает, какой объект возвращён и как его вернуть.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<shop><order><item>Book</item></order><archive/></shop>');
$shop = $document->documentElement;
$order = $shop->firstElementChild;
$archive = $order->nextElementSibling;
$removed = $order->removeChild($order->firstChild);
echo 'Удалённый товар: ', $removed->textContent, "\n";
echo 'После удаления: ', $document->saveXml($shop), "\n";
$archive->appendChild($removed);
echo 'После архивирования: ', $document->saveXml($shop), "\n";

Удалённый товар: Book
После удаления: <shop><order/><archive/></shop>
После архивирования: <shop><order/><archive><item>Book</item></archive></shop>

RemoveChild разорвал связь order→item и вернул живой объект в removed. Текст ещё доступен; второй вызов appendChild использует возвращённый узел в архиве того же документа. Удаление из дерева не уничтожило данные. Так различаются удалённая связь, оставшийся PHP-объект и новая связь archive→item.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<cart><item>A</item><item>B</item><item>C</item></cart>');
$cart = $document->documentElement;
$removedNames = [];
while ($cart->firstChild !== null) {
    $removed = $cart->removeChild($cart->firstChild);
    $removedNames[] = $removed->textContent;
}
echo 'Сняты позиции: ', implode(', ', $removedNames), "\n";
echo 'Корзина: ', $document->saveXml($cart), "\n";

Сняты позиции: A, B, C
Корзина: <cart/>

While каждый раз заново читает первого оставшегося ребёнка: сначалаA, затемB, затемC. Присваивание [] добавляет его название в массив; implode соединяет названия для журнала. После C firstChild равен null и цикл заканчивается. При увеличении индекса живой коллекции следующая позиция могла бы сдвинуться на уже пройденный индекс.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<item sku="A"><name>Book</name></item>');
$item = $document->documentElement;
$shallow = $item->cloneNode();
$deep = $item->cloneNode(true);
echo 'Без детей: ', $document->saveXml($shallow), "\n";
echo 'С детьми: ', $document->saveXml($deep), "\n";
echo 'Исходник: ', $document->saveXml($item), "\n";

Без детей: <item sku="A"/>
С детьми: <item sku="A"><name>Book</name></item>
Исходник: <item sku="A"><name>Book</name></item>

Без аргумента deep=false: атрибут sku скопирован, ребёнок name и его Text Book —нет. True копирует всё поддерево. Оба return —отдельные узлы без родителя; сохранение их строкой не вставляет копии в исходный документ. Чтобы создать второй товар в каталоге, нужно отдельно изменить id и вызвать appendChild, как ниже.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog><item id="A"><name>Book</name></item></catalog>');
$catalog = $document->documentElement;
$copy = $catalog->firstElementChild->cloneNode(true);
$copy->setAttribute('id', 'B');
$copy->firstElementChild->textContent = 'Notebook';
$catalog->appendChild($copy);
foreach ($catalog->childNodes as $item) {
    echo $item->getAttribute('id'), ':', $item->textContent, "
";
}

A:Book
B:Notebook

Здесь копия глубока относительно DOM-дерева. Это другой механизм, чем обычный PHP clone с вложенными пользовательскими объектами; правила свойств PHP-класса не подменяют правила DOM.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label/>');
$label = $document->documentElement;
$label->appendChild($document->createTextNode('A'));
$label->appendChild($document->createTextNode('B'));
echo $label->childNodes->length, ':', $label->textContent, "
";
$label->normalize();
echo $label->childNodes->length, ':', $label->textContent, "
";

2:AB
1:AB

Один и тот же видимый текст может состоять из разного числа узлов. Нормализация убирает эту зависимость для соседних текстовых фрагментов.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<description/>');
$description = $document->documentElement;
$description->appendChild($document->createTextNode('Buy '));
$strong = $description->appendChild($document->createElement('strong'));
$strong->appendChild($document->createTextNode('A'));
$strong->appendChild($document->createTextNode('B'));
$description->appendChild($document->createTextNode(' now'));
$description->normalize();
echo $document->saveXml($description), "\n";
echo 'Текст посетителю: ', $description->textContent, "\n";
echo 'Узлов внутри strong: ', $strong->childNodes->length, "\n";

<description>Buy <strong>AB</strong> now</description>
Текст посетителю: Buy AB now
Узлов внутри strong: 1

Первый appendChild элемента возвращает strong; следующие вызовы создают два его соседних Text. Normalize возвращает void —результат нужно читать в дереве, не присваивать обратно description. Внутри strong остался один Text AB; элементstrong и пробелы Buy/now сохранены. Число1 здесь измеряет конкретный эффект склейки, а вся XML-строка показывает неизменённую разметку.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order/>');
$order = $document->documentElement;
$item = $document->createElement('item');
$item->textContent = 'Book';
echo 'До вставки: ', $document->saveXml($order), "\n";
$added = $order->appendChild($item);
$added->setAttribute('sku', 'B1');
echo 'После вставки: ', $document->saveXml($order), "\n";

До вставки: <order/>
После вставки: <order><item sku="B1">Book</item></order>

CreateElement создал отдельный item; запись textContent добавила его текст Book. До appendChild заказ ещё пуст. Метод вызывается у order, получает объект item и возвращает этот же добавленный узел в added. Поэтому setAttribute через added присваивает sku=B1 товару внутри заказа. Изменение видно в полной XML-строке; второй товар от присваивания не появился.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<shop><pending><item>Book</item></pending><ready/></shop>');
$shop = $document->documentElement;
$pending = $shop->firstElementChild;
$ready = $pending->nextElementSibling;
$item = $pending->firstElementChild;
$ready->appendChild($item);
echo $document->saveXml($shop), "\n";
echo 'Теперь товар в: ', $item->parentNode->nodeName, "\n";

<shop><pending/><ready><item>Book</item></ready></shop>
Теперь товар в: ready

FirstElementChild берёт первого ребёнка-элемент, nextElementSibling —следующего соседа-элемент. Ready получает существующий item: appendChild переносит его, не копирует. Pending стал пустым, parentNode у item теперь ready. Если нужно сохранить товар в обоих списках, сначала создайте отдельную копию cloneNode(true).

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order><item>Book</item></order>');
$order = $document->documentElement;
$item = $order->firstChild;
$notice = $document->createElement('notice');
$notice->textContent = 'Check address';
$inserted = $order->insertBefore($notice, $item);
echo 'Вставлено: ', $inserted->textContent, "\n";
echo $document->saveXml($order), "\n";

Вставлено: Check address
<order><notice>Check address</notice><item>Book</item></order>

Item —объект существующего ребёнка, а не строка item. Первый аргумент notice задаёт новый узел, второй item —соседа справа от него. Return попадает в inserted, откуда читается текст добавленной заметки. В этом XML нет пробельных Text между тегами; если они есть, firstChild может оказаться текстом, и для элемента удобнее firstElementChild.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<queue><task>normal</task></queue>');
$queue = $document->documentElement;
$urgent = $document->createElement('task');
$urgent->textContent = 'urgent';
$queue->insertBefore($urgent, $queue->firstChild);
$last = $document->createElement('task');
$last->textContent = 'later';
$queue->insertBefore($last, null);
foreach ($queue->childNodes as $task) {
    echo $task->textContent, "
";
}

urgent
normal
later

null — осознанное отсутствие опорного узла. Чтобы вставить после найденного узла, можно передать его nextSibling; если он последний, это как раз null.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<product><price>100</price></product>');
$product = $document->documentElement;
$newPrice = $document->createElement('price');
$newPrice->textContent = '120';
$oldPrice = $product->replaceChild($newPrice, $product->firstChild);
echo 'Товар после правки: ', $document->saveXml($product), "\n";
echo 'Снятая версия: ', $document->saveXml($oldPrice), "\n";

Товар после правки: <product><price>120</price></product>
Снятая версия: <price>100</price>

Аргументы идут в порядке новый, старый. Но return —именно снятый старый price100, сохранённый в oldPrice. SaveXml может прочитать его и после отсоединения. Новая цена120 уже в product. Старый узел остался связан с ownerDocument, но больше не является ребёнком product; ниже этот возврат позволяет откатить локальную правку.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<product><price>100</price></product>');
$product = $document->documentElement;
$replacement = $document->createElement('price');
$replacement->textContent = '-20';
$old = $product->replaceChild($replacement, $product->firstChild);
if ((int) $replacement->textContent < 0) {
    $product->replaceChild($old, $replacement);
}
echo $product->textContent, "
";

100

Это откат только двух узлов в памяти, не транзакция базы данных и не общая отмена произвольного импорта. Практичнее проверять цену до мутации; пример показывает, какой объект возвращён и как его вернуть.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<shop><order><item>Book</item></order><archive/></shop>');
$shop = $document->documentElement;
$order = $shop->firstElementChild;
$archive = $order->nextElementSibling;
$removed = $order->removeChild($order->firstChild);
echo 'Удалённый товар: ', $removed->textContent, "\n";
echo 'После удаления: ', $document->saveXml($shop), "\n";
$archive->appendChild($removed);
echo 'После архивирования: ', $document->saveXml($shop), "\n";

Удалённый товар: Book
После удаления: <shop><order/><archive/></shop>
После архивирования: <shop><order/><archive><item>Book</item></archive></shop>

RemoveChild разорвал связь order→item и вернул живой объект в removed. Текст ещё доступен; второй вызов appendChild использует возвращённый узел в архиве того же документа. Удаление из дерева не уничтожило данные. Так различаются удалённая связь, оставшийся PHP-объект и новая связь archive→item.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<cart><item>A</item><item>B</item><item>C</item></cart>');
$cart = $document->documentElement;
$removedNames = [];
while ($cart->firstChild !== null) {
    $removed = $cart->removeChild($cart->firstChild);
    $removedNames[] = $removed->textContent;
}
echo 'Сняты позиции: ', implode(', ', $removedNames), "\n";
echo 'Корзина: ', $document->saveXml($cart), "\n";

Сняты позиции: A, B, C
Корзина: <cart/>

While каждый раз заново читает первого оставшегося ребёнка: сначалаA, затемB, затемC. Присваивание [] добавляет его название в массив; implode соединяет названия для журнала. После C firstChild равен null и цикл заканчивается. При увеличении индекса живой коллекции следующая позиция могла бы сдвинуться на уже пройденный индекс.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<item sku="A"><name>Book</name></item>');
$item = $document->documentElement;
$shallow = $item->cloneNode();
$deep = $item->cloneNode(true);
echo 'Без детей: ', $document->saveXml($shallow), "\n";
echo 'С детьми: ', $document->saveXml($deep), "\n";
echo 'Исходник: ', $document->saveXml($item), "\n";

Без детей: <item sku="A"/>
С детьми: <item sku="A"><name>Book</name></item>
Исходник: <item sku="A"><name>Book</name></item>

Без аргумента deep=false: атрибут sku скопирован, ребёнок name и его Text Book —нет. True копирует всё поддерево. Оба return —отдельные узлы без родителя; сохранение их строкой не вставляет копии в исходный документ. Чтобы создать второй товар в каталоге, нужно отдельно изменить id и вызвать appendChild, как ниже.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog><item id="A"><name>Book</name></item></catalog>');
$catalog = $document->documentElement;
$copy = $catalog->firstElementChild->cloneNode(true);
$copy->setAttribute('id', 'B');
$copy->firstElementChild->textContent = 'Notebook';
$catalog->appendChild($copy);
foreach ($catalog->childNodes as $item) {
    echo $item->getAttribute('id'), ':', $item->textContent, "
";
}

A:Book
B:Notebook

Здесь копия глубока относительно DOM-дерева. Это другой механизм, чем обычный PHP clone с вложенными пользовательскими объектами; правила свойств PHP-класса не подменяют правила DOM.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<label/>');
$label = $document->documentElement;
$label->appendChild($document->createTextNode('A'));
$label->appendChild($document->createTextNode('B'));
echo $label->childNodes->length, ':', $label->textContent, "
";
$label->normalize();
echo $label->childNodes->length, ':', $label->textContent, "
";

2:AB
1:AB

Один и тот же видимый текст может состоять из разного числа узлов. Нормализация убирает эту зависимость для соседних текстовых фрагментов.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<description/>');
$description = $document->documentElement;
$description->appendChild($document->createTextNode('Buy '));
$strong = $description->appendChild($document->createElement('strong'));
$strong->appendChild($document->createTextNode('A'));
$strong->appendChild($document->createTextNode('B'));
$description->appendChild($document->createTextNode(' now'));
$description->normalize();
echo $document->saveXml($description), "\n";
echo 'Текст посетителю: ', $description->textContent, "\n";
echo 'Узлов внутри strong: ', $strong->childNodes->length, "\n";

<description>Buy <strong>AB</strong> now</description>
Текст посетителю: Buy AB now
Узлов внутри strong: 1

Первый appendChild элемента возвращает strong; следующие вызовы создают два его соседних Text. Normalize возвращает void —результат нужно читать в дереве, не присваивать обратно description. Внутри strong остался один Text AB; элементstrong и пробелы Buy/now сохранены. Число1 здесь измеряет конкретный эффект склейки, а вся XML-строка показывает неизменённую разметку.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<name>Book</name>');
$name = $document->documentElement;
if ($name->hasChildNodes()) {
    echo 'Первый ребёнок: ', $name->firstChild->nodeName, "\n";
    echo 'Его текст: ', $name->firstChild->textContent, "\n";
}
if ($name->firstElementChild === null) {
    echo "Вложенного элемента нет\n";
}

Первый ребёнок: #text
Его текст: Book
Вложенного элемента нет

HasChildNodes возвращает true, поэтому if разрешает прочитать firstChild. Это Text с именем #text и содержимым Book. FirstElementChild пропускает текст и возвращает null: внутри name нет второго тега. Скобки () вызывают метод без аргументов; стрелка -> читает свойство конкретного объекта. Наличие ребёнка ещё не обещает вложенный элемент.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<notes><note/><note> </note><note>Call buyer</note></notes>');
foreach ($document->documentElement->childNodes as $note) {
    if (!$note->hasChildNodes()) {
        echo "Нет узлов: запросить заметку\n";
        continue;
    }
    $message = trim($note->textContent);
    echo $message === '' ? "Только пробелы: запросить заметку\n" : "Менеджеру: $message\n";
}

Нет узлов: запросить заметку
Только пробелы: запросить заметку
Менеджеру: Call buyer

Первый note сразу попадает в ветку отсутствия детей; continue переходит к следующему. У второго есть Text с пробелом, но trim даёт пустую строку. Третий даёт настоящее сообщение. Trim допустим здесь по правилу поля заметки; пробелы в произвольном XML нельзя объявить лишними для всех элементов.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<filter enabled=""/>');
$filter = $document->documentElement;
if ($filter->hasAttributes()) {
    echo 'Сохранён фильтр: ', $document->saveXML($filter), "\n";
}
echo 'Значение enabled: [', $filter->getAttribute('enabled'), "]\n";

Сохранён фильтр: <filter enabled=""/>
Значение enabled: []

HasAttributes нашёл хотя бы один атрибут и дал true для if. GetAttribute вернул пустую строку; квадратные скобки добавлены нами для видимости её границ. Существование enabled не объясняет, включён ли фильтр: формат настроек должен отдельно определить смысл пустого значения.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<filters><filter/><filter page="2"/><filter sort="price"/></filters>');
foreach ($document->documentElement->childNodes as $filter) {
    echo $filter->hasAttributes() ? 'Сохранённые настройки; ' : 'Настройки по умолчанию; ';
    $page = $filter->hasAttribute('page') ? $filter->getAttribute('page') : '1';
    echo 'страница ', $page, "\n";
}

Настройки по умолчанию; страница 1
Сохранённые настройки; страница 2
Сохранённые настройки; страница 1

Первый вызов отвечает о любых атрибутах. Второй спрашивает конкретно page: sort не задаёт страницу, поэтому используется 1. Здесь XML с известными значениями; номер из внешнего файла нужно дополнительно проверить как допустимое целое перед запросом к базе.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<item><price>100</price></item>');
$item = $document->documentElement;
foreach ([$item, $item->firstChild, null] as $candidate) {
    if ($item->contains($candidate)) {
        echo 'В области item: ', $candidate->nodeName, "\n";
    } else {
        echo "Кандидат отсутствует или вне области item\n";
    }
}

В области item: item
В области item: price
Кандидат отсутствует или вне области item

Массив содержит три разных аргумента: сам item, его price, затем null. Contains возвращает true, true, false. Поэтому первые две ветки читают имя объекта, а последняя не пытается читать свойство null. Contains включает сам контейнер; для строгого потомка нужно также исключить isSameNode.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<root><item><price>100</price></item><settings><price>999</price></settings></root>');
$item = $document->documentElement->firstElementChild;
foreach ($document->getElementsByTagName('price') as $price) {
    if ($item->contains($price)) {
        $price->textContent = '120';
    }
}
foreach ($document->getElementsByTagName('price') as $price) {
    echo $price->textContent, "
";
}

120
999

Имя price встречается в нескольких ветках. contains задаёт структурную границу; в реальном редакторе права доступа проверяются ещё до этой операции.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog/>');
$item = $document->createElement('item');
$item->textContent = 'Book';
$rootBefore = $item->getRootNode();
echo 'Корень заготовки: ', $rootBefore->nodeName, "\n";
echo 'Каталог до: ', $document->saveXml($document->documentElement), "\n";
$document->documentElement->appendChild($item);
$rootAfter = $item->getRootNode();
echo 'Корень после: ', $rootAfter->nodeName, "\n";
echo 'Каталог после: ', $document->saveXml($rootAfter->documentElement), "\n";

Корень заготовки: item
Каталог до: <catalog/>
Корень после: #document
Каталог после: <catalog><item>Book</item></catalog>

GetRootNode вернул объект в rootBefore: отдельный item, у которого нет родителя. После appendChild путь item→catalog→document закончился документом в rootAfter. Его documentElement снова даёт каталог для вывода. OwnerDocument у item всё это время был document; создавший документ и текущий корень — разные связи.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog><item><name>Book</name></item></catalog>');
$catalog = $document->documentElement;
$item = $catalog->removeChild($catalog->firstChild);
$name = $item->firstChild;
if (!$name->getRootNode()->isSameNode($document)) {
    echo 'Ещё не в каталоге: ', $name->textContent, "\n";
    $name->textContent = 'Notebook';
    $catalog->appendChild($item);
}
echo $document->saveXml($catalog), "\n";

Ещё не в каталоге: Book
<catalog><item><name>Notebook</name></item></catalog>

После removeChild корень name — item. Цепочка getRootNode()->isSameNode сначала получает этот корень, затем сравнивает его с document; ! обращает false в true. Правим отсоединённую ветку и вставляем целиком. Это изменение дерева в памяти, не публикация и не запись на диск.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog><item>Book</item></catalog>');
$first = $document->documentElement->firstChild;
$found = $document->getElementsByTagName('item')->item(0);
if ($first->isSameNode($found)) {
    $found->textContent = 'Notebook';
}
echo 'Через first: ', $first->textContent, "\n";
$copy = $first->cloneNode(true);
if (!$first->isSameNode($copy)) {
    $copy->textContent = 'Copy';
}
echo 'Копия: ', $copy->textContent, "\n";
echo 'Оригинал: ', $first->textContent, "\n";

Через first: Notebook
Копия: Copy
Оригинал: Notebook

Item(0) берёт первый объект списка поиска, индексы начинаются с нуля. First и found указывают на один item: правка через found видна через first. CloneNode(true) возвращает другой узел с теми же начальными данными. Его отдельная правка не изменила оригинал. Метод сравнивает идентичность узла, не его имя или текст.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<group><item>A</item></group>');
$group = $document->documentElement;
$candidates = [$group, $group->firstChild];
foreach ($candidates as $candidate) {
    if ($group->contains($candidate) && !$group->isSameNode($candidate)) {
        echo $candidate->nodeName, "
";
    }
}

item

contains включает сам group. Отрицание ! перед isSameNode исключает только контейнер, а не похожие элементы.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<item sku="A">Book</item>');
$item = $document->documentElement;
$copy = $item->cloneNode(true);
if ($item->isEqualNode($copy)) {
    echo 'Одинаковое содержимое: ', $document->saveXml($copy), "\n";
}
$copy->textContent = 'Notebook';
if (!$item->isEqualNode($copy)) {
    echo 'Было: ', $document->saveXml($item), "\n";
    echo 'Стало: ', $document->saveXml($copy), "\n";
}

Одинаковое содержимое: <item sku="A">Book</item>
Было: <item sku="A">Book</item>
Стало: <item sku="A">Notebook</item>

Первый true означает равенство структуры и значений, хотя cloneNode создал отдельный объект. После textContent=Notebook результат false позволяет показать различие. IsEqualNode не приводит Book и Notebook к общему виду и не игнорирует пробелы по бизнес-правилам.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<settings><currency code="RUB"/></settings>');
$settings = $document->documentElement;
foreach (['RUB', 'EUR'] as $code) {
    $current = $settings->firstChild;
    $candidate = $document->createElement('currency');
    $candidate->setAttribute('code', $code);
    if ($current->isEqualNode($candidate)) {
        echo 'Без изменения: ', $code, "\n";
        continue;
    }
    $settings->replaceChild($candidate, $current);
    echo 'Сохранена настройка: ', $document->saveXml($settings), "\n";
}

Без изменения: RUB
Сохранена настройка: <settings><currency code="EUR"/></settings>

В первой итерации кандидат RUB совпадает с текущим узлом; continue пропускает замену. Во второй отличается атрибут code, поэтому replaceChild меняет дерево. Обе ветки видны в одном запуске. Для большого документа сравнение поддеревьев может быть дороже проверки нескольких значимых полей; сначала определите требуемое правило равенства.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<queue><task>A</task><task>B</task></queue>');
$queue = $document->documentElement;
$first = $queue->firstChild;
$last = $queue->lastChild;
$position = $queue->compareDocumentPosition($first);
echo 'Маска queue к A: ', $position, "\n";
if (($position & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) !== 0) {
    echo 'Внутри queue: ', $first->textContent, "\n";
}
if (($last->compareDocumentPosition($first) & DOMNode::DOCUMENT_POSITION_PRECEDING) !== 0) {
    echo 'Раньше B выполнить: ', $first->textContent, "\n";
}

Маска queue к A: 20
Внутри queue: A
Раньше B выполнить: A

CompareDocumentPosition у queue получает first=A. Число20 складывает флаги4 и16: другой узел следует за контейнером и вложен в него. Побитовое & оставляет интересующий бит; !==0 проверяет его наличие. Во втором вызове точка отсчёта B, другой узел A; PRECEDING означает «A раньше B». Это порядок дерева, не часы выполнения задания.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<queue><task>A</task><task>B</task></queue>');
$first = $document->documentElement->firstChild;
$last = $document->documentElement->lastChild;
$draft = $document->createElement('task');
$draft->textContent = 'C';
foreach ([$last, $draft] as $other) {
    $position = $first->compareDocumentPosition($other);
    if (($position & DOMNode::DOCUMENT_POSITION_DISCONNECTED) !== 0) {
        echo 'Вне очереди, нужен приоритет: ', $other->textContent, "\n";
    } elseif (($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) !== 0) {
        echo 'Порядок очереди: ', $first->textContent, ' -> ', $other->textContent, "\n";
    }
}

Порядок очереди: A -> B
Вне очереди, нужен приоритет: C

Сначала проверяется DISCONNECTED: заготовка C ещё не вставлена и не имеет переносимого места относительно A. Для B деревья общие, FOLLOWING позволяет вывести A→B. Сравнивать всю маску с4 неправильно: вместе с порядком может присутствовать флаг вложенности. Бизнес-приоритет несвязанных задач задают отдельными данными.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog>
<item>Book</item>
</catalog>');
$item = $document->getElementsByTagName('item')->item(0);
echo $item->getLineNo(), "
";
echo $document->createElement('item')->getLineNo(), "
";

2
0

Ноль у новой заготовки означает отсутствие исходной строки; это не нулевая строка XML-файла.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog>
<item price="100"/>
<item/>
</catalog>');
foreach ($document->getElementsByTagName('item') as $item) {
    if (!$item->hasAttribute('price')) {
        echo 'Missing price at line ', $item->getLineNo(), "
";
    }
}

Missing price at line 3

hasAttribute здесь проверяет только наличие. Следующий этап импорта обязан проверить формат и диапазон цены.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog><item>A</item><item>B</item></catalog>');
echo $document->documentElement->lastChild->getNodePath(), "
";

/catalog/item[2]

Квадратные скобки здесь относятся к XPath и нумеруются с 1, в отличие от индексов NodeList с 0.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog><item>A</item><item>B</item></catalog>');
$item = $document->documentElement->lastChild;
$path = $item->getNodePath();
$query = new DOMXPath($document);
$found = $query->query($path)->item(0);
echo 'По пути ', $path, ': ', $found->textContent, "\n";
$document->documentElement->removeChild($document->documentElement->firstChild);
echo 'Тот же товар ', $item->textContent, ' теперь: ', $item->getNodePath(), "\n";

По пути /catalog/item[2]: B
Тот же товар B теперь: /catalog/item

GetNodePath возвращает строку, присвоенную path. XPath —объект для запросов по структуре; query(path) возвращает список, item(0) берёт его первый результат. Здесь путь получен из того же неизменённого документа, поэтому B найден. Удаление A меняет координату B; старый путь не является устойчивым ID. Для произвольного запроса отдельно обрабатывайте ошибку query и пустой результат.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog xmlns="urn:catalog" xmlns:p="urn:prices"/>');
$root = $document->documentElement;
echo 'Префикс p означает: ', $root->lookupNamespaceURI('p'), "\n";
echo 'Без префикса: ', $root->lookupNamespaceURI(null), "\n";
$uri = $root->lookupNamespaceURI('unknown');
if ($uri === null) {
    echo "unknown не объявлен: запросить описание формата\n";
}

Префикс p означает: urn:prices
Без префикса: urn:catalog
unknown не объявлен: запросить описание формата

Строка p без двоеточия —аргумент поиска. Return urn:prices попадает прямо в echo. Аргумент null спрашивает default namespace; результат null у unknown означает отсутствие привязки. URI здесь служит именем формата, сетевого запроса не происходит.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<root xmlns:p="urn:prices"><item xmlns:p="urn:promo"><p:value>10</p:value></item></root>');
$root = $document->documentElement;
$item = $root->firstElementChild;
$value = $item->firstElementChild;
echo 'p у root: ', $root->lookupNamespaceURI('p'), "\n";
echo 'p у item: ', $item->lookupNamespaceURI('p'), "\n";
if ($value->namespaceURI === 'urn:promo' && $value->localName === 'value') {
    echo 'Акционная величина: ', $value->textContent, "\n";
}

p у root: urn:prices
p у item: urn:promo
Акционная величина: 10

Item переобъявил p. Lookup показывает разные URI в двух контекстах; фактический элемент проверяется по паре namespaceURI и localName, поэтому10 не будет принято за обычную цену только по буквам p:value. Для бизнес-смысла суммы ещё нужны правила валюты и допустимого диапазона.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<root xmlns:p="urn:prices"/>');
$root = $document->documentElement;
foreach (['urn:prices', 'urn:missing'] as $uri) {
    $prefix = $root->lookupPrefix($uri);
    $label = $prefix === null ? '{' . $uri . '}value' : $prefix . ':value';
    echo 'Поле отчёта: ', $label, "\n";
}

Поле отчёта: p:value
Поле отчёта: {urn:missing}value

LookupPrefix получил полный URI и вернул p либо null. Условие выбирает подпись: привычное p:value или явно показанный URI в фигурных скобках. Эти скобки —наша текстовая нотация отчёта, не создаваемый XML-тег и не XPath. Метод не создаёт нового префикса для отсутствующего пространства.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog xmlns="urn:catalog"><item>Book</item></catalog>');
$item = $document->documentElement->firstElementChild;
$prefix = $item->lookupPrefix('urn:catalog');
if ($prefix === null) {
    echo "Именованного префикса нет\n";
}
echo 'Полное имя: {', $item->namespaceURI, '}', $item->localName, "\n";
echo 'Данные: ', $item->textContent, "\n";

Именованного префикса нет
Полное имя: {urn:catalog}item
Данные: Book

Null не доказывает, что item не принадлежит пространству: здесь действует default namespace. NamespaceURI и localName дают полное смысловое имя, а textContent —данные Book. Для XPath-запроса к этим элементам всё равно регистрируют собственный префикс, даже если исходный XML написал теги без него.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog xmlns="urn:catalog"><item>Book</item></catalog>');
$item = $document->documentElement->firstElementChild;
foreach (['urn:catalog', 'urn:other'] as $expected) {
    if ($item->isDefaultNamespace($expected)) {
        echo 'Подходит формат ', $expected, ': ', $item->textContent, "\n";
    } else {
        echo 'Не применять правила ', $expected, "\n";
    }
}

Подходит формат urn:catalog: Book
Не применять правила urn:other

IsDefaultNamespace сравнивает URI аргумента с текущей привязкой по умолчанию. True разрешает показать Book в ожидаемом формате; false отклоняет чужое правило. Проверка относится к default namespace, а не ко всем именам с префиксами. URI сравнивается как строка, без обращения к сети.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<catalog xmlns="urn:catalog"><item sku="A">Book</item></catalog>');
$item = $document->documentElement->firstElementChild;
if ($item->isDefaultNamespace('urn:catalog')) {
    $sku = $item->getAttributeNS(null, 'sku');
    echo 'Товар ', $sku, ': ', $item->textContent, "\n";
}
if (!$item->hasAttributeNS('urn:catalog', 'sku')) {
    echo "Атрибута sku в urn:catalog нет\n";
}

Товар A: Book
Атрибута sku в urn:catalog нет

Default namespace относится к непредварённому префиксом элементу item, но не к атрибуту sku. Поэтому getAttributeNS получает null и возвращает A. HasAttributeNS с URI каталога показывает, почему такой ошибочный поиск ничего не найдёт. Legacy getAttributeNS при отсутствии даёт пустую строку, современный —null; hasAttributeNS отличает отсутствие от существующего пустого значения.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<root/>');
$node = $document->documentElement;
foreach (['XML', 'ImaginaryFeature'] as $feature) {
    if ($node->isSupported($feature, '1.0')) {
        echo 'Старый DOM заявляет: ', $feature, ' 1.0', "\n";
    } else {
        echo 'Обещания поддержки нет: ', $feature, "\n";
    }
}

Старый DOM заявляет: XML 1.0
Обещания поддержки нет: ImaginaryFeature

Feature и version —два аргумента старой таблицы возможностей. True для XML1.0 не является результатом проверки нашего XML-документа; false для выдуманного имени не означает поломку PHP. Для современного кода ниже проверяется наличие конкретного метода, который затем действительно используется.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<queue><task>A</task><task>B</task></queue>');
$first = $document->documentElement->firstChild;
$last = $document->documentElement->lastChild;
if (method_exists($first, 'compareDocumentPosition')) {
    $position = $first->compareDocumentPosition($last);
    if (($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) !== 0) {
        echo 'Очередь: ', $first->textContent, ' -> ', $last->textContent, "\n";
    }
} else {
    echo "Нужен PHP 8.4+ для проверки позиции\n";
}

Очередь: A -> B

MethodExists спрашивает о конкретном API объекта. Только после true вызывается compareDocumentPosition; результат FOLLOWING используется для вывода реальных задач. На старом runtime исполнится понятный отказ. Это пример сопровождения совместимости; минимальную версию библиотеки также нужно зафиксировать в Composer, а не заменять множеством случайных проверок.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<name>Book</name>');
$name = $document->documentElement;
if ($name->hasChildNodes()) {
    echo 'Первый ребёнок: ', $name->firstChild->nodeName, "\n";
    echo 'Его текст: ', $name->firstChild->textContent, "\n";
}
if ($name->firstElementChild === null) {
    echo "Вложенного элемента нет\n";
}

Первый ребёнок: #text
Его текст: Book
Вложенного элемента нет

HasChildNodes возвращает true, поэтому if разрешает прочитать firstChild. Это Text с именем #text и содержимым Book. FirstElementChild пропускает текст и возвращает null: внутри name нет второго тега. Скобки () вызывают метод без аргументов; стрелка -> читает свойство конкретного объекта. Наличие ребёнка ещё не обещает вложенный элемент.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<notes><note/><note> </note><note>Call buyer</note></notes>');
foreach ($document->documentElement->childNodes as $note) {
    if (!$note->hasChildNodes()) {
        echo "Нет узлов: запросить заметку\n";
        continue;
    }
    $message = trim($note->textContent);
    echo $message === '' ? "Только пробелы: запросить заметку\n" : "Менеджеру: $message\n";
}

Нет узлов: запросить заметку
Только пробелы: запросить заметку
Менеджеру: Call buyer

Первый note сразу попадает в ветку отсутствия детей; continue переходит к следующему. У второго есть Text с пробелом, но trim даёт пустую строку. Третий даёт настоящее сообщение. Trim допустим здесь по правилу поля заметки; пробелы в произвольном XML нельзя объявить лишними для всех элементов.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<item><price>100</price></item>');
$item = $document->documentElement;
foreach ([$item, $item->firstChild, null] as $candidate) {
    if ($item->contains($candidate)) {
        echo 'В области item: ', $candidate->nodeName, "\n";
    } else {
        echo "Кандидат отсутствует или вне области item\n";
    }
}

В области item: item
В области item: price
Кандидат отсутствует или вне области item

Массив содержит три разных аргумента: сам item, его price, затем null. Contains возвращает true, true, false. Поэтому первые две ветки читают имя объекта, а последняя не пытается читать свойство null. Contains включает сам контейнер; для строгого потомка нужно также исключить isSameNode.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<root><item><price>100</price></item><settings><price>999</price></settings></root>');
$item = $document->documentElement->firstElementChild;
foreach ($document->getElementsByTagName('price') as $price) {
    if ($item->contains($price)) {
        $price->textContent = '120';
    }
}
foreach ($document->getElementsByTagName('price') as $price) {
    echo $price->textContent, "
";
}

120
999

Имя price встречается в нескольких ветках. contains задаёт структурную границу; в реальном редакторе права доступа проверяются ещё до этой операции.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog/>');
$item = $document->createElement('item');
$item->textContent = 'Book';
$rootBefore = $item->getRootNode();
echo 'Корень заготовки: ', $rootBefore->nodeName, "\n";
echo 'Каталог до: ', $document->saveXml($document->documentElement), "\n";
$document->documentElement->appendChild($item);
$rootAfter = $item->getRootNode();
echo 'Корень после: ', $rootAfter->nodeName, "\n";
echo 'Каталог после: ', $document->saveXml($rootAfter->documentElement), "\n";

Корень заготовки: item
Каталог до: <catalog/>
Корень после: #document
Каталог после: <catalog><item>Book</item></catalog>

GetRootNode вернул объект в rootBefore: отдельный item, у которого нет родителя. После appendChild путь item→catalog→document закончился документом в rootAfter. Его documentElement снова даёт каталог для вывода. OwnerDocument у item всё это время был document; создавший документ и текущий корень — разные связи.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog><item><name>Book</name></item></catalog>');
$catalog = $document->documentElement;
$item = $catalog->removeChild($catalog->firstChild);
$name = $item->firstChild;
if (!$name->getRootNode()->isSameNode($document)) {
    echo 'Ещё не в каталоге: ', $name->textContent, "\n";
    $name->textContent = 'Notebook';
    $catalog->appendChild($item);
}
echo $document->saveXml($catalog), "\n";

Ещё не в каталоге: Book
<catalog><item><name>Notebook</name></item></catalog>

После removeChild корень name — item. Цепочка getRootNode()->isSameNode сначала получает этот корень, затем сравнивает его с document; ! обращает false в true. Правим отсоединённую ветку и вставляем целиком. Это изменение дерева в памяти, не публикация и не запись на диск.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog><item>Book</item></catalog>');
$first = $document->documentElement->firstChild;
$found = $document->getElementsByTagName('item')->item(0);
if ($first->isSameNode($found)) {
    $found->textContent = 'Notebook';
}
echo 'Через first: ', $first->textContent, "\n";
$copy = $first->cloneNode(true);
if (!$first->isSameNode($copy)) {
    $copy->textContent = 'Copy';
}
echo 'Копия: ', $copy->textContent, "\n";
echo 'Оригинал: ', $first->textContent, "\n";

Через first: Notebook
Копия: Copy
Оригинал: Notebook

Item(0) берёт первый объект списка поиска, индексы начинаются с нуля. First и found указывают на один item: правка через found видна через first. CloneNode(true) возвращает другой узел с теми же начальными данными. Его отдельная правка не изменила оригинал. Метод сравнивает идентичность узла, не его имя или текст.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<group><item>A</item></group>');
$group = $document->documentElement;
$candidates = [$group, $group->firstChild];
foreach ($candidates as $candidate) {
    if ($group->contains($candidate) && !$group->isSameNode($candidate)) {
        echo $candidate->nodeName, "
";
    }
}

item

contains включает сам group. Отрицание ! перед isSameNode исключает только контейнер, а не похожие элементы.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<item sku="A">Book</item>');
$item = $document->documentElement;
$copy = $item->cloneNode(true);
if ($item->isEqualNode($copy)) {
    echo 'Одинаковое содержимое: ', $document->saveXml($copy), "\n";
}
$copy->textContent = 'Notebook';
if (!$item->isEqualNode($copy)) {
    echo 'Было: ', $document->saveXml($item), "\n";
    echo 'Стало: ', $document->saveXml($copy), "\n";
}

Одинаковое содержимое: <item sku="A">Book</item>
Было: <item sku="A">Book</item>
Стало: <item sku="A">Notebook</item>

Первый true означает равенство структуры и значений, хотя cloneNode создал отдельный объект. После textContent=Notebook результат false позволяет показать различие. IsEqualNode не приводит Book и Notebook к общему виду и не игнорирует пробелы по бизнес-правилам.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<settings><currency code="RUB"/></settings>');
$settings = $document->documentElement;
foreach (['RUB', 'EUR'] as $code) {
    $current = $settings->firstChild;
    $candidate = $document->createElement('currency');
    $candidate->setAttribute('code', $code);
    if ($current->isEqualNode($candidate)) {
        echo 'Без изменения: ', $code, "\n";
        continue;
    }
    $settings->replaceChild($candidate, $current);
    echo 'Сохранена настройка: ', $document->saveXml($settings), "\n";
}

Без изменения: RUB
Сохранена настройка: <settings><currency code="EUR"/></settings>

В первой итерации кандидат RUB совпадает с текущим узлом; continue пропускает замену. Во второй отличается атрибут code, поэтому replaceChild меняет дерево. Обе ветки видны в одном запуске. Для большого документа сравнение поддеревьев может быть дороже проверки нескольких значимых полей; сначала определите требуемое правило равенства.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<queue><task>A</task><task>B</task></queue>');
$queue = $document->documentElement;
$first = $queue->firstChild;
$last = $queue->lastChild;
$position = $queue->compareDocumentPosition($first);
echo 'Маска queue к A: ', $position, "\n";
if (($position & Dom\Node::DOCUMENT_POSITION_CONTAINED_BY) !== 0) {
    echo 'Внутри queue: ', $first->textContent, "\n";
}
if (($last->compareDocumentPosition($first) & Dom\Node::DOCUMENT_POSITION_PRECEDING) !== 0) {
    echo 'Раньше B выполнить: ', $first->textContent, "\n";
}

Маска queue к A: 20
Внутри queue: A
Раньше B выполнить: A

CompareDocumentPosition у queue получает first=A. Число20 складывает флаги4 и16: другой узел следует за контейнером и вложен в него. Побитовое & оставляет интересующий бит; !==0 проверяет его наличие. Во втором вызове точка отсчёта B, другой узел A; PRECEDING означает «A раньше B». Это порядок дерева, не часы выполнения задания.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<queue><task>A</task><task>B</task></queue>');
$first = $document->documentElement->firstChild;
$last = $document->documentElement->lastChild;
$draft = $document->createElement('task');
$draft->textContent = 'C';
foreach ([$last, $draft] as $other) {
    $position = $first->compareDocumentPosition($other);
    if (($position & Dom\Node::DOCUMENT_POSITION_DISCONNECTED) !== 0) {
        echo 'Вне очереди, нужен приоритет: ', $other->textContent, "\n";
    } elseif (($position & Dom\Node::DOCUMENT_POSITION_FOLLOWING) !== 0) {
        echo 'Порядок очереди: ', $first->textContent, ' -> ', $other->textContent, "\n";
    }
}

Порядок очереди: A -> B
Вне очереди, нужен приоритет: C

Сначала проверяется DISCONNECTED: заготовка C ещё не вставлена и не имеет переносимого места относительно A. Для B деревья общие, FOLLOWING позволяет вывести A→B. Сравнивать всю маску с4 неправильно: вместе с порядком может присутствовать флаг вложенности. Бизнес-приоритет несвязанных задач задают отдельными данными.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog>
<item>Book</item>
</catalog>');
$item = $document->getElementsByTagName('item')->item(0);
echo $item->getLineNo(), "
";
echo $document->createElement('item')->getLineNo(), "
";

2
0

Ноль у новой заготовки означает отсутствие исходной строки; это не нулевая строка XML-файла.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog>
<item price="100"/>
<item/>
</catalog>');
foreach ($document->getElementsByTagName('item') as $item) {
    if (!$item->hasAttribute('price')) {
        echo 'Missing price at line ', $item->getLineNo(), "
";
    }
}

Missing price at line 3

hasAttribute здесь проверяет только наличие. Следующий этап импорта обязан проверить формат и диапазон цены.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog><item>A</item><item>B</item></catalog>');
echo $document->documentElement->lastChild->getNodePath(), "
";

/catalog/item[2]

Квадратные скобки здесь относятся к XPath и нумеруются с 1, в отличие от индексов NodeList с 0.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog><item>A</item><item>B</item></catalog>');
$item = $document->documentElement->lastChild;
$path = $item->getNodePath();
$query = new Dom\XPath($document);
$found = $query->query($path)->item(0);
echo 'По пути ', $path, ': ', $found->textContent, "\n";
$document->documentElement->removeChild($document->documentElement->firstChild);
echo 'Тот же товар ', $item->textContent, ' теперь: ', $item->getNodePath(), "\n";

По пути /catalog/item[2]: B
Тот же товар B теперь: /catalog/item

GetNodePath возвращает строку, присвоенную path. XPath —объект для запросов по структуре; query(path) возвращает список, item(0) берёт его первый результат. Здесь путь получен из того же неизменённого документа, поэтому B найден. Удаление A меняет координату B; старый путь не является устойчивым ID. Для произвольного запроса отдельно обрабатывайте ошибку query и пустой результат.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog xmlns="urn:catalog" xmlns:p="urn:prices"/>');
$root = $document->documentElement;
echo 'Префикс p означает: ', $root->lookupNamespaceURI('p'), "\n";
echo 'Без префикса: ', $root->lookupNamespaceURI(null), "\n";
$uri = $root->lookupNamespaceURI('unknown');
if ($uri === null) {
    echo "unknown не объявлен: запросить описание формата\n";
}

Префикс p означает: urn:prices
Без префикса: urn:catalog
unknown не объявлен: запросить описание формата

Строка p без двоеточия —аргумент поиска. Return urn:prices попадает прямо в echo. Аргумент null спрашивает default namespace; результат null у unknown означает отсутствие привязки. URI здесь служит именем формата, сетевого запроса не происходит.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<root xmlns:p="urn:prices"><item xmlns:p="urn:promo"><p:value>10</p:value></item></root>');
$root = $document->documentElement;
$item = $root->firstElementChild;
$value = $item->firstElementChild;
echo 'p у root: ', $root->lookupNamespaceURI('p'), "\n";
echo 'p у item: ', $item->lookupNamespaceURI('p'), "\n";
if ($value->namespaceURI === 'urn:promo' && $value->localName === 'value') {
    echo 'Акционная величина: ', $value->textContent, "\n";
}

p у root: urn:prices
p у item: urn:promo
Акционная величина: 10

Item переобъявил p. Lookup показывает разные URI в двух контекстах; фактический элемент проверяется по паре namespaceURI и localName, поэтому10 не будет принято за обычную цену только по буквам p:value. Для бизнес-смысла суммы ещё нужны правила валюты и допустимого диапазона.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<root xmlns:p="urn:prices"/>');
$root = $document->documentElement;
foreach (['urn:prices', 'urn:missing'] as $uri) {
    $prefix = $root->lookupPrefix($uri);
    $label = $prefix === null ? '{' . $uri . '}value' : $prefix . ':value';
    echo 'Поле отчёта: ', $label, "\n";
}

Поле отчёта: p:value
Поле отчёта: {urn:missing}value

LookupPrefix получил полный URI и вернул p либо null. Условие выбирает подпись: привычное p:value или явно показанный URI в фигурных скобках. Эти скобки —наша текстовая нотация отчёта, не создаваемый XML-тег и не XPath. Метод не создаёт нового префикса для отсутствующего пространства.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog xmlns="urn:catalog"><item>Book</item></catalog>');
$item = $document->documentElement->firstElementChild;
$prefix = $item->lookupPrefix('urn:catalog');
if ($prefix === null) {
    echo "Именованного префикса нет\n";
}
echo 'Полное имя: {', $item->namespaceURI, '}', $item->localName, "\n";
echo 'Данные: ', $item->textContent, "\n";

Именованного префикса нет
Полное имя: {urn:catalog}item
Данные: Book

Null не доказывает, что item не принадлежит пространству: здесь действует default namespace. NamespaceURI и localName дают полное смысловое имя, а textContent —данные Book. Для XPath-запроса к этим элементам всё равно регистрируют собственный префикс, даже если исходный XML написал теги без него.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog xmlns="urn:catalog"><item>Book</item></catalog>');
$item = $document->documentElement->firstElementChild;
foreach (['urn:catalog', 'urn:other'] as $expected) {
    if ($item->isDefaultNamespace($expected)) {
        echo 'Подходит формат ', $expected, ': ', $item->textContent, "\n";
    } else {
        echo 'Не применять правила ', $expected, "\n";
    }
}

Подходит формат urn:catalog: Book
Не применять правила urn:other

IsDefaultNamespace сравнивает URI аргумента с текущей привязкой по умолчанию. True разрешает показать Book в ожидаемом формате; false отклоняет чужое правило. Проверка относится к default namespace, а не ко всем именам с префиксами. URI сравнивается как строка, без обращения к сети.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<catalog xmlns="urn:catalog"><item sku="A">Book</item></catalog>');
$item = $document->documentElement->firstElementChild;
if ($item->isDefaultNamespace('urn:catalog')) {
    $sku = $item->getAttributeNS(null, 'sku');
    echo 'Товар ', $sku, ': ', $item->textContent, "\n";
}
if (!$item->hasAttributeNS('urn:catalog', 'sku')) {
    echo "Атрибута sku в urn:catalog нет\n";
}

Товар A: Book
Атрибута sku в urn:catalog нет

Default namespace относится к непредварённому префиксом элементу item, но не к атрибуту sku. Поэтому getAttributeNS получает null и возвращает A. HasAttributeNS с URI каталога показывает, почему такой ошибочный поиск ничего не найдёт. Legacy getAttributeNS при отсутствии даёт пустую строку, современный —null; hasAttributeNS отличает отсутствие от существующего пустого значения.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<item z="2" a="1"/>');
$canonical = $document->C14N();
if ($canonical === false) {
    throw new RuntimeException('Canonicalization failed');
}
echo $canonical, "
";

<item a="1" z="2"></item>

Строгое === false отделяет ошибку от допустимой строки. XML-декларация здесь не включается в канонический результат.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order><!-- internal note --><item>A</item></order>');
$without = $document->C14N(false, false);
$with = $document->C14N(false, true);
echo $without, "
";
echo $with, "
";

<order><item>A</item></order>
<order><!-- internal note --><item>A</item></order>

Одинаковая бизнес-запись даёт разные байты при другой политике комментариев. На стороне получателя нельзя угадывать параметры подписи.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<item><name>Book</name><internal>supplier note</internal></item>');
$publicXml = $document->C14N(false, false, [
    'query' => '//name | //name/text()',
]);
echo $publicXml, "
";

<name>Book</name>

XPath включает и сам name, и его текст. Если выбрать только элемент без его текстового узла, результат не обязан содержать Book. Для экспорта сложного публичного формата яснее построить новый документ с разрешёнными полями.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order id="A"><item>Book</item></order>');
$filters = [
    'Нет query' => [],
    'Число вместо запроса' => ['query' => 42],
    'Число вместо узлов' => ['query' => 'count(//order)'],
];
foreach ($filters as $label => $filter) {
    try {
        $document->C14N(false, false, $filter);
    } catch (Throwable $error) {
        echo $label, ': ', get_class($error), "; экспорт отменён\n";
    }
}
$canonical = $document->C14N(false, false, [
    'query' => '//order | //order/@* | //order//node()',
]);
if ($canonical === false) {
    throw new RuntimeException('Canonicalization failed');
}
echo 'После исправления: ', $canonical, "\n";

Нет query: ValueError; экспорт отменён
Число вместо запроса: TypeError; экспорт отменён
Число вместо узлов: Error; экспорт отменён
После исправления: <order id="A"><item>Book</item></order>

Три неправильные конфигурации обрабатываются отдельно: query обязателен, он должен быть строкой, а его результатом должен быть набор узлов. Исправленный XPath объединяет через | элемент order, его атрибуты @* и всех вложенных узлов //node(), включая Text Book. Return сохраняется в canonical, проверяется на false и только потом выводится. Этот выбор не содержит пространств имён; для них ниже явно включены namespace-узлы.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<root xmlns:p="urn:prices" xmlns:q="urn:metadata"><p:price currency="RUB">100</p:price></root>');
$price = $document->documentElement->firstElementChild;
echo 'Inclusive: ', $price->C14N(false), "\n";
echo 'Exclusive: ', $price->C14N(true), "\n";
echo 'Exclusive с q: ', $price->C14N(true, false, null, ['q']), "\n";

Inclusive: <p:price xmlns:p="urn:prices" xmlns:q="urn:metadata" currency="RUB">100</p:price>
Exclusive: <p:price xmlns:p="urn:prices" currency="RUB">100</p:price>
Exclusive с q: <p:price xmlns:p="urn:prices" xmlns:q="urn:metadata" currency="RUB">100</p:price>

Price присоединён к документу и наследует объявления p и q. False сохраняет оба объявления по правилам inclusive. True оставляет видимый p, нужный имени элемента; q в имени не используется. Четвёртый аргумент [q] просит сохранить q и при exclusive. Это массив префиксов, а не URI. Третий null означает отсутствие XPath-фильтра. В рабочем протоколе режим задаётся заранее: выбирать его по понравившемуся выводу нельзя.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<root xmlns:p="urn:prices"><p:price currency="RUB">100</p:price><secret>internal</secret></root>');
$public = $document->C14N(true, false, [
    'query' => '//v:price | //v:price/@* | //v:price/text() | //v:price/namespace::*',
    'namespaces' => ['v' => 'urn:prices'],
]);
if ($public === false || $public === '') {
    throw new RuntimeException('Expected public price is absent');
}
echo $public, "\n";

<p:price xmlns:p="urn:prices" currency="RUB">100</p:price>

Массив имеет два ключа: query и namespaces. Собственный XPath-префикс v связан с тем же URI, что исходный p; менять XML-префикс не требуется. Части запроса выбирают элемент, атрибут currency, Text100 и объявления пространства. Return становится строкой public, в которой нет secret. Такая выборка не заменяет проектирование разрешённой схемы экспорта или протокол XML Signature.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order id="A"/>');
$bytes = $document->C14NFile('canonical.xml');
if ($bytes === false) {
    throw new RuntimeException('Write failed');
}
$saved = file_get_contents('canonical.xml');
if ($saved === false) {
    throw new RuntimeException('Read failed');
}
echo 'canonical.xml: ', $saved, "\n";
echo 'Записано байтов: ', $bytes, "\n";
echo 'Прочитано байтов: ', strlen($saved), "\n";

canonical.xml: <order id="A"></order>
Записано байтов: 22
Прочитано байтов: 22

Первый аргумент —имя создаваемого файла относительно рабочей папки запуска. C14NFile возвращает число записанных байтов22 в bytes, а не XML-строку. FileGetContents читает строку отдельно; strlen здесь также измеряет байты. При false выполнение прерывается. Запускайте пример в отдельной учебной папке: существующий canonical.xml по этому пути будет перезаписан.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<report><!-- build note --><total>2</total></report>');
$expected = $document->C14N(false, false);
$bytes = $document->C14NFile('report.xml', false, false);
if ($expected === false || $bytes === false) {
    throw new RuntimeException('Export failed');
}
$saved = file_get_contents('report.xml');
if ($saved === false || $saved !== $expected) {
    throw new RuntimeException('Export does not match agreed XML');
}
echo 'report.xml: ', $saved, "\n";
echo 'Готовый объём: ', $bytes, " байт\n";

report.xml: <report><total>2</total></report>
Готовый объём: 33 байт

После uri идут два bool: exclusive=false, withComments=false. Оба вызова используют одинаковую политику; прочитанный файл сравнивается с ожидаемой строкой, затем показывается целиком. Видно, что total2 сохранён, build note отсутствует. Это небольшой учебный экспорт: для больших документов не держите второй полный результат только ради такого сравнения; для важной замены используйте временный файл и обработку ошибок файловой системы.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order id="A"/>');
$order = $document->documentElement;
try {
    $payload = serialize($order);
} catch (Throwable $error) {
    echo 'DOM-объект не сохранён: ', get_class($error), "\n";
    $payload = $document->saveXML($order);
}
if ($payload === false) {
    throw new RuntimeException('XML export failed');
}
echo 'Переносимые данные: ', $payload, "\n";

DOM-объект не сохранён: Exception
Переносимые данные: <order id="A"/>

Serialize пытается сохранить PHP-объект и запускает запрет сериализации DOM. В catch получаем другой формат —XML-строку. После обработки payload содержит данные заказа, а не сериализованный PHP-объект. Такой переход формата должен быть явным для читателя кэша: ниже он читает именно XML. В обычном приложении сразу выбирают saveXML; намеренный отказ здесь нужен для понимания старого вызова serialize.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order id="A"><item>Book</item></order>');
$payload = $document->saveXML($document->documentElement);
if ($payload === false) {
    throw new RuntimeException('XML export failed');
}
$written = file_put_contents('order-cache.xml', $payload);
if ($written === false || $written !== strlen($payload)) {
    throw new RuntimeException('Cache write failed');
}
$saved = file_get_contents('order-cache.xml');
if ($saved === false) {
    throw new RuntimeException('Cache read failed');
}
echo 'order-cache.xml: ', $saved, "\n";

order-cache.xml: <order id="A"><item>Book</item></order>

SaveXML возвращает строку, filePutContents записывает её и возвращает число байтов либо false. Полноту записи проверяем до чтения. Файл видим в рабочей папке, его содержимое пригодно для последующего разбора XML. Для настоящего кэша нужны отдельные правила имени, срока жизни, размера и замены файла; магический __sleep этих правил не создаёт.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order id="A"><item>Book</item></order>');
try {
    $document->documentElement->__wakeup();
} catch (Throwable $error) {
    echo 'Восстановление этим способом запрещено: ', get_class($error), "\n";
}
echo 'Текущее дерево: ', $document->saveXML($document->documentElement), "\n";

Восстановление этим способом запрещено: Exception
Текущее дерево: <order id="A"><item>Book</item></order>

Непосредственный вызов приведён для исследования запрета: базовый метод всегда бросает исключение, хотя объявлен void. Он не получил путь или XML и не загрузил никаких данных. После catch доступен прежний заказ. Рабочий способ восстановления —передать сохранённую XML-строку парсеру, как в следующем примере.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<order id="A"><item>Book</item></order>');
$payload = $document->saveXML();
if ($payload === false) {
    throw new RuntimeException('XML export failed');
}
$restored = new DOMDocument();
if (!$restored->loadXML($payload)) {
    throw new RuntimeException('Restore failed');
}
$restored->documentElement->firstElementChild->textContent = 'Notebook';
echo 'Восстановленная версия: ', $restored->saveXML($restored->documentElement), "\n";
echo 'Исходная версия: ', $document->saveXML($document->documentElement), "\n";

Восстановленная версия: <order id="A"><item>Notebook</item></order>
Исходная версия: <order id="A"><item>Book</item></order>

SaveXML создаёт строку payload; парсер строит новое дерево restored. Правка Text через restored не затрагивает document, что видно по двум версиям заказа. Это перенос данных, а не восстановление прежней объектной идентичности. XML здесь создан самим примером; внешнему кэшу нужен лимит размера и разбор с обработкой ошибок до чтения documentElement.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<item z="2" a="1"/>');
$canonical = $document->C14N();
if ($canonical === false) {
    throw new RuntimeException('Canonicalization failed');
}
echo $canonical, "
";

<item a="1" z="2"></item>

Строгое === false отделяет ошибку от допустимой строки. XML-декларация здесь не включается в канонический результат.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order><!-- internal note --><item>A</item></order>');
$without = $document->C14N(false, false);
$with = $document->C14N(false, true);
echo $without, "
";
echo $with, "
";

<order><item>A</item></order>
<order><!-- internal note --><item>A</item></order>

Одинаковая бизнес-запись даёт разные байты при другой политике комментариев. На стороне получателя нельзя угадывать параметры подписи.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<item><name>Book</name><internal>supplier note</internal></item>');
$publicXml = $document->C14N(false, false, [
    'query' => '//name | //name/text()',
]);
echo $publicXml, "
";

<name>Book</name>

XPath включает и сам name, и его текст. Если выбрать только элемент без его текстового узла, результат не обязан содержать Book. Для экспорта сложного публичного формата яснее построить новый документ с разрешёнными полями.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order id="A"><item>Book</item></order>');
$filters = [
    'Нет query' => [],
    'Число вместо запроса' => ['query' => 42],
    'Число вместо узлов' => ['query' => 'count(//order)'],
];
foreach ($filters as $label => $filter) {
    try {
        $document->C14N(false, false, $filter);
    } catch (Throwable $error) {
        echo $label, ': ', get_class($error), "; экспорт отменён\n";
    }
}
$canonical = $document->C14N(false, false, [
    'query' => '//order | //order/@* | //order//node()',
]);
if ($canonical === false) {
    throw new RuntimeException('Canonicalization failed');
}
echo 'После исправления: ', $canonical, "\n";

Нет query: ValueError; экспорт отменён
Число вместо запроса: TypeError; экспорт отменён
Число вместо узлов: Error; экспорт отменён
После исправления: <order id="A"><item>Book</item></order>

Три неправильные конфигурации обрабатываются отдельно: query обязателен, он должен быть строкой, а его результатом должен быть набор узлов. Исправленный XPath объединяет через | элемент order, его атрибуты @* и всех вложенных узлов //node(), включая Text Book. Return сохраняется в canonical, проверяется на false и только потом выводится. Этот выбор не содержит пространств имён; для них ниже явно включены namespace-узлы.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<root xmlns:p="urn:prices" xmlns:q="urn:metadata"><p:price currency="RUB">100</p:price></root>');
$price = $document->documentElement->firstElementChild;
echo 'Inclusive: ', $price->C14N(false), "\n";
echo 'Exclusive: ', $price->C14N(true), "\n";
echo 'Exclusive с q: ', $price->C14N(true, false, null, ['q']), "\n";

Inclusive: <p:price xmlns:p="urn:prices" xmlns:q="urn:metadata" currency="RUB">100</p:price>
Exclusive: <p:price xmlns:p="urn:prices" currency="RUB">100</p:price>
Exclusive с q: <p:price xmlns:p="urn:prices" xmlns:q="urn:metadata" currency="RUB">100</p:price>

Price присоединён к документу и наследует объявления p и q. False сохраняет оба объявления по правилам inclusive. True оставляет видимый p, нужный имени элемента; q в имени не используется. Четвёртый аргумент [q] просит сохранить q и при exclusive. Это массив префиксов, а не URI. Третий null означает отсутствие XPath-фильтра. В рабочем протоколе режим задаётся заранее: выбирать его по понравившемуся выводу нельзя.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<root xmlns:p="urn:prices"><p:price currency="RUB">100</p:price><secret>internal</secret></root>');
$public = $document->C14N(true, false, [
    'query' => '//v:price | //v:price/@* | //v:price/text() | //v:price/namespace::*',
    'namespaces' => ['v' => 'urn:prices'],
]);
if ($public === false || $public === '') {
    throw new RuntimeException('Expected public price is absent');
}
echo $public, "\n";

<p:price xmlns:p="urn:prices" currency="RUB">100</p:price>

Массив имеет два ключа: query и namespaces. Собственный XPath-префикс v связан с тем же URI, что исходный p; менять XML-префикс не требуется. Части запроса выбирают элемент, атрибут currency, Text100 и объявления пространства. Return становится строкой public, в которой нет secret. Такая выборка не заменяет проектирование разрешённой схемы экспорта или протокол XML Signature.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order id="A"/>');
$bytes = $document->C14NFile('canonical.xml');
if ($bytes === false) {
    throw new RuntimeException('Write failed');
}
$saved = file_get_contents('canonical.xml');
if ($saved === false) {
    throw new RuntimeException('Read failed');
}
echo 'canonical.xml: ', $saved, "\n";
echo 'Записано байтов: ', $bytes, "\n";
echo 'Прочитано байтов: ', strlen($saved), "\n";

canonical.xml: <order id="A"></order>
Записано байтов: 22
Прочитано байтов: 22

Первый аргумент —имя создаваемого файла относительно рабочей папки запуска. C14NFile возвращает число записанных байтов22 в bytes, а не XML-строку. FileGetContents читает строку отдельно; strlen здесь также измеряет байты. При false выполнение прерывается. Запускайте пример в отдельной учебной папке: существующий canonical.xml по этому пути будет перезаписан.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<report><!-- build note --><total>2</total></report>');
$expected = $document->C14N(false, false);
$bytes = $document->C14NFile('report.xml', false, false);
if ($expected === false || $bytes === false) {
    throw new RuntimeException('Export failed');
}
$saved = file_get_contents('report.xml');
if ($saved === false || $saved !== $expected) {
    throw new RuntimeException('Export does not match agreed XML');
}
echo 'report.xml: ', $saved, "\n";
echo 'Готовый объём: ', $bytes, " байт\n";

report.xml: <report><total>2</total></report>
Готовый объём: 33 байт

После uri идут два bool: exclusive=false, withComments=false. Оба вызова используют одинаковую политику; прочитанный файл сравнивается с ожидаемой строкой, затем показывается целиком. Видно, что total2 сохранён, build note отсутствует. Это небольшой учебный экспорт: для больших документов не держите второй полный результат только ради такого сравнения; для важной замены используйте временный файл и обработку ошибок файловой системы.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order id="A"/>');
$order = $document->documentElement;
try {
    $payload = serialize($order);
} catch (Throwable $error) {
    echo 'DOM-объект не сохранён: ', get_class($error), "\n";
    $payload = $document->saveXML($order);
}
if ($payload === false) {
    throw new RuntimeException('XML export failed');
}
echo 'Переносимые данные: ', $payload, "\n";

DOM-объект не сохранён: Exception
Переносимые данные: <order id="A"/>

Serialize пытается сохранить PHP-объект и запускает запрет сериализации DOM. В catch получаем другой формат —XML-строку. После обработки payload содержит данные заказа, а не сериализованный PHP-объект. Такой переход формата должен быть явным для читателя кэша: ниже он читает именно XML. В обычном приложении сразу выбирают saveXML; намеренный отказ здесь нужен для понимания старого вызова serialize.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order id="A"><item>Book</item></order>');
$payload = $document->saveXML($document->documentElement);
if ($payload === false) {
    throw new RuntimeException('XML export failed');
}
$written = file_put_contents('order-cache.xml', $payload);
if ($written === false || $written !== strlen($payload)) {
    throw new RuntimeException('Cache write failed');
}
$saved = file_get_contents('order-cache.xml');
if ($saved === false) {
    throw new RuntimeException('Cache read failed');
}
echo 'order-cache.xml: ', $saved, "\n";

order-cache.xml: <order id="A"><item>Book</item></order>

SaveXML возвращает строку, filePutContents записывает её и возвращает число байтов либо false. Полноту записи проверяем до чтения. Файл видим в рабочей папке, его содержимое пригодно для последующего разбора XML. Для настоящего кэша нужны отдельные правила имени, срока жизни, размера и замены файла; магический __sleep этих правил не создаёт.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order id="A"><item>Book</item></order>');
try {
    $document->documentElement->__wakeup();
} catch (Throwable $error) {
    echo 'Восстановление этим способом запрещено: ', get_class($error), "\n";
}
echo 'Текущее дерево: ', $document->saveXML($document->documentElement), "\n";

Восстановление этим способом запрещено: Exception
Текущее дерево: <order id="A"><item>Book</item></order>

Непосредственный вызов приведён для исследования запрета: базовый метод всегда бросает исключение, хотя объявлен void. Он не получил путь или XML и не загрузил никаких данных. После catch доступен прежний заказ. Рабочий способ восстановления —передать сохранённую XML-строку парсеру, как в следующем примере.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<order id="A"><item>Book</item></order>');
$payload = $document->saveXML();
if ($payload === false) {
    throw new RuntimeException('XML export failed');
}
$restored = Dom\XMLDocument::createFromString($payload);
$restored->documentElement->firstElementChild->textContent = 'Notebook';
echo 'Восстановленная версия: ', $restored->saveXML($restored->documentElement), "\n";
echo 'Исходная версия: ', $document->saveXML($document->documentElement), "\n";

Восстановленная версия: <order id="A"><item>Notebook</item></order>
Исходная версия: <order id="A"><item>Book</item></order>

SaveXML создаёт строку payload; парсер строит новое дерево restored. Правка Text через restored не затрагивает document, что видно по двум версиям заказа. Это перенос данных, а не восстановление прежней объектной идентичности. XML здесь создан самим примером; внешнему кэшу нужен лимит размера и разбор с обработкой ошибок до чтения documentElement.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>Привет</label>');
$text = $document->documentElement->firstChild;
$text->appendData(', Анна');
echo $text->data, "
";
echo $document->documentElement->childNodes->length, "
";

Привет, Анна
1

firstChild — текст внутри label. Метод изменил этот объект; новый сосед не появился.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>Author: </label>');
$text = $document->documentElement->firstChild;
$text->appendData('A & B');
echo $document->saveXML($document->documentElement), "
";

<label>Author: A &amp; B</label>

В data хранится A & B, а XML-сериализатор корректно экранирует амперсанд. Не подставляйте текст руками в строку с тегами.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>Привет</label>');
$text = $document->documentElement->firstChild;
echo $text->substringData(0, 3), "
";
echo $text->data, "
";

При
Привет

Вызов возвращает строку; он не удаляет остаток. Номера букв не равны байтовым индексам русского UTF-8.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<labels><label>Notebook</label><label>Pen</label></labels>');
foreach ($document->documentElement->childNodes as $label) {
    $text = $label->firstChild;
    $preview = $text->substringData(0, 4);
    echo $preview, $text->length > 4 ? '...' : '', "
";
}

Note...
Pen

В этом формате каждый label содержит один Text. При смешанной разметке сначала определите, надо ли объединить textContent, а не слепо работать только с первым ребёнком.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>Заказ 42</label>');
$text = $document->documentElement->firstChild;
$text->insertData(6, '№');
echo $text->data, "
";

Заказ №42

Шесть — количество кодовых точек в «Заказ »: пять букв и пробел. Это не результат strlen русского текста.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<item><name>Book</name><price>100</price></item>');
$item = $document->documentElement;
$text = $item->firstElementChild->firstChild;
$text->insertData(0, '[SALE] ');
echo $item->firstElementChild->textContent, "
";
echo $item->lastElementChild->textContent, "
";

[SALE] Book
100

Изменяется Text внутри name. Присваивание item->textContent уничтожило бы структуру name/price, поэтому здесь оно не подходит.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>AB-CD</label>');
$text = $document->documentElement->firstChild;
$text->deleteData(2, 1);
echo $text->data, "
";

ABCD

Удаляется одна кодовая точка с индексом 2 — дефис. Остальные части соединяются в том же Text.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<names><name>DRAFT: Book</name><name>Pen</name></names>');
foreach ($document->documentElement->childNodes as $name) {
    $text = $name->firstChild;
    if (str_starts_with($text->data, 'DRAFT: ')) {
        $text->deleteData(0, 7);
    }
    echo $text->data, "
";
}

Book
Pen

Здесь ASCII-префикс имеет одинаковую длину в байтах и кодовых точках. Для другого префикса не подставляйте strlen, если он содержит многобайтовые символы.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>Price: 100</label>');
$text = $document->documentElement->firstChild;
$text->replaceData(7, 3, '1200');
echo $text->data, "
";

Price: 1200

Это учебная фиксированная строка. Денежное значение в реальном формате лучше хранить отдельным price, а подпись строить из проверенных данных.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>Status: waiting</label>');
$text = $document->documentElement->firstChild;
if (!str_starts_with($text->data, 'Status: ')) {
    throw new RuntimeException('Unexpected label format');
}
$offset = 8;
$text->replaceData($offset, $text->length - $offset, 'ready');
echo $text->data, "
";

Status: ready

Вместо отрицательного count явно вычислен остаток. Если формат изменится, проверка остановит правку до повреждения текста.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<label>ABCD</label>');
$label = $document->documentElement;
$first = $label->firstChild;
$tail = $first->splitText(2);
echo 'Первый Text: [', $first->data, "]\n";
echo 'Возвращённый Text: [', $tail->data, "]\n";
echo 'Текст элемента: ', $label->textContent, "\n";
echo 'Текстовых детей: ', $label->childNodes->length, "\n";

Первый Text: [AB]
Возвращённый Text: [CD]
Текст элемента: ABCD
Текстовых детей: 2

Аргумент2 —граница перед C. First остался исходным объектом, но теперь содержит AB. Return попал в tail: это новый Text CD, уже вставленный справа от first. Число2 измеряет число детей, а не размер текста. Снаружи label по-прежнему показывает ABCD; чтобы появился видимый тег выделения, дальше хвост переносится под strong.

<?php
declare(strict_types=1);

$document = new DOMDocument();
$document->loadXML('<description>Buy Book</description>');
$description = $document->documentElement;
$tail = $description->firstChild->splitText(4);
$strong = $document->createElement('strong');
$description->insertBefore($strong, $tail);
$strong->appendChild($tail);
echo $document->saveXML($description), "
";

<description>Buy <strong>Book</strong></description>

appendChild переносит хвост под strong. Никакая строка с HTML не исполняется: вся структура создана явными узлами.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<label>Привет</label>');
$text = $document->documentElement->firstChild;
$text->appendData(', Анна');
echo $text->data, "
";
echo $document->documentElement->childNodes->length, "
";

Привет, Анна
1

firstChild — текст внутри label. Метод изменил этот объект; новый сосед не появился.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<label>Author: </label>');
$text = $document->documentElement->firstChild;
$text->appendData('A & B');
echo $document->saveXML($document->documentElement), "
";

<label>Author: A &amp; B</label>

В data хранится A & B, а XML-сериализатор корректно экранирует амперсанд. Не подставляйте текст руками в строку с тегами.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<label>Привет</label>');
$text = $document->documentElement->firstChild;
echo $text->substringData(0, 3), "
";
echo $text->data, "
";

При
Привет

Вызов возвращает строку; он не удаляет остаток. Номера букв не равны байтовым индексам русского UTF-8.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<labels><label>Notebook</label><label>Pen</label></labels>');
foreach ($document->documentElement->childNodes as $label) {
    $text = $label->firstChild;
    $preview = $text->substringData(0, 4);
    echo $preview, $text->length > 4 ? '...' : '', "
";
}

Note...
Pen

В этом формате каждый label содержит один Text. При смешанной разметке сначала определите, надо ли объединить textContent, а не слепо работать только с первым ребёнком.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<label>Заказ 42</label>');
$text = $document->documentElement->firstChild;
$text->insertData(6, '№');
echo $text->data, "
";

Заказ №42

Шесть — количество кодовых точек в «Заказ »: пять букв и пробел. Это не результат strlen русского текста.

<?php
declare(strict_types=1);

$document = Dom\XMLDocument::createFromString('<item><name>Book</name><price>100</price></item>');
$item = $document->documentElement;
$text = $item->firstElementChild->firstChild;
$text->insertData(0, '[SALE] ');
echo $item->firstElementChild->textContent, "
";
echo $item->lastElementChild->textContent, "
";

[SALE] Book
100

Изменяется Text внутри name. Присваивание item->textContent уничтожило бы структуру name/price, поэтому здесь оно не подходит.