<HTML ><HEAD ><TITLE >xml_set_external_entity_ref_handler</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="PHP Manual" HREF="index.html"><LINK REL="UP" TITLE="XML parser functions" HREF="ref.xml.html"><LINK REL="PREVIOUS" TITLE="xml_set_end_namespace_decl_handler" HREF="function.xml-set-end-namespace-decl-handler.html"><LINK REL="NEXT" TITLE="xml_set_notation_decl_handler" HREF="function.xml-set-notation-decl-handler.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=ISO-8859-1"></HEAD ><BODY CLASS="refentry" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >PHP Manual</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="function.xml-set-end-namespace-decl-handler.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="function.xml-set-notation-decl-handler.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="function.xml-set-external-entity-ref-handler" ></A >xml_set_external_entity_ref_handler</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN96390" ></A ><P > (PHP 3>= 3.0.6, PHP 4 )</P >xml_set_external_entity_ref_handler -- set up external entity reference handler</DIV ><DIV CLASS="refsect1" ><A NAME="AEN96393" ></A ><H2 >Description</H2 >bool <B CLASS="methodname" >xml_set_external_entity_ref_handler</B > ( resource parser, string handler)<BR ></BR ><P > Sets the external entity reference handler function for the XML parser <TT CLASS="parameter" ><I >parser</I ></TT >. <TT CLASS="parameter" ><I >handler</I ></TT > is a string containing the name of a function that must exist when <A HREF="function.xml-parse.html" ><B CLASS="function" >xml_parse()</B ></A > is called for <TT CLASS="parameter" ><I >parser</I ></TT >. </P ><P > The function named by <TT CLASS="parameter" ><I >handler</I ></TT > must accept five parameters, and should return an integer value. If the value returned from the handler is <TT CLASS="constant" ><B >FALSE</B ></TT > (which it will be if no value is returned), the XML parser will stop parsing and <A HREF="function.xml-get-error-code.html" ><B CLASS="function" >xml_get_error_code()</B ></A > will return <SPAN CLASS="systemitem" >XML_ERROR_EXTERNAL_ENTITY_HANDLING</SPAN >. <B CLASS="methodname" ><TT CLASS="replaceable" ><I >handler</I ></TT ></B > ( resource parser, string open_entity_names, string base, string system_id, string public_id)<BR ></BR > <P ></P ><DIV CLASS="variablelist" ><DL ><DT ><TT CLASS="parameter" ><I >parser</I ></TT ></DT ><DD ><P > The first parameter, <TT CLASS="replaceable" ><I >parser</I ></TT >, is a reference to the XML parser calling the handler. </P ></DD ><DT ><TT CLASS="parameter" ><I >open_entity_names</I ></TT ></DT ><DD ><P > The second parameter, <TT CLASS="parameter" ><I >open_entity_names</I ></TT >, 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). </P ></DD ><DT ><TT CLASS="parameter" ><I >base</I ></TT ></DT ><DD ><P > This is the base for resolving the system identifier (<TT CLASS="parameter" ><I >system_id</I ></TT >) of the external entity. Currently this parameter will always be set to an empty string. </P ></DD ><DT ><TT CLASS="parameter" ><I >system_id</I ></TT ></DT ><DD ><P > The fourth parameter, <TT CLASS="parameter" ><I >system_id</I ></TT >, is the system identifier as specified in the entity declaration. </P ></DD ><DT ><TT CLASS="parameter" ><I >public_id</I ></TT ></DT ><DD ><P > The fifth parameter, <TT CLASS="parameter" ><I >public_id</I ></TT >, 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. </P ></DD ></DL ></DIV > </P ><P > If a handler function is set to an empty string, or <TT CLASS="constant" ><B >FALSE</B ></TT >, the handler in question is disabled. </P ><P > <TT CLASS="constant" ><B >TRUE</B ></TT > is returned if the handler is set up, <TT CLASS="constant" ><B >FALSE</B ></TT > if <TT CLASS="parameter" ><I >parser</I ></TT > is not a parser. </P ><DIV CLASS="note" ><BLOCKQUOTE CLASS="note" ><P ><B >Note: </B >Instead of a function name, an array containing an object reference and a method name can also be supplied.</P ></BLOCKQUOTE ></DIV ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="function.xml-set-end-namespace-decl-handler.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="function.xml-set-notation-decl-handler.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >xml_set_end_namespace_decl_handler</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="ref.xml.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >xml_set_notation_decl_handler</TD ></TR ></TABLE ></DIV ></BODY ></HTML >