DOMNode::C14N

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

DOMNode::C14N — Канонизирует узлы в строку

Описание

public function DOMNode::C14N(
    bool $exclusive = false,
    bool $withComments = false,
    ?array $xpath = null,
    ?array $nsPrefixes = null
): string|false

Метод канонизирует узлы в строку

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

exclusive

Включает эксклюзивный разбор только тех узлов, которые совпадают с предоставленными xpath-выражениями или ns_prefixes-префиксами.

withComments

Сохранять комментарии в выводе.

xpath

Массив XPath-выражений для фильтрации узлов. Каждый элемент в этом массиве — ассоциативный массив с:

Обязательным ключом запроса query, который содержит XPath-выражение в виде строки.
Необязательным ключом пространств имён namespaces, который содержит массив для сопоставления префиксов пространств имён (ключей) и URI-идентификаторов пространств имён (значений).

nsPrefixes

Массив префиксов пространств имён для фильтрации узлов.

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

Метод возвращает канонизированные узлы в виде строки или false, если возникла ошибка

Примеры

Пример #1 Пример XPath-запроса

Пример демонстрирует расширенную канонизацию и фильтрацию узлов через XPath-запрос.

<?php

$dom = new DOMDocument();
$dom->loadXML(<<<XML
<root xmlns:food="urn:food">
    <!-- избыточное объявление пространства имен канонизируется -->
    <food:fruit xmlns:food="urn:food">Яблоко</food:fruit>
    <food:fruit>Апельсин</food:fruit>
    <food:fruit>Груша</food:fruit>
    <!-- затем идут овощи -->
    <food:vegetable>Латук</food:vegetable>
</root>
XML);

echo $dom->C14N(true, false, [
    "query" => ".//f:fruit|.//f:fruit/text()",
    "namespaces" => ["f" => "urn:food"],
]);

?>

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

<food:fruit>Яблоко</food:fruit><food:fruit>Апельсин</food:fruit><food:fruit>Груша</food:fruit>

Смотрите также

DOMNode::C14NFile() - Канонизировать узлы в файл

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 3 notes

down

Rijk ¶

13 years ago

When working with (malformed) HTML, you're probably better off using DOMDocument's saveHTML() method instead. C14N() will attempt to make your HTML valid XML, for example by converting <br> to <br></br>.

So instead of:
$html = $Node->C14N();

Use:
$html = $Node->ownerDocument->saveHTML( $Node );

down

jorda at edpsciences dot org ¶

11 years ago

C14N() returns an empty string if the node is not included in the document tree:
<?php
$d = new DOMDocument('1.0');
$d->loadXML('<foo></foo>');
$n = $d->createElement('bar');
var_dump($n->C14N());
$d->documentElement->appendChild($n);
var_dump($n->C14N());
?>
output:
string(0) ""
string(11) "<bar></bar>"

down

lordbaco ¶

10 years ago

[edit by nielsdos: This has been fixed starting in PHP 8.4]

Good to know:

<< Due to a known issue in XML canonicalization in PHP, processing large metadata files in SimpleSAMLphp takes a big amount of resources, with that amount growing approximately by the square of the number of entities in the metadata set >>
https://simplesamlphp.org/metaprocessing

<< The C14N() function appears to have a runtime that is O(N^2) (or possibly worse?) depending on input size, which means that it becomes very slow as the input grows. For example, an input with around 196000 nodes takes about 290 seconds, while an input with 486000 nodes takes 2200 seconds. >>
https://bugs.php.net/bug.php?id=53655

We had the same issue with a 4.1 MB XML (105k lines). The sample code of ticket  #53655 takes 1h36 minute to canonicalize it!

＋Добавить