xml_set_external_entity_ref_handler
Set up external entity reference handler
Description
true xml_set_external_entity_ref_handler(XMLParser $parser
, callable $handler
)
Parameters
-
parser
-
The XML parser.
-
handler
-
If null
or an empty string is passed, the handler is reset to its default state.
If handler
is a callable,
the callable is set as the handler.
If handler
is a string,
it can be the name of a method of an object set with
xml_set_object.
The signature of the handler must be:
bool handler(
XMLParser $parser
,
string $open_entity_names
,
stringfalse $base
,
string $system_id
,
stringfalse $public_id
)
-
parser
-
The XML parser calling the handler.
-
open_entity_names
-
A space-separated list of the names of the entities that are open for
the parse of this entity (including the name of the referenced
entity).
-
base
-
This is the base for resolving the system identifier
(
system_id
) of the external entity.
-
system_id
-
The system identifier as specified in the entity declaration.
-
public_id
-
The public identifier as specified in the entity declaration, or
an empty string if none was specified; the whitespace in the
public identifier will have been normalized as required by
the XML spec.
The handler should return true
if the entity was handled,
false
otherwise.
When returning false
the XML parser will stop parsing and
xml_get_error_code will return
XML_ERROR_EXTERNAL_ENTITY_HANDLING
.
Return Values
Always returns true
.