xml_set_default_handler

デフォルトのハンドラを設定する

説明

true xml_set_default_handler(XMLParser $parser, callablestringnull $handler)

XMLパーサー parser のデフォルトのハンドラ関数を設定します。

パラメータ

parser
XMLパーサー
handler

null が渡されると、ハンドラはデフォルトの状態にリセットされます。

警告

空文字列を渡すことでもハンドラはリセットされますが、これは PHP 8.4.0 以降非推奨となっています。

handler が callable の場合、その callable がハンドラとして設定されます。

handler が文字列の場合、xml_set_object で設定されたオブジェクトのメソッド名になります。

警告

PHP 8.4.0 以降、非推奨となっています。

警告

PHP 8.4.0 以降では、実際に呼び出されるときではなく、ハンドラを設定する際に callable であるかがチェックされます。 従って、コールバックとしてメソッド文字列を指定する場合、それより前に、 xml_set_object を呼び出しておく必要があります。 しかし、この動作も PHP 8.4.0 以降非推奨となっているため、メソッドには適切な callable を使用することが推奨されます。

handler のシグネチャは、以下でなければいけません:

void handler(XMLParser $parser, string $data)
parser
ハンドラをコールするXMLパーサー
data
data には、文字データを文字列として指定します。 これは、XML 宣言またはドキュメント型宣言、エンティティ、 他にハンドラがない別のデータとすることが可能です。

戻り値

常に true を返します。

変更履歴

バージョン 説明
8.4.0 非 callable な string を handler に渡すことは、現在非推奨となっています。 メソッドには適切な callable を使用するか、ハンドラをリセットする場合は null を使用してください。
8.4.0 handler が callable として有効であるかどうかは、 呼び出し時ではなく、ハンドラーを設定する際にチェックされるようになりました。
8.0.0 引数 parser は、 XMLParser インスタンスを期待するようになりました。 これより前のバージョンでは、有効な xml resource が期待されていました。