PHP Velho Oeste 2024

xml_parser_set_option

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

xml_parser_set_optionSet options in an XML parser

Description

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

Sets an option in an XML parser.

Parameters

parser

A reference to the XML parser to set an option in.

option

Which option to set. See below.

The following options are available:

XML parser options
Option constant Data type Description
XML_OPTION_CASE_FOLDING bool Controls whether case-folding is enabled for this XML parser. Enabled by default.
XML_OPTION_SKIP_TAGSTART integer Specify how many characters should be skipped in the beginning of a tag name.
XML_OPTION_SKIP_WHITE bool Whether to skip values consisting of whitespace characters.
XML_OPTION_TARGET_ENCODING string Sets which target encoding to use in this XML parser.By default, it is set to the same as the source encoding used by xml_parser_create(). Supported target encodings are ISO-8859-1, US-ASCII and UTF-8.

value

The option's new value.

Return Values

Returns true on success or false on failure.

Errors/Exceptions

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

Prior to PHP 8.0.0, the function returned false when 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 value parameter now also accepts booleans. The options XML_OPTION_CASE_FOLDING and XML_OPTION_SKIP_WHITE are now 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.
add a note add a note

User Contributed Notes 9 notes

up
1
www.thomaskoch.it
15 years ago
The option XML_OPTION_SKIP_WHITE has no effect in my PHP 5.2.6 (with expat-1.95.8-5). To skip cdata composed of white space only, simply check for that at the beginning of your cdata callback function:

<?php
function callback_cdata($parser, $cdata)
{
if(!
trim($cdata))
  return;

// ... continue processing ...
}
?>
up
0
j[no_spam_please] at [thx]jessepearson dot net
17 years ago
In the function below, you need to update two lines if you don't want php to throw warnings.

change these two:
           $elements[$index]['attributes'] = $tag['attributes'];
           $elements[$index]['content'] = $tag['value'];

to this:
      $elements[$index]['attributes'] = empty($tag['attributes']) ? "" : $tag['attributes'];
      $elements[$index]['content']    = empty($tag['value']) ? "" : $tag['value'];
up
0
ksavage at achaean dot com
19 years ago
Had one heck of a time getting curl to send my XML request.  Tried a lot of different things, FINALLY ended up with this. 

Im making a curl request to paymentech / Orbital 's payment gateway.   Essentially, I took the same header i made for the fsockopen() request, and used it for this curl request. (Hostinc company didnt allow fsockopen().

You'll note that this specific gateway requires a custom content type header.  Thats what gave me the most trouble.  When using the CURLOPT_HTTPHEADER, and CURLOPT_POSTFIELDS together, it doesnt matter, it sends the default post header because of CURLOPT_POSTFIELDS.

<?php

$url
= "https://example.com";
$page = "/proccessing_page.cgi";

$post_string = "<YourXML>All XML stuff Here</YourXML>";

      
$header  = "POST ".$page." HTTP/1.0 \r\n";
       
$header .= "MIME-Version: 1.0 \r\n";
       
$header .= "Content-type: application/PTI26 \r\n";
       
$header .= "Content-length: ".strlen($post_string)." \r\n";
       
$header .= "Content-transfer-encoding: text \r\n";
       
$header .= "Request-number: 1 \r\n";
       
$header .= "Document-type: Request \r\n";
       
$header .= "Interface-Version: Test 1.4 \r\n";
       
$header .= "Connection: close \r\n\r\n";
       
$header .= $post_string;
       
       
$ch = curl_init();
       
curl_setopt($ch, CURLOPT_URL,$url);
      
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
       
curl_setopt($ch, CURLOPT_TIMEOUT, 4);
       
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $header);

       
$data = curl_exec($ch);         if (curl_errno($ch)) {
           print
curl_error($ch);
        } else {
          
curl_close($ch);
        }

// use XML Parser on $data, and your set!

       
$xml_parser = xml_parser_create();
       
xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0);
       
xml_parser_set_option($xml_parser,XML_OPTION_SKIP_WHITE,1);
       
xml_parse_into_struct($xml_parser, $data, $vals, $index);
       
xml_parser_free($xml_parser);

// $vals = array of XML tags.  Go get em!

?>

Worked like a dream for me.  Enjoy!
up
0
pupeno at pupeno dot com
21 years ago
XML is case sensitive, then, from my point of view, disabling case folding doesn't goes against xml 1.0 specifications but the contrary, disabling case folding allow us to distiguish between diferent cases of the same letter ('a' and 'A') which of XML are two diferent things.
From my point of view, disabling case folding is a good practice and I think it should be disabled by default.
More information on:
http://www.isacat.net/2001/xml/case.htm
and
http://www.w3.org/TR/REC-xml
Thank you.
up
0
ta at NOSPAM dot magicsquare dot info
21 years ago
XML_OPTION_SKIP_WHITE works for me (linux, php 4.2.1)

phpinfo says :

XML Support active
XML Namespace Support active
EXPAT Version expat_1.95.2

i guess it depends on expat version/presence
up
-1
matt at mcbridematt dot dhs dot org
21 years ago
Re: anony at mous dot com
case folding is a violation of the XHTML specification. xhtml is all in lowercase to be inline with the DOM
up
-1
chris at wildcharacters dot com
22 years ago
The two 'skip' tags are not available to windows users using PHP 4.0.4.  The following:

$skipWhite = xml_parser_get_option ($xmlParser,XML_OPTION_SKIP_WHITE);
$skipTagStart = xml_parser_get_option ($xmlParser,XML_OPTION_SKIP_TAGSTART);

generates the following errors:
Warning: xml_parser_get_option: unknown option in c:/program files/abria merlin/apache/htdocs/xml/sax_test.php on line 230
up
-1
anony at mous dot com
24 years ago
Disable case folding or your code will be violating the XML 1.0 specification.
up
-1
Anonymous
17 years ago
A little mod to a function posted here...

function xml_to_array( $file )
{
    $parser = xml_parser_create();
    xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, 0 );
    xml_parser_set_option( $parser, XML_OPTION_SKIP_WHITE, 1 );
    xml_parse_into_struct( $parser, file_get_contents($file), $tags );
    xml_parser_free( $parser );
   
    $elements = array();
    $stack = array();
    foreach ( $tags as $tag )
    {
        $index = count( $elements );
        if ( $tag['type'] == "complete" || $tag['type'] == "open" )
        {
            $elements[$index] = array();
            $elements[$index]['name'] = $tag['tag'];
            $elements[$index]['attributes'] = $tag['attributes'];
            $elements[$index]['content'] = $tag['value'];
           
            if ( $tag['type'] == "open" )
            {    # push
                $elements[$index]['children'] = array();
                $stack[count($stack)] = &$elements;
                $elements = &$elements[$index]['children'];
            }
        }
       
        if ( $tag['type'] == "close" )
        {    # pop
            $elements = &$stack[count($stack) - 1];
            unset($stack[count($stack) - 1]);
        }
    }
    return $elements[0];
}
To Top