File: function.xml-set-external-entity-ref-handler.html

package info (click to toggle)
php3 3%3A3.0.18-31
links: PTS
area: main
in suites: sarge
size: 17,860 kB
ctags: 11,260
sloc: ansic: 108,487; sh: 2,439; php: 2,024; yacc: 1,887; makefile: 1,056; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (377 lines) | stat: -rw-r--r-- 5,525 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>xml_set_external_entity_ref_handler</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><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"><META
NAME="HTTP_EQUIV"
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
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="AEN40049"
></A
><P
>    (PHP3 &#62;= 3.0.6, PHP4 )</P
>xml_set_external_entity_ref_handler&nbsp;--&nbsp;set up external entity reference handler</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN40052"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN40054"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int 
       <B
CLASS="function"
>xml_set_external_entity_ref_handler</B
>
      </CODE
> (int parser, string handler)</CODE
></P
><P
></P
></DIV
><P
>&#13;     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
>&#13;     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"
><A
NAME="AEN40071"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="replaceable"
><I
>handler</I
></TT
></CODE
> (int parser, string
        openEntityNames, string base, string systemId, string publicId)</CODE
></P
><P
></P
></DIV
>
     <P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><TT
CLASS="parameter"
><I
>parser</I
></TT
></DT
><DD
><P
>&#13;	 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
>&#13;	 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
>&#13;	 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
>&#13;	 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
>&#13;	 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
></DIV
>
    </P
><P
>&#13;     If a handler function is set to an empty string, or
     <TT
CLASS="literal"
>false</TT
>, the handler in question is
     disabled.
    </P
><P
>&#13;     True is returned if the handler is set up, false if
     <TT
CLASS="parameter"
><I
>parser</I
></TT
> is not a parser.
    </P
><P
>&#13;     There is currently no support for object/method handlers.  See
     <A
HREF="function.xml-set-object.html"
><B
CLASS="function"
>xml_set_object()</B
></A
> for using the XML parser
     within an object.
    </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
>