xml_parser_set_option

    (PHP 4, PHP 5, PHP 7, PHP 8)

    xml_parser_set_option — XML パーサのオプションを設定する

    説明

    xml_parser_set_option(XMLParser$parser, int$option, string|int|bool$value): bool

    XML パーサのオプションを設定します。

    パラメータ

    parser

    オプションを設定する XML パーサへのリファレンス。

    option

    設定するオプション。以下を参照ください。

    次のオプションが利用可能です。

    XML パーサオプション
    オプション定数データ型説明
    XML_OPTION_CASE_FOLDINGbool XMLパーサの大文字変換 を有効にするかどうかを制御する。デフォルトで有効。
    XML_OPTION_SKIP_TAGSTARTinteger タグ名の最初の何文字を読み飛ばすかどうかを設定する。
    XML_OPTION_SKIP_WHITEbool 空白文字からなる値を読み飛ばすかどうかを設定する。
    XML_OPTION_TARGET_ENCODINGstring XML パーサについてどの ターゲット エンコーディング を使用するかを設定する。デフォルトでは、 xml_parser_create() により使用されたソース エンコーディングと同じエンコーディングが設定されます。 サポートされるターゲットエンコーディングは、 ISO-8859-1, US-ASCII, UTF-8 です。
    value

    そのオプションの新しい設定値。

    戻り値

    成功した場合に true を返します。 失敗した場合、false を返します。

    エラー / 例外

    無効な値を option に渡すと、ValueError がスローされます。

    PHP 8.0.0 より前のバージョンでは、 無効な値を option に渡すと E_WARNING が発生し、false を返していました。

    変更履歴

    バージョン説明
    8.3.0value パラメータは、 boolean の値を受け入れるようになりました。 XML_OPTION_CASE_FOLDING と XML_OPTION_SKIP_WHITE が boolean の値を受け入れるようになっています。
    8.0.0 引数 parser は、 XMLParser インスタンスを期待するようになりました。 これより前のバージョンでは、有効な xmlresource が期待されていました。
    8.0.0option が無効な値の場合、 ValueError がスローされるようになりました。
    To Top