philip Thu Mar 31 02:42:34 2005 EDT
Modified files:
/phpdoc/en language-snippets.ent
Log:
Add entities for MySQL result and required field_offset parameters, and add
<varlisting> to the linkid description. Also add E_WARNING information to
linkid.
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.140&r2=1.141&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.140
phpdoc/en/language-snippets.ent:1.141
--- phpdoc/en/language-snippets.ent:1.140 Wed Mar 30 03:17:03 2005
+++ phpdoc/en/language-snippets.ent Thu Mar 31 02:42:34 2005
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.140 $ -->
+<!-- $Revision: 1.141 $ -->
<!-- Keep 'em sorted -->
@@ -163,6 +163,9 @@
value is measured in bytes. You may also use shorthand notation as described
in <link linkend="faq.using.shorthandbytes">this FAQ</link>.</simpara>'>
+<!ENTITY info.deprecated.alias 'For downward compatibility, the following
+deprecated alias may be used: '>
+
<!-- Returns -->
<!ENTITY return.success 'Returns &true; on success or &false; on failure.'>
@@ -419,11 +422,26 @@
PHP &null; value.</simpara></note>'>
<!-- MySQL Notes -->
-<!ENTITY mysql.linkid.description '<para>The MySQL connection. If the link
-identifier is not specified, the last link opened by
+<!-- The mysql.*.description entities are used in the parameters refsect1 -->
+<!ENTITY mysql.linkid.description '<varlistentry><term><parameter>
+link_identifier</parameter></term><listitem><para>The MySQL connection. If the
+link identifier is not specified, the last link opened by
<function>mysql_connect</function> is assumed. If no such link is found, it
will try to create one as if <function>mysql_connect</function> was called
-with no arguments.</para>'>
+with no arguments. If by chance no connection is found or established, an
+<constant>E_WARNING</constant> level warning is generated.</para></listitem>
+</varlistentry>'>
+
+<!ENTITY mysql.result.description '<varlistentry><term><parameter>
+result</parameter></term><listitem><para>The result <type>resource</type> that
+is being evaluated. This result comes from a call to
+<function>mysql_query</function>.</para></listitem></varlistentry>'>
+
+<!ENTITY mysql.field-offset.req.description '<varlistentry><term><parameter>
+field_offset</parameter></term><listitem><para>The numerical field offset. The
+<parameter>field_offset</parameter> starts at <literal>0</literal>. If
+<parameter>field_offset</parameter> does not exist, an error of level
+<constant>E_WARNING</constant> is also
issued.</para></listitem></varlistentry>'>
<!-- Sybase Notes -->
<!ENTITY sybase.ct.only '<note><simpara>This function is only available using
