xml_parser_get_option

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

xml_parser_get_optionGet options from an XML parser

Description

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

Gets an option value from an XML parser.

Parameters

parser
A reference to the XML parser to get an option from.
option
Which option to fetch. XML_OPTION_CASE_FOLDING, XML_OPTION_SKIP_TAGSTART, XML_OPTION_SKIP_WHITE and XML_OPTION_TARGET_ENCODING are available. See xml_parser_set_option() for their description.

Return Values

Returns the option's value.

Errors/Exceptions

Throws a ValueError when an invalid value is passed to option.

Prior to PHP 8.0.0, passing an invalid value to option generated a E_WARNING as well as making the function return false.

Changelog

Version Description
8.3.0 The function now returns a boolean for boolean options.
8.0.0 parser expects an XMLParser instance now; previously, a valid xml resource was expected.
8.0.0 A ValueError is now thrown if option is invalid.
7.1.24, 7.2.12, 7.3.0 options now supports XML_OPTION_SKIP_TAGSTART and XML_OPTION_SKIP_WHITE.
add a note add a note

User Contributed Notes 1 note

up
0
dnricky at hotmail dot com
7 years ago
<?php
$xmlparser
= xml_parser_create();

echo
"XML_OPTION_CASE_FOLDING:" . xml_parser_get_option($xmlparser, XML_OPTION_CASE_FOLDING) . "<br />"; //Specifies if case-folding is enabled. Enabled by default. Can be 1 (TRUE) or 0 (FALSE)

echo "XML_OPTION_TARGET_ENCODING:" . xml_parser_get_option($xmlparser, XML_OPTION_TARGET_ENCODING ) . "<br />"; //Specifies which target encoding to use in this XML parser. By default, it is set to the same as the xml_parser_create() function. Supported target encodings are ISO-8859-1, US-ASCII and UTF-8.

xml_parser_free($xmlparser);
?>
To Top