PHP xml_set_unparsed_entity_decl_handler() Function

❮ PHP XML Parser Reference

Example

Create an XML parser, set character data handler, set unparsed entity declaration handler, and parse an XML document:

<?php
$parser=xml_parser_create();

function char($parser,$data) {
  echo $data;
}

function unparsed_ent_handler($parser,$entname,$base,$sysID,$pubID,$notname) {
  print "$entname<br>";
  print "$sysID<br>";
  print "$pubID<br>";
  print "$notname<br>";
}

xml_set_character_data_handler($parser,"char");
// Set up unparsed entity declaration handler
xml_set_unparsed_entity_decl_handler($parser,"unparsed_ent_handler");

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

while ($data=fread($fp,4096)) {
  xml_parse($parser,$data,feof($fp)) or
  die (sprintf("XML Error: %s at line %d",
  xml_error_string(xml_get_error_code($parser)),
  xml_get_current_line_number($parser)));
}
xml_parser_free($parser);
fclose($fp);
?>


Definition and Usage

The xml_set_unparsed_entity_decl_handler() function specifies a function to be called when the parser an unparsed entity in the XML document.

Note: The handler parameter can also be an array containing an object reference and a method name.

Syntax

xml_set_unparsed_entity_decl_handler(parser, handler)

Parameter Values

Parameter Description
parser Required. Specifies the XML parser to use
handler Required. Specifies a function to be called if the XML parser encounters an external entity declaration with an NDATA declaration. The function must accept six parameters:
  • $parser - A variable containing the XML parser calling the handler
  • $entity_name - A variable containing the name of the entity
  • $base - The base for resolving the system identifier (system_id) of the external entity. Currently, this is always an empty string
  • $system_id - The system identifier of the external entity
  • $public_id - The public identifier of the external entity
  • $notation_name - The name of the notation of this entity


Technical Details

Return Value: TRUE on success. FALSE on failure
PHP Version: 4.0+

❮ PHP XML Parser Reference
Copyright 1999-2023 by Refsnes Data. All Rights Reserved.