CVS update: php3/doc/functions

Date: Friday October 30, 1998 @ 17:48 Author: ssb Update of /repository/php3/doc/functions In directory asf:/u2/tmp/cvs-serv7607 Modified Files: xml.sgml Log Message: filled in some missing parts Index: php3/doc/functions/xml.sgml diff -c php3/doc/functions/xml.sgml:1.17 php3/doc/functions/xml.sgml:1.18 *** php3/doc/functions/xml.sgml:1.17 Fri Oct 30 12:44:08 1998 --- php3/doc/functions/xml.sgml Fri Oct 30 17:48:40 1998 *************** *** 668,674 **** If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 668,674 ---- If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handlers are set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. *************** *** 720,726 **** If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 720,726 ---- If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handler is set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. *************** *** 790,796 **** If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 790,796 ---- If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handler is set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. *************** *** 844,850 **** If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 844,850 ---- If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handler is set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. *************** *** 871,876 **** --- 871,890 ---- a function that must exist when <function>xml_parse</function> is called for <parameter>parser</parameter>. <para> + This handler will be called if the XML parser encounters an + external entity declaration with an NDATA declaration, like the + following: + <programlisting role=xml>&lt;!ENTITY <parameter>name</parameter + > {<parameter>publicId</parameter + > | <parameter>systemId</parameter + >} NDATA <parameter>notationName</parameter + >&gt;</programlisting> + <para> + See <ulink + url="&url.rec-xml;#sec-external-ent">section 4.2.2 of the XML 1.0 + spec</ulink> for the definition of notation declared external + entities. + <para> The function named by <parameter>handler</parameter> must accept six parameters: <funcsynopsis> *************** *** 882,892 **** <paramdef>string <parameter>publicId</parameter></paramdef> <paramdef>string <parameter>notationName</parameter></paramdef> </funcsynopsis> <para> If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 896,943 ---- <paramdef>string <parameter>publicId</parameter></paramdef> <paramdef>string <parameter>notationName</parameter></paramdef> </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem><simpara> + The first parameter, <replaceable>parser</replaceable>, is a + reference to the XML parser calling the handler. + </varlistentry> + <varlistentry> + <term><parameter>entityName</parameter></term> + <listitem><simpara> + The name of the entity that is about to be defined. + </varlistentry> + <varlistentry> + <term><parameter>base</parameter></term> + <listitem><simpara> + This is the base for resolving the system identifier + (<parameter>systemId</parameter>) of the external + entity. Currently this parameter will always be set to + an empty string. + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem><simpara> + System identifier for the external entity. + </varlistentry> + <varlistentry> + <term><parameter>publicId</parameter></term> + <listitem><simpara> + Public identifier for the external entity. + </varlistentry> + <varlistentry> + <term><parameter>notationName</parameter></term> + <listitem><simpara> + Name of the notation of this entity (see + <function>xml_set_notation_decl_handler</function>). + </varlistentry> + </variablelist> <para> If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handler is set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. *************** *** 913,918 **** --- 964,979 ---- <function>xml_parse</function> is called for <parameter>parser</parameter>. <para> + A notation declaration is part of the document's DTD and has the + following format: + <programlisting role=xml + >&lt;!NOTATION <parameter>name</parameter + > {<parameter>systemId</parameter + > | <parameter>publicId</parameter + >}&gt;</programlisting> + See <ulink url="&url.rec-xml;#Notations">section 4.7 of the XML + 1.0 spec</ulink> for the definition of notation declarations. + <para> The function named by <parameter>handler</parameter> must accept five parameters: <funcsynopsis> *************** *** 923,933 **** <paramdef>string <parameter>systemId</parameter></paramdef> <paramdef>string <parameter>publicId</parameter></paramdef> </funcsynopsis> <para> If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 984,1026 ---- <paramdef>string <parameter>systemId</parameter></paramdef> <paramdef>string <parameter>publicId</parameter></paramdef> </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem><simpara> + The first parameter, <replaceable>parser</replaceable>, is a + reference to the XML parser calling the handler. + </varlistentry> + <varlistentry> + <term><parameter>notationName</parameter></term> + <listitem><simpara> + This is the notation's <parameter>name</parameter>, as per + the notation format described above. + </varlistentry> + <varlistentry> + <term><parameter>base</parameter></term> + <listitem><simpara> + This is the base for resolving the system identifier + (<parameter>systemId</parameter>) of the notation + declaration. Currently this parameter will always be set to + an empty string. + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem><simpara> + System identifier of the external notation declaration. + </varlistentry> + <varlistentry> + <term><parameter>publicId</parameter></term> + <listitem><simpara> + Public identifier of the external notation declaration. + </varlistentry> + </variablelist> <para> If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handler is set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. *************** *** 987,998 **** <varlistentry> <term><parameter>base</parameter></term> <listitem><simpara> ! The third parameter, <parameter>base</parameter>, is ! currently reserved for future use. It should be the system ! identifier that should be used as the base for resolving ! <parameter>systemId</parameter> if systemId was relative. ! <!-- XXX this is set by xml_set_base --> ! This parameter may be an empty string. </varlistentry> <varlistentry> <term><parameter>systemId</parameter></term> --- 1080,1089 ---- <varlistentry> <term><parameter>base</parameter></term> <listitem><simpara> ! This is the base for resolving the system identifier ! (<parameter>systemid</parameter>) of the external entity. ! Currently this parameter will always be set to an empty ! string. </varlistentry> <varlistentry> <term><parameter>systemId</parameter></term> *************** *** 1013,1019 **** If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned on success, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. --- 1104,1110 ---- If a handler function is set to an empty string, or <literal>false</literal>, the handler in question is disabled. <para> ! True is returned if the handler is set up, false if <parameter>parser</parameter> is not a parser. <para> There is currently no support for object/method handlers. -- PHP Development Mailing List http://www.php.net/ To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net For help: php-dev-help@lists.php.net