xml _set _external _entity _ref _handler
(PHP 4, PHP 5, PHP 7)
xml_set_external_entity_ref_handler — Set up external entity reference handler
Description
Sets the external entity reference handler function for the XML parser
parser
.
Parameters
-
parser
-
A reference to the XML parser to set up external entity reference 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 five parameters, and should return an integer value.If the value returned from the handler isFALSE
(which it will be if no value is returned), the XML parser will stop parsing and xml_get_error_code() will returnXML_ERROR_EXTERNAL_ENTITY_HANDLING
.handler ( resource$parser
, string$open_entity_names
, string$base
, string$system_id
, string$public_id
)-
parser
- The first parameter, parser, is a reference to the XML parser calling the handler.
-
open_entity_names
-
The second parameter,
open_entity_names
, is 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.Currently this parameter will always be set to an empty string. -
system_id
-
The fourth parameter,
system_id
, is the system identifier as specified in the entity declaration. -
public_id
-
The fifth parameter,
public_id
, is 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.
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.
-
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-xml-set-external-entity-ref-handler.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.