Php/docs/function.xml-set-unparsed-entity-decl-handler
xml_set_unparsed_entity_decl_handler
(PHP 4, PHP 5, PHP 7)
xml_set_unparsed_entity_decl_handler — Set up unparsed entity declaration handler
Description
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>
See [http://www.w3.org/TR/1998/REC-xml-19980210#sec-external-ent » section 4.2.2 of the XML 1.0 spec] for the definition of notation declared external entities.
Parameters
parser
A reference to the XML parser to set up unparsed entity declaration handler function.
handler
handler
is a string containing the name of a function that must exist when xml_parse() is called forparser
.The function named by
handler
must accept six parameters:handler ( XMLParser
$parser
, string$entity_name
, string$base
, string$system_id
, string$public_id
, string$notation_name
)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.Note: Instead of a function name, an
array containing an object reference and a method name can also be
supplied.
Return Values
Returns TRUE
on success or FALSE
on failure.
Changelog
Version | Description |
---|---|
8.0.0 | parser expects an XMLParser
instance now; previously, a resource was expected. |