PHP xml_set_unparsed_entity_decl_handler() Function

The xml_set_unparsed_entity_decl_handler() function specifies a function to be called when the parser an unparsed entity in the XML document.This function returns TRUE on success, or FALSE on failure.

bool xml_set_unparsed_entity_decl_handler ( resource $parser , callable $handler )

Sets the unparsed entity declaration handler function for the XML parser parser.

The handler will be called if the XML parser encounters an external entity declaration with an NDATA declaration, like the following : -

<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
        NDATA <parameter>notationName</parameter>

Example -

Parameter	Description
parser	A reference to the XML parser to set up unparsed entity declaration handler function.
handler	Required. Specifies a function to be when the parser finds a notation declaration

The Function specified by the "handler" parameter must have six parameters : -

Parameter	Description
parser	The first parameter, parser, is a reference to the XML parser calling the handler.
entity_name	The name of the entity that is about to be defined.
base	This is the base for resolving the system identifier (systemId) of the external entity.Currently this parameter will always be set to an empty string.
system_id	System identifier for the external entity.
public_id	Public identifier for the external entity.
notation_name	Name of the notation of this entity (see xml_set_notation_decl_handler()). If a handler function is set to an empty string, or FALSE, the handler in question is disabled.