PHP xml_set_notation_decl_handler() Function

The PHP xml_set_notation_decl_handler() function sets the notation declaration handler function for the given XML parser.

A notation declaration is part of the document's DTD and has the following format:

<!NOTATION <parameter>name</parameter>
{ <parameter>systemId</parameter> | <parameter>publicId</parameter>?>

Syntax

xml_set_notation_decl_handler(parser, handler)

Parameters

parser Required. Specify a reference to the XML parser to set up notation declaration handler function.

handler

Required. Specify a string containing the name of a function to be used as an event handler. The function must accept five parameters:

handler(parser, notation_name, base, system_id, public_id)

parser: The first parameter, parser, is a reference to the XML parser calling the handler.
notation_name: A variable containing the name of the notation.
base: The base for resolving the system identifier (system_id) of the notation declaration. Currently this parameter will always be set to an empty string.
system_id: The system identifier of the external notation declaration.
public_id: The public identifier of the external notation declaration.

If a handler function is set to an empty string, or false, the handler in question is disabled. Note: Instead of a function name, an array containing an object reference and a method name can also be used.

Return Value

Returns true on success or false on failure.

Example: xml_set_notation_decl_handler() example

Lets assume that we have a file called test.xml. In the example below, an XML parser is created using xml_parser_create() function. Then the XML file is opened to parse its data using character handler function char_print. Then the not_decl_handler function is set as notation declaration handler function for the given XML parser. After parsing the document, the parser is freed using xml_parser_free() function.

<?php
//create an XML parser
$parser=xml_parser_create();

//character handler function for XML parser
function char_print($parser, $data) {
  echo $data;
}

//notation declaration handler function for XML parser
function not_decl_handler($parser, $not, $base, $sysID, $pubID) {
  echo "$not $sysID $pubID \n";
}

//set the character handler function for XML parser
xml_set_character_data_handler($parser,"char_print");

//set the notation declaration handler function for XML parser
xml_set_notation_decl_handler($parser,"not_decl_handler");

//opening xml file
$fp = fopen("test.xml", "r");

while($data = fread($fp,4096)) {
  //parsing XML data
  xml_parse($parser,$data,feof($fp)) or

    //displaying error when parse error occurs
    die (sprintf("XML Error: %s at line %d",

    //error string
    xml_error_string(xml_get_error_code($parser)),

    //current line
    xml_get_current_line_number($parser)));
}

//free XML parser
xml_parser_free($parser);

fclose($fp);
?>

❮ PHP XML Parser Reference