<HTML
><HEAD
><TITLE
>xml_set_external_entity_ref_handler</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="XML parser functions"
HREF="ref.xml.html"><LINK
REL="PREVIOUS"
TITLE="xml_set_notation_decl_handler"
HREF="function.xml-set-notation-decl-handler.html"><LINK
REL="NEXT"
TITLE="xml_parse"
HREF="function.xml-parse.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><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-notation-decl-handler.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.xml-parse.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.xml-set-external-entity-ref-handler"
>xml_set_external_entity_ref_handler</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN28597"
></A
>xml_set_external_entity_ref_handler -- set up external entity reference handler</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN28600"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><P
></P
><CODE
CLASS="FUNCDEF"
>int
xml_set_external_entity_ref_handler
</CODE
>(int parser, string handler);<P
></P
></DIV
><P
> Sets the notation declaration 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 false (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
>.
<DIV
CLASS="funcsynopsis"
><P
></P
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="replaceable"
><I
>handler</I
></TT
></CODE
>(int parser, string
openEntityNames
, string base, string systemId, string publicId);<P
></P
></DIV
>
<P
></P
><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
>openEntityNames</I
></TT
></DT
><DD
><P
> The second parameter, <TT
CLASS="parameter"
><I
>openEntityNames</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
>systemid</I
></TT
>) of the external entity.
Currently this parameter will always be set to an empty
string.
</P
></DD
><DT
><TT
CLASS="parameter"
><I
>systemId</I
></TT
></DT
><DD
><P
> The fourth parameter, <TT
CLASS="parameter"
><I
>systemId</I
></TT
>, is the
system identifier as specified in the entity declaration.
</P
></DD
><DT
><TT
CLASS="parameter"
><I
>publicId</I
></TT
></DT
><DD
><P
> The fifth parameter, <TT
CLASS="parameter"
><I
>publicId</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
>
</P
><P
> If a handler function is set to an empty string, or
<TT
CLASS="literal"
>false</TT
>, the handler in question is
disabled.
</P
><P
> True is returned if the handler is set up, false if
<TT
CLASS="parameter"
><I
>parser</I
></TT
> is not a parser.
</P
><P
> There is currently no support for object/method handlers.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.xml-set-notation-decl-handler.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.xml-parse.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>xml_set_notation_decl_handler</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.xml.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>xml_parse</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
