PHP xml_set_external_entity_ref_handler() Function

❮ PHP XML Parser Reference

Example

Create an XML parser, set character data handler, set external entity reference handler, and parse an XML document:

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

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

function ext_ent_handler($parser,$ent,$base,$sysID,$pubID)  {
echo "$ent<br>";
echo "$sysID<br>";
echo "$pubID<br>";
}

// Set the character data handler
xml_set_character_data_handler($parser,"char");

// Set the external entity reference handler
xml_set_external_entity_ref_handler($parser, "ext_ent_handler");

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

while ($data=fread($fp,4096)) {
  // Parse XML data
  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_external_entity_ref_handler() function specifies a function to be called when the parser finds an external 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_external_entity_ref_handler(parser, handler)

Parameter Values

Parameter Description
parser Required. Specifies the XML parser to use
handler Required. Specifies a function to be used as an event handler. The function must accept five parameters:
  • $parser - A variable containing the XML parser calling the handler
  • $name - A variable containing the name of the external 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 as specified in the entity declaration
  • $public_id - The public identifier as specified in the entity declaration


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.