デフォルトの外部エンティティローダーを変更する

# libxml_set_external_entity_loader

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

libxml_set_external_entity_loader — デフォルトの外部エンティティローダーを変更する

### 説明

function libxml_set_external_entity_loader(?callable `$resolver_function`): true

デフォルトの外部エンティティローダーを変更します。 たとえ `LIBXML_NOENT` が個別のXMLの操作に設定されている場合でも、 XXE攻撃を避けるために、任意の外部エンティティの展開を抑制するために使うことができます。 また、 libxml_disable_entity_loader() を呼び出すことよりも、この関数を呼び出すほうが通常は好ましいです。

### パラメータ

`resolver_function`

  次のシグネチャを持つ callable を指定します。:

  function resolver(?string `$public_id`, string `$system_id`, array `$context`): resource|string|null
  `public_id`
    パブリック ID
  `system_id`
    システムID
  `context`
    4つのキーを持つ配列。 キーは `"directory"`, `"intSubName"`, `"extSubURI"`, `"extSubSystem"` です。
  この callable は、 リソースまたはリソースをオープンできる文字列あるいは `null` でなければなりません。`null` を返す場合、エンティティ参照の解決は失敗します。

### 戻り値

常に `true` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.5.0 | 戻り値の型が、`true` になりました。これより前のバージョンでは、bool でした。

### 例

例1 libxml_set_external_entity_loader() の例

    <?php
    $xml = <<<XML
    <!DOCTYPE foo PUBLIC "-//FOO/BAR" "http://example.com/foobar">
    <foo>bar</foo>
    XML;

    $dtd = <<<DTD
    <!ELEMENT foo (#PCDATA)>
    DTD;

    libxml_set_external_entity_loader(
        function ($public, $system, $context) use($dtd) {
            var_dump($public);
            var_dump($system);
            var_dump($context);
            $f = fopen("php://temp", "r+");
            fwrite($f, $dtd);
            rewind($f);
            return $f;
        }
    );

    $dd = new DOMDocument;
    $r  = $dd->loadXML($xml);

    var_dump($dd->validate());
    ?>

上の例の出力は以下となります。

    string(10) "-//FOO/BAR"
    string(25) "http://example.com/foobar"
    array(4) {
        ["directory"]    => NULL
        ["intSubName"]   => NULL
        ["extSubURI"]    => NULL
        ["extSubSystem"] => NULL
    }
    bool(true)

### 参考

- libxml_disable_entity_loader() - 外部エンティティの読み込み機能を無効にする
- libxml_get_external_entity_loader() - 現在の外部エンティティローダーを取得する

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