Проводит вставку XInclude в объекте DOMDocument

# DOMDocument::xinclude

(PHP 5, PHP 7, PHP 8)

DOMDocument::xinclude — Проводит вставку XInclude в объекте DOMDocument

### Описание

public function DOMDocument::xinclude(int `$options` = 0): int|false

Этот метод вставляет » блоки XInclude в объекте класса DOMDocument.

> Замечание:

> Из-за того, что libxml2 автоматически разрешает сущности, вызов этого метода приведёт к неожидаемым результатам в случае, когда XML-файл содержит прикреплённую схему DTD.

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

`options`
  Побитовое ИЛИ (`OR`) констант опций libxml.

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

Возвращает количество XInclude в документе, -1 если при обработке произошла ошибка, либо `false`, если не было произведено ни одной замены.

### Примеры

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

    <?php

    $xml = <<<EOD
    <?xml version="1.0" ?>
    <chapter xmlns:xi="http://www.w3.org/2001/XInclude">
     <title>Books of the other guy..</title>
     <para>
      <xi:include href="examples/book.xml">
       <xi:fallback>
        <error>xinclude: book.xml not found</error>
       </xi:fallback>
      </xi:include>
     </para>
    </chapter>
    EOD;

    $dom = new DOMDocument;

    // оформим вывод красиво
    $dom->preserveWhiteSpace = false;
    $dom->formatOutput = true;

    // загрузка XML-строки, определённой выше
    $dom->loadXML($xml);

    // вставка блоков xinclude
    $dom->xinclude();

    echo $dom->saveXML();

    ?>

Вывод приведённого примера будет похож на:

    <?xml version="1.0"?>
    <chapter xmlns:xi="http://www.w3.org/2001/XInclude">
      <title>Books of the other guy..</title>
      <para>
        <row xml:base="/home/didou/book.xml">
           <entry>The Grapes of Wrath</entry>
           <entry>John Steinbeck</entry>
           <entry>en</entry>
           <entry>0140186409</entry>
          </row>
        <row xml:base="/home/didou/book.xml">
           <entry>The Pearl</entry>
           <entry>John Steinbeck</entry>
           <entry>en</entry>
           <entry>014017737X</entry>
          </row>
        <row xml:base="/home/didou/book.xml">
           <entry>Samarcande</entry>
           <entry>Amine Maalouf</entry>
           <entry>fr</entry>
           <entry>2253051209</entry>
          </row>
      </para>
    </chapter>

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open