DOMNode::C14N

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

DOMNode::C14NCanonicalize nodes to a string

Beschreibung

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

Canonicalize nodes to a string

Parameter-Liste

exclusive

Enable exclusive parsing of only the nodes matched by the provided xpath or namespace prefixes.

withComments

Retain comments in output.

xpath

Ein Array von XPath-Ausdrücken, nach denen die Knoten gefiltert werden. Jeder Eintrag in diesem Array ist ein assoziatives Array mit

  • dem erforderlichen Schlüssel query, der den XPath-Ausdruck als Zeichenkette enthält.
  • dem optionalen Schlüssel namespaces, der ein Array enthält, das Namensraum-Präfixe (Schlüssel) auf Namensraum-URIs (Werte) abbildet.

nsPrefixes

An array of namespace prefixes to filter the nodes by.

Rückgabewerte

Returns canonicalized nodes as a stringBei einem Fehler wird false zurückgegeben.

Beispiele

Beispiel #1 Example with XPath query

This example demonstrates advanced usage canonicalizing and filtering the nodes by an XPath query.

<?php

$dom
= new DOMDocument();
$dom->loadXML(<<<XML
<root xmlns:food="urn:food">
<!-- redundant namespace declaration will be canonicalized -->
<food:fruit xmlns:food="urn:food">Apple</food:fruit>
<food:fruit>Orange</food:fruit>
<food:fruit>Pear</food:fruit>
<!-- vegetables here -->
<food:vegetable>Lettuce</food:vegetable>
</root>
XML);

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

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

<food:fruit>Apple</food:fruit><food:fruit>Orange</food:fruit><food:fruit>Pear</food:fruit>

Siehe auch