cvs: phpdoc /en language-snippets.ent /en/reference/msql/functions msql-affected-rows.xml msql-close.xml msql-connect.xml msql-create-db.xml
msql-data-seek.xml msql-db-query.xml msql-drop-db.xml msql-error.xml msql-fetch-array.xml msql-fetch-field.xml msql-fetch-object.xml
msql-fetch-row.xml msql-field-flags.xml msql-field-len.xml msql-field-name.xml msql-field-seek.xml msql-field-table.xml msql-field-type.xml
msql-free-result.xml msql-list-dbs.xml msql-list-fields.xml msql-list-tables.xml msql-num-fields.xml msql-num-rows.xml msql-pconnect.xml
msql-query.xml msql-result.xml msql-select-db.xml
| From: | Mehdi Achour | Date: | Mon, 04 Apr 2005 22:08:00 +0000 |
| Subject: | cvs: phpdoc /en language-snippets.ent /en/reference/msql/functions msql-affected-rows.xml msql-close.xml msql-connect.xml msql-create-db.xml msql-data-seek.xml msql-db-query.xml msql-drop-db.xml msql-error.xml msql-fetch-array.xml msql-fetch-field.xml msql-fetch-object.xml msql-fetch-row.xml msql-field-flags.xml msql-field-len.xml msql-field-name.xml msql-field-seek.xml msql-field-table.xml msql-field-type.xml msql-free-result.xml msql-list-dbs.xml msql-list-fields.xml msql-list-tables.xml msql-num-fields.xml msql-num-rows.xml msql-pconnect.xml msql-query.xml msql-result.xml msql-select-db.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969367424@lists.php.net to get a copy of this message | ||
didou Mon Apr 4 18:08:00 2005 EDT
Modified files:
/phpdoc/en language-snippets.ent
/phpdoc/en/reference/msql/functions msql-affected-rows.xml
msql-close.xml msql-connect.xml
msql-create-db.xml
msql-data-seek.xml
msql-db-query.xml
msql-drop-db.xml msql-error.xml
msql-fetch-array.xml
msql-fetch-field.xml
msql-fetch-object.xml
msql-fetch-row.xml
msql-field-flags.xml
msql-field-len.xml
msql-field-name.xml
msql-field-seek.xml
msql-field-table.xml
msql-field-type.xml
msql-free-result.xml
msql-list-dbs.xml
msql-list-fields.xml
msql-list-tables.xml
msql-num-fields.xml
msql-num-rows.xml
msql-pconnect.xml
msql-query.xml msql-result.xml
msql-select-db.xml
Log:
Switch the rest of the docs to the new structure. Also :
* Added see also
* Fixed protos
* Integrated user notes
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.143&r2=1.144&ty=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.143 phpdoc/en/language-snippets.ent:1.144 --- phpdoc/en/language-snippets.ent:1.143 Fri Apr 1 21:20:45 2005 +++ phpdoc/en/language-snippets.ent Mon Apr 4 18:07:58 2005 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.143 $ --> +<!-- $Revision: 1.144 $ --> <!-- Keep 'em sorted --> @@ -425,6 +425,25 @@ <!ENTITY database.fetch-null '<note><simpara>This function sets NULL fields to PHP &null; value.</simpara></note>'> +<!-- MSQL Notes --> +<!-- The msql.*.description entities are used in the parameters refsect1 --> +<!ENTITY msql.linkid.description '<varlistentry><term><parameter> +link_identifier</parameter></term><listitem><para>The mSQL connection. +If not specified, the last link opened by <function>msql_connect</function> +is assumed. If no such link is found, the function will try to establish a +link as if <function>msql_connect</function> was called, and use it. +</para></listitem></varlistentry>'> + +<!ENTITY msql.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>msql_query</function>.</para></listitem></varlistentry>'> + +<!ENTITY msql.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>1</literal>.</para></listitem></varlistentry>'> + + <!-- MySQL Notes --> <!-- The mysql.*.description entities are used in the parameters refsect1 --> <!ENTITY mysql.linkid.description '<varlistentry><term><parameter> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-affected-rows.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-affected-rows.xml diff -u phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.4 phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.4 Sun Apr 3 18:53:22 2005 +++ phpdoc/en/reference/msql/functions/msql-affected-rows.xml Mon Apr 4 18:07:59 2005 @@ -1,24 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-affected-rows"> <refnamediv> <refname>msql_affected_rows</refname> <refpurpose>Returns number of affected rows</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_affected_rows</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns number of affected ("touched") rows by a specific query - (i.e. the number of rows returned by a SELECT, the number of rows - modified by an update, or the number of rows removed by a - delete). + Returns number of affected rows by the last SELECT, UPDATE or DELETE + query associated with <parameter>result</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of affected rows on success, or &false; on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_query</function>. + <simplelist> + <member><function>msql_query</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-close.xml diff -u phpdoc/en/reference/msql/functions/msql-close.xml:1.4 phpdoc/en/reference/msql/functions/msql-close.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-close.xml:1.4 Sun Apr 3 18:53:23 2005 +++ phpdoc/en/reference/msql/functions/msql-close.xml Mon Apr 4 18:07:59 2005 @@ -1,38 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-close"> <refnamediv> <refname>msql_close</refname> <refpurpose>Close mSQL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_close</methodname> + <type>bool</type><methodname>msql_close</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_close</function> closes the link to a mSQL - database that's associated with the specified link identifier. - If the link identifier isn't specified, the last opened link is - assumed. + <function>msql_close</function> closes the non-persistent connection to + the mSQL server that's associated with the specified link identifier. </para> <para> - &return.success; + Using <function>msql_close</function> isn't usually necessary, as + non-persistent open links are automatically closed at the end of the + script's execution. See also <link + linkend="language.types.resource.self-destruct">freeing resources</link>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Note that this isn't usually necessary, as non-persistent open - links are automatically closed at the end of the script's - execution. + <variablelist> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>msql_close</function> will not close persistent links - generated by <function>msql_pconnect</function>. + &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: - <function>msql_connect</function> and - <function>msql_pconnect</function>. + <simplelist> + <member><function>msql_connect</function></member> + <member><function>msql_pconnect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-connect.xml?r1=1.13&r2=1.14&ty=u Index: phpdoc/en/reference/msql/functions/msql-connect.xml diff -u phpdoc/en/reference/msql/functions/msql-connect.xml:1.13 phpdoc/en/reference/msql/functions/msql-connect.xml:1.14 --- phpdoc/en/reference/msql/functions/msql-connect.xml:1.13 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-connect.xml Mon Apr 4 18:07:59 2005 @@ -1,49 +1,91 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <refentry id="function.msql-connect"> <refnamediv> <refname>msql_connect</refname> <refpurpose>Open mSQL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_connect</methodname> + <type>resource</type><methodname>msql_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - <function>msql_connect</function> establishes a connection to a - mSQL server. The <parameter>hostname</parameter> parameter can also - include a port number. e.g. "hostname:port". - If the hostname is not specified, the connection is established by the - means of a Unix domain socket, being then more efficient then a localhost - TCP socket connection. - </para> - <note> - <simpara> - While this function will accept a colon (":") as a - host/port separator, a comma (",") is the preferred method. - </simpara> - </note> - <para> - Returns a positive mSQL link identifier on success, or &false; on - error. + <function>msql_connect</function> establishes a connection to a mSQL + server. </para> <para> - In case a second call is made to - <function>msql_connect</function> with the same arguments, no new - link will be established, but instead, the link identifier of the - already opened link will be returned. + In case a second call is made to <function>msql_connect</function> with + the same arguments, no new link will be established, but instead, the + link identifier of the already opened link will be returned. </para> <para> - The link to the server will be closed as soon as the execution of - the script ends, unless it's closed earlier by explicitly calling + The link to the server will be closed as soon as the execution of the + script ends, unless it's closed earlier by explicitly calling <function>msql_close</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also - <function>msql_pconnect</function> and - <function>msql_close</function>. + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The hostname can also include a port number. e.g. + <literal>hostname,port</literal>. + </para> + <para> + If not specified, the connection is established by the means of a Unix + domain socket, being then more efficient then a localhost TCP socket + connection. + </para> + <note> + <para> + While this function will accept a colon (<literal>:</literal>) as a + host/port separator, a comma (<literal>,</literal>) is the preferred + method. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The mSQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The mSQL password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive mSQL link identifier on success, or &false; on + error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_pconnect</function></member> + <member><function>msql_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-create-db.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-create-db.xml diff -u phpdoc/en/reference/msql/functions/msql-create-db.xml:1.5 phpdoc/en/reference/msql/functions/msql-create-db.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-create-db.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-create-db.xml Mon Apr 4 18:07:59 2005 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-create-db"> <refnamediv> <refname>msql_create_db</refname> <refpurpose>Create mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>msql_create_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_create_db</function> attempts to create a new database on the server - associated with the specified <parameter>link_identifier</parameter>. + <function>msql_create_db</function> attempts to create a new database on + the mSQL server. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The name of the mSQL database. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - <para> - See also - <function>msql_drop_db</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_drop_db</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-data-seek.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/msql/functions/msql-data-seek.xml diff -u phpdoc/en/reference/msql/functions/msql-data-seek.xml:1.8 phpdoc/en/reference/msql/functions/msql-data-seek.xml:1.9 --- phpdoc/en/reference/msql/functions/msql-data-seek.xml:1.8 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-data-seek.xml Mon Apr 4 18:07:59 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.msql-data-seek"> <refnamediv> <refname>msql_data_seek</refname> <refpurpose>Move internal row pointer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>msql_data_seek</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>row_number</parameter></methodparam> </methodsynopsis> <para> @@ -19,15 +19,38 @@ to <function>msql_fetch_row</function> would return that row. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>row_number</parameter></term> + <listitem> + <para> + The seeked row number. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_object</function>, - <function>msql_fetch_row</function> and - <function>msql_result</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_fetch_array</function></member> + <member><function>msql_fetch_object</function></member> + <member><function>msql_fetch_row</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-db-query.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-db-query.xml diff -u phpdoc/en/reference/msql/functions/msql-db-query.xml:1.4 phpdoc/en/reference/msql/functions/msql-db-query.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-db-query.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-db-query.xml Mon Apr 4 18:07:59 2005 @@ -1,31 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-db-query"> <refnamediv> <refname>msql_db_query</refname> <refpurpose>Send mSQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_db_query</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> - <para> - Returns a positive mSQL query identifier to the query result, or - &false; on error. - </para> <para> <function>msql_db_query</function> selects a database and executes a query - on it. If the optional <parameter>link_identifier</parameter> - is not specified, the function will try to find an open link to the mSQL - server; if no such link is found it will try to create one as if - <function>msql_connect</function> was called with no arguments. + on it. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The name of the mSQL database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The SQL query. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive mSQL query identifier to the query result, or &false; + on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>msql_connect</function>. + <simplelist> + <member><function>msql_query</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-drop-db.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-drop-db.xml diff -u phpdoc/en/reference/msql/functions/msql-drop-db.xml:1.4 phpdoc/en/reference/msql/functions/msql-drop-db.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-drop-db.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-drop-db.xml Mon Apr 4 18:07:59 2005 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-drop-db"> <refnamediv> <refname>msql_drop_db</refname> <refpurpose>Drop (delete) mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_drop_db</methodname> + <type>bool</type><methodname>msql_drop_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - &return.success; + <function>msql_drop_db</function> attempts to drop (remove) a database + from the mSQL server. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>msql_drop_db</function> attempts to drop (remove) an - entire database from the server associated with the specified - link identifier. + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The name of the database. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_create_db</function>. + <simplelist> + <member><function>msql_create_db</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-error.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/msql/functions/msql-error.xml diff -u phpdoc/en/reference/msql/functions/msql-error.xml:1.6 phpdoc/en/reference/msql/functions/msql-error.xml:1.7 --- phpdoc/en/reference/msql/functions/msql-error.xml:1.6 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-error.xml Mon Apr 4 18:07:59 2005 @@ -1,22 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.msql-error"> <refnamediv> <refname>msql_error</refname> <refpurpose>Returns error message of last msql call</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_error</methodname> <void/> </methodsynopsis> <para> <function>msql_error</function> returns the last issued error by the mSQL - server or an empty string if no error was issued. If no link is - explicitly passed, the last successful open link will be used to retrieve - the error message. Note that only the last error message is accessible - with <function>msql_error</function>. + server. Note that only the last error message is accessible with + <function>msql_error</function>. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The last error message or an empty string if no error was issued. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-array.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-array.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-array.xml:1.7 phpdoc/en/reference/msql/functions/msql-fetch-array.xml:1.8 --- phpdoc/en/reference/msql/functions/msql-fetch-array.xml:1.7 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-array.xml Mon Apr 4 18:07:59 2005 @@ -1,47 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.msql-fetch-array"> <refnamediv> <refname>msql_fetch_array</refname> <refpurpose>Fetch row as array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>msql_fetch_array</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> </methodsynopsis> <para> - Returns an array that corresponds to the fetched row, or &false; if - there are no more rows. - </para> - <para> <function>msql_fetch_array</function> is an extended version of <function>msql_fetch_row</function>. In addition to storing the data in the numeric indices of the result array, it also stores the data in associative indices, using the field names as keys. </para> - <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being - the default. - </para> <para> An important thing to note is that using <function>msql_fetch_array</function> is NOT significantly slower than using <function>msql_fetch_row</function>, while it provides a significant added value. </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>result_type</parameter></term> + <listitem> + <para> + A constant that can take the following values: + <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and + <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being + the default. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that corresponds to the fetched row, or &false; if + there are no more rows. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_fetch_array</function> example</title> @@ -72,12 +83,40 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.11 and 5.0.4 </entry> + <entry> + A bug was fixed when retrieving data from columns containing &null; + values. Such columns were not placed into the resulting array. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_fetch_row</function>, - <function>msql_fetch_object</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. + <simplelist> + <member><function>msql_fetch_row</function></member> + <member><function>msql_fetch_object</function></member> + <member><function>msql_data_seek</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-field.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-field.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-field.xml:1.8 phpdoc/en/reference/msql/functions/msql-fetch-field.xml:1.9 --- phpdoc/en/reference/msql/functions/msql-fetch-field.xml:1.8 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-field.xml Mon Apr 4 18:07:59 2005 @@ -1,48 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.msql-fetch-field"> <refnamediv> <refname>msql_fetch_field</refname> <refpurpose>Get field information</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>msql_fetch_field</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> - <para> - Returns an object containing field information - </para> <para> - <function>msql_fetch_field</function> can be used in order to - obtain information about fields in a certain query result. If - the field offset isn't specified, the next field that wasn't yet - retrieved by <function>msql_fetch_field</function> is retrieved. + <function>msql_fetch_field</function> can be used in order to obtain + information about fields in a certain query result. </para> - <para> - The properties of the object are: + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>field_offset</parameter></term> + <listitem> + <para> + The field offset. If not specified, the next field that wasn't yet + retrieved by <function>msql_fetch_field</function> is retrieved. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object containing field information. The properties of the + object are: <itemizedlist> <listitem> - <simpara> - name - column name - </simpara> + <para> + <property>name</property> - column name + </para> </listitem> <listitem> - <simpara> - table - name of the table the column belongs to - </simpara> + <para> + <property>table</property> - name of the table the column belongs to + </para> </listitem> <listitem> - <simpara> - not_null - 1 if the column cannot be &null; - </simpara> + <para> + <property>not_null</property> - 1 if the column cannot be &null; + </para> </listitem> <listitem> - <simpara> - unique - 1 if the column is a unique key - </simpara> + <para> + <property>unique</property> - 1 if the column is a unique key + </para> </listitem> <listitem> <simpara> @@ -51,8 +67,13 @@ </listitem> </itemizedlist> </para> - <para> - See also <function>msql_field_seek</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_field_seek</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-object.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-object.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-object.xml:1.5 phpdoc/en/reference/msql/functions/msql-fetch-object.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-fetch-object.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-object.xml Mon Apr 4 18:07:59 2005 @@ -1,22 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-fetch-object"> <refnamediv> <refname>msql_fetch_object</refname> <refpurpose>Fetch row as object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>msql_fetch_object</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns an object with properties that correspond to the fetched - row, or &false; if there are no more rows. - </para> - <para> <function>msql_fetch_object</function> is similar to <function>msql_fetch_array</function>, with one difference - an object is returned, instead of an array. Indirectly, that means @@ -24,25 +19,29 @@ their offsets (numbers are illegal property names). </para> <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being - the default. - </para> - <para> Speed-wise, the function is identical to <function>msql_fetch_array</function>, and almost as quick as <function>msql_fetch_row</function> (the difference is insignificant). - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object with properties that correspond to the fetched + row, or &false; if there are no more rows. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_fetch_object</function> example</title> @@ -73,12 +72,40 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.11 and 5.0.4 </entry> + <entry> + A bug was fixed when retrieving data from columns containing &null; + values. Such columns were not placed into the resulting array. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_row</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. + <simplelist> + <member><function>msql_fetch_array</function></member> + <member><function>msql_fetch_row</function></member> + <member><function>msql_data_seek</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-row.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-row.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-row.xml:1.5 phpdoc/en/reference/msql/functions/msql-fetch-row.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-fetch-row.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-row.xml Mon Apr 4 18:07:59 2005 @@ -1,22 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-fetch-row"> <refnamediv> <refname>msql_fetch_row</refname> <refpurpose>Get row as enumerated array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>msql_fetch_row</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns an array that corresponds to the fetched row, or &false; if - there are no more rows. - </para> - <para> <function>msql_fetch_row</function> fetches one row of data from the result associated with the specified query identifier. The row is returned as an array. Each result column is stored in an @@ -27,20 +22,24 @@ return the next row in the result set, or &false; if there are no more rows. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_NUM</constant> being - the default. - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that corresponds to the fetched row, or &false; if + there are no more rows. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_fetch_row</function> example</title> @@ -71,12 +70,40 @@ </programlisting> </example> </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_object</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.11 and 5.0.4 </entry> + <entry> + A bug was fixed when retrieving data from columns containing &null; + values. Such columns were not placed into the resulting array. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_fetch_array</function></member> + <member><function>msql_fetch_object</function></member> + <member><function>msql_data_seek</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-flags.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-flags.xml diff -u phpdoc/en/reference/msql/functions/msql-field-flags.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-flags.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-flags.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-flags.xml Mon Apr 4 18:07:59 2005 @@ -1,21 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-flags"> <refnamediv> <refname>msql_field_flags</refname> <refpurpose>Get field flags</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_field_flags</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> <function>msql_field_flags</function> returns the field flags of - the specified field. Currently this is either, "not &null;", - "primary key", a combination of the two or "" (an empty string). + the specified field. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string containing the field flags of the specified key. + This can be: <literal>primary key not null</literal>, + <literal>not null</literal>, <literal>primary key</literal>, + <literal>unique not null</literal> or <literal>unique</literal>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-len.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-len.xml diff -u phpdoc/en/reference/msql/functions/msql-field-len.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-len.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-len.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-len.xml Mon Apr 4 18:07:59 2005 @@ -1,20 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-len"> <refnamediv> <refname>msql_field_len</refname> <refpurpose>Get field length</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_field_len</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - <function>msql_field_len</function> returns the length of the - specified field or &false; on error. + <function>msql_field_len</function> returns the length of the specified + field. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the length of the specified field or &false; on error. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-name.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-name.xml diff -u phpdoc/en/reference/msql/functions/msql-field-name.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-name.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-name.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-name.xml Mon Apr 4 18:07:59 2005 @@ -1,24 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-name"> <refnamediv> <refname>msql_field_name</refname> - <refpurpose>Get field name</refpurpose> + <refpurpose>Get the name of the specified field in a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_field_name</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - <function>msql_field_name</function> returns the name of the - specified <parameter>field</parameter> from the result resource - <parameter>query_identifier</parameter>. - <literal>msql_field_name($result, 2);</literal> will - return the name of the second field in the result set associated with - the result identifier. + <function>msql_field_name</function> gets the name of the specified field + index. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The name of the field or &false; on failure. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_field_len</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-seek.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-seek.xml diff -u phpdoc/en/reference/msql/functions/msql-field-seek.xml:1.4 phpdoc/en/reference/msql/functions/msql-field-seek.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-field-seek.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-seek.xml Mon Apr 4 18:07:59 2005 @@ -1,27 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-field-seek"> <refnamediv> <refname>msql_field_seek</refname> <refpurpose>Set field offset</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_field_seek</methodname> - <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <type>bool</type><methodname>msql_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - Seeks to the specified field offset. If the next call to - <function>msql_fetch_field</function> won't include a field - offset, this field would be returned. + Seeks to the specified field offset. If the next call to + <function>msql_fetch_field</function> won't include a field offset, this + field would be returned. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns &false; on failure. + &return.success; </para> - <para> - See also: <function>msql_fetch_field</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_fetch_field</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-table.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-table.xml diff -u phpdoc/en/reference/msql/functions/msql-field-table.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-table.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-table.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-table.xml Mon Apr 4 18:07:59 2005 @@ -1,23 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-table"> <refnamediv> <refname>msql_field_table</refname> <refpurpose>Get table name for field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_field_table</methodname> - <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - Returns the name of the table <parameter>field</parameter> was - fetched from. + Returns the name of the table that the specified field is in. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns &false; on failure. + The name of the table on success, or &false; on failure. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-type.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-type.xml diff -u phpdoc/en/reference/msql/functions/msql-field-type.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-type.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-type.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-type.xml Mon Apr 4 18:07:59 2005 @@ -1,25 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-type"> <refnamediv> <refname>msql_field_type</refname> <refpurpose>Get field type</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_field_type</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - <function>msql_field_type</function> is similar to the - <function>msql_field_name</function> function. The arguments are - identical, but the field type is returned. This will be one of - "int", "char" or "real". + <function>msql_field_name</function> gets the type of the specified field + index. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns &false; on failure. + The type of the field. One of <literal>int</literal>, + <literal>char</literal>, <literal>real</literal>, <literal>ident</literal>, + <literal>null</literal> or <literal>unknown</literal>. This functions will + return &false; on failure. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-free-result.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-free-result.xml diff -u phpdoc/en/reference/msql/functions/msql-free-result.xml:1.4 phpdoc/en/reference/msql/functions/msql-free-result.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-free-result.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-free-result.xml Mon Apr 4 18:07:59 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-free-result"> <refnamediv> <refname>msql_free_result</refname> <refpurpose>Free result memory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_free_result</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <type>bool</type><methodname>msql_free_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>msql_free_result</function> frees the memory associated @@ -18,10 +18,19 @@ call this function when you want to make sure you don't use too much memory while the script is running. </para> + </refsect1> +<refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - For downward compatibility, the alias named - <function>msql_freeresult</function> may be used. This, however, is - deprecated and not recommended. + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-list-dbs.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-list-dbs.xml diff -u phpdoc/en/reference/msql/functions/msql-list-dbs.xml:1.4 phpdoc/en/reference/msql/functions/msql-list-dbs.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-list-dbs.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-list-dbs.xml Mon Apr 4 18:07:59 2005 @@ -1,26 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-list-dbs"> <refnamediv> <refname>msql_list_dbs</refname> <refpurpose>List mSQL databases on server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_list_dbs</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_list_dbs</function> will return a result pointer - containing the databases available from the current msql - daemon. Use the <function>msql_result</function> function to - traverse this result pointer. + <function>msql_list_tables</function> lists the databases available on the + specified <parameter>link_identifier</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.linkid.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a result set which may be traversed with any function that fetches + result sets, such as <function>msql_fetch_array</function>. On failure, + this function will return &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For downward compatibility, the alias named - <function>msql_listtables</function> may be used. This, however, is - deprecated and not recommended. + <simplelist> + <member><function>msql_list_tables</function></member> + <member><function>msql_list_fields</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-list-fields.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-list-fields.xml diff -u phpdoc/en/reference/msql/functions/msql-list-fields.xml:1.4 phpdoc/en/reference/msql/functions/msql-list-fields.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-list-fields.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-list-fields.xml Mon Apr 4 18:07:59 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-list-fields"> <refnamediv> <refname>msql_list_fields</refname> <refpurpose>List result fields</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_list_fields</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> @@ -14,18 +14,48 @@ <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_list_fields</function> retrieves information about - the given <parameter>tablename</parameter>. The returned result set can - be traversed with any function that fetches result sets, such as - <function>msql_fetch_array</function>. + <function>msql_list_fields</function> returns information about the given table. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function returns &false; on failure. + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The name of the database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tablename</parameter></term> + <listitem> + <para> + The name of the table. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a result set which may be traversed with any function that fetches + result sets, such as <function>msql_fetch_array</function>. On failure, + this function will return &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For downward compatibility, the alias named - <function>msql_listfields</function> may be used. This, however, is - deprecated and not recommended. + <simplelist> + <member><function>msql_list_tables</function></member> + <member><function>msql_list_dbs</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-list-tables.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-list-tables.xml diff -u phpdoc/en/reference/msql/functions/msql-list-tables.xml:1.5 phpdoc/en/reference/msql/functions/msql-list-tables.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-list-tables.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-list-tables.xml Mon Apr 4 18:07:59 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-list-tables"> <refnamediv> <refname>msql_list_tables</refname> <refpurpose>List tables in an mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_list_tables</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> @@ -14,17 +14,40 @@ </methodsynopsis> <para> <function>msql_list_tables</function> lists the tables on the specified - <parameter>database</parameter>. It returns a result set which may be - traversed with any function that fetches result sets, such as - <function>msql_fetch_array</function>. + <parameter>database</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function returns &false; on failure. + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The name of the database. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a result set which may be traversed with any function that fetches + result sets, such as <function>msql_fetch_array</function>. On failure, + this function will return &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For downward compatibility, the alias named - <function>msql_listtables</function> may be used. This, however, is - deprecated and not recommended. + <simplelist> + <member><function>msql_list_fields</function></member> + <member><function>msql_list_dbs</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-num-fields.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-num-fields.xml diff -u phpdoc/en/reference/msql/functions/msql-num-fields.xml:1.5 phpdoc/en/reference/msql/functions/msql-num-fields.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-num-fields.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-num-fields.xml Mon Apr 4 18:07:59 2005 @@ -1,29 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-num-fields"> <refnamediv> <refname>msql_num_fields</refname> <refpurpose>Get number of fields in result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_num_fields</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>msql_num_fields</function> returns the number of fields in a result set. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downwards compatibility, the alias named - <function>msql_numfields</function> may be used. This, however, is - deprecated and not recommended. + <variablelist> + &msql.result.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of fields in the result set. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_query</function>, - <function>msql_fetch_field</function>, and - <function>msql_num_rows</function>. + <simplelist> + <member><function>msql_query</function></member> + <member><function>msql_fetch_field</function></member> + <member><function>msql_num_rows</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-num-rows.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/msql/functions/msql-num-rows.xml diff -u phpdoc/en/reference/msql/functions/msql-num-rows.xml:1.6 phpdoc/en/reference/msql/functions/msql-num-rows.xml:1.7 --- phpdoc/en/reference/msql/functions/msql-num-rows.xml:1.6 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-num-rows.xml Mon Apr 4 18:07:59 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.msql-num-rows"> <refnamediv> <refname>msql_num_rows</refname> <refpurpose>Get number of rows in result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_num_rows</methodname> <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> @@ -15,14 +15,27 @@ <function>msql_num_rows</function> returns the number of rows in a result set. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downwards compatibility, the alias named - <function>msql_numrows</function> may be used. This, however is - deprecated and not recommended. + <variablelist> + &msql.result.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of rows in the result set. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_db_query</function> and - <function>msql_query</function>. + <simplelist> + <member><function>msql_num_fields</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-pconnect.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-pconnect.xml diff -u phpdoc/en/reference/msql/functions/msql-pconnect.xml:1.5 phpdoc/en/reference/msql/functions/msql-pconnect.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-pconnect.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-pconnect.xml Mon Apr 4 18:07:59 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-pconnect"> <refnamediv> <refname>msql_pconnect</refname> <refpurpose>Open persistent mSQL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_pconnect</methodname> - <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> @@ -18,20 +18,76 @@ <function>msql_connect</function> with two major differences. </para> <para> - First, when connecting, the function would first try to - find a (persistent) link that's already open with the same host. - If one is found, an identifier for it will be returned instead of - opening a new connection. + First, when connecting, the function would first try to find a + (persistent) link that's already open with the same host. + If one is found, an identifier for it will be returned instead of opening + a new connection. </para> <para> - Second, the connection to the SQL server will not be closed when - the execution of the script ends. Instead, the link will remain - open for future use (<function>msql_close</function> will not - close links established by <function>msql_pconnect</function>). + Second, the connection to the SQL server will not be closed when the + execution of the script ends. Instead, the link will remain open for + future use (<function>msql_close</function> will not close links + established by this function). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The hostname can also include a port number. e.g. + <literal>hostname,port</literal>. + </para> + <para> + If not specified, the connection is established by the means of a Unix + domain socket, being then more efficient then a localhost TCP socket + connection. + </para> + <note> + <simpara> + While this function will accept a colon (<literal>:</literal>) as a + host/port separator, a comma (<literal>,</literal>) is the preferred + method. + </simpara> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The mSQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The mSQL password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive mSQL link identifier on success, or &false; on + error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Returns a positive mSQL persistent link identifier on success, or - &false; on error. + <simplelist> + <member><function>msql_connect</function></member> + <member><function>msql_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-query.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/msql/functions/msql-query.xml diff -u phpdoc/en/reference/msql/functions/msql-query.xml:1.6 phpdoc/en/reference/msql/functions/msql-query.xml:1.7 --- phpdoc/en/reference/msql/functions/msql-query.xml:1.6 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-query.xml Mon Apr 4 18:07:59 2005 @@ -1,29 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.msql-query"> <refnamediv> <refname>msql_query</refname> <refpurpose>Send mSQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_query</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_query</function> sends a query to the currently - active database on the server that's associated with the - specified link identifier. If the link identifier isn't - specified, the last opened link is assumed. If no link is open, - the function tries to establish a link as if - <function>msql_connect</function> was called, and use it. + <function>msql_query</function> sends a query to the currently active + database on the server that's associated with the specified link + identifier. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The SQL query. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns a positive mSQL query identifier on success, or &false; on error. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_query</function> example</title> @@ -48,11 +67,15 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_db_query</function>, - <function>msql_select_db</function>, and - <function>msql_connect</function>. + <simplelist> + <member><function>msql_db_query</function></member> + <member><function>msql_select_db</function></member> + <member><function>msql_connect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-result.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-result.xml diff -u phpdoc/en/reference/msql/functions/msql-result.xml:1.4 phpdoc/en/reference/msql/functions/msql-result.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-result.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-result.xml Mon Apr 4 18:07:59 2005 @@ -1,38 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-result"> <refnamediv> <refname>msql_result</refname> <refpurpose>Get result data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_result</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>row</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam> </methodsynopsis> - <para> - Returns the contents of the cell at the row and offset in the - specified mSQL result set. - </para> <para> - <function>msql_result</function> returns the contents of one cell - from a mSQL result set. The field argument can be the field's - offset, or the field's name, or the field's table dot field's - name (fieldname.tablename). If the column name has been aliased - ('select foo as bar from ...'), use the alias instead of the - column name. + <function>msql_result</function> returns the contents of one cell from a + mSQL result set. </para> <para> - When working on large result sets, you should consider using one - of the functions that fetch an entire row (specified below). As - these functions return the contents of multiple cells in one - function call, they are often much quicker than - <function>msql_result</function>. Also, note that specifying a - numeric offset for the field argument is much quicker than - specifying a fieldname or tablename.fieldname argument. + When working on large result sets, you should consider using one of the + functions that fetch an entire row (specified below). As these functions + return the contents of multiple cells in one function call, they are often + much quicker than <function>msql_result</function>. </para> <para> Recommended high-performance alternatives: @@ -40,13 +29,47 @@ <function>msql_fetch_array</function>, and <function>msql_fetch_object</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downward compatibility, the aliases named - <function>msql</function>, <function>msql_tablename</function>, and - <function>msql_dbname</function> may be used. This, however, is - deprecated and not recommended. + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>row</parameter></term> + <listitem> + <para> + The row offset. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's offset, or the field's name, or the field's table + dot field's name (tablename.fieldname.). If the column name has been + aliased ('select foo as bar from ...'), use the alias instead of the + column name. + </para> + <note> + <para> + Specifying a numeric field offset is much quicker than specifying a + fieldname or tablename.fieldname. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the contents of the cell at the row and offset in the + specified mSQL result set. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-select-db.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-select-db.xml diff -u phpdoc/en/reference/msql/functions/msql-select-db.xml:1.5 phpdoc/en/reference/msql/functions/msql-select-db.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-select-db.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-select-db.xml Mon Apr 4 18:07:59 2005 @@ -1,42 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-select-db"> <refnamediv> <refname>msql_select_db</refname> <refpurpose>Select mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>msql_select_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_select_db</function> sets the current active - database on the server that's associated with the specified - <parameter>link_identifier</parameter>. If no link identifier is - specified, the last opened link is assumed. If no link is open, the - function will try to establish a link as if - <function>msql_connect</function> was called, and use it. - </para> - <para> - &return.success; + <function>msql_select_db</function> sets the current active database on + the server that's associated with the specified + <parameter>link_identifier</parameter>. </para> <para> - Subsequent calls to <function>msql_query</function> will be - made on the active database. + Subsequent calls to <function>msql_query</function> will be made on the + active database. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downward compatibility, the alias named - <function>msql_selectdb</function> may be used. This, however, is - deprecated and not recommended. + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The database name. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_connect</function>, - <function>msql_pconnect</function>, and - <function>msql_query</function>. + <simplelist> + <member><function>msql_connect</function></member> + <member><function>msql_pconnect</function></member> + <member><function>msql_query</function></member> + </simplelist> </para> </refsect1> </refentry>
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.143&r2=1.144&ty=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.143 phpdoc/en/language-snippets.ent:1.144 --- phpdoc/en/language-snippets.ent:1.143 Fri Apr 1 21:20:45 2005 +++ phpdoc/en/language-snippets.ent Mon Apr 4 18:07:58 2005 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.143 $ --> +<!-- $Revision: 1.144 $ --> <!-- Keep 'em sorted --> @@ -425,6 +425,25 @@ <!ENTITY database.fetch-null '<note><simpara>This function sets NULL fields to PHP &null; value.</simpara></note>'> +<!-- MSQL Notes --> +<!-- The msql.*.description entities are used in the parameters refsect1 --> +<!ENTITY msql.linkid.description '<varlistentry><term><parameter> +link_identifier</parameter></term><listitem><para>The mSQL connection. +If not specified, the last link opened by <function>msql_connect</function> +is assumed. If no such link is found, the function will try to establish a +link as if <function>msql_connect</function> was called, and use it. +</para></listitem></varlistentry>'> + +<!ENTITY msql.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>msql_query</function>.</para></listitem></varlistentry>'> + +<!ENTITY msql.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>1</literal>.</para></listitem></varlistentry>'> + + <!-- MySQL Notes --> <!-- The mysql.*.description entities are used in the parameters refsect1 --> <!ENTITY mysql.linkid.description '<varlistentry><term><parameter> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-affected-rows.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-affected-rows.xml diff -u phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.4 phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.4 Sun Apr 3 18:53:22 2005 +++ phpdoc/en/reference/msql/functions/msql-affected-rows.xml Mon Apr 4 18:07:59 2005 @@ -1,24 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-affected-rows"> <refnamediv> <refname>msql_affected_rows</refname> <refpurpose>Returns number of affected rows</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_affected_rows</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns number of affected ("touched") rows by a specific query - (i.e. the number of rows returned by a SELECT, the number of rows - modified by an update, or the number of rows removed by a - delete). + Returns number of affected rows by the last SELECT, UPDATE or DELETE + query associated with <parameter>result</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of affected rows on success, or &false; on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_query</function>. + <simplelist> + <member><function>msql_query</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-close.xml diff -u phpdoc/en/reference/msql/functions/msql-close.xml:1.4 phpdoc/en/reference/msql/functions/msql-close.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-close.xml:1.4 Sun Apr 3 18:53:23 2005 +++ phpdoc/en/reference/msql/functions/msql-close.xml Mon Apr 4 18:07:59 2005 @@ -1,38 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-close"> <refnamediv> <refname>msql_close</refname> <refpurpose>Close mSQL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_close</methodname> + <type>bool</type><methodname>msql_close</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_close</function> closes the link to a mSQL - database that's associated with the specified link identifier. - If the link identifier isn't specified, the last opened link is - assumed. + <function>msql_close</function> closes the non-persistent connection to + the mSQL server that's associated with the specified link identifier. </para> <para> - &return.success; + Using <function>msql_close</function> isn't usually necessary, as + non-persistent open links are automatically closed at the end of the + script's execution. See also <link + linkend="language.types.resource.self-destruct">freeing resources</link>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Note that this isn't usually necessary, as non-persistent open - links are automatically closed at the end of the script's - execution. + <variablelist> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>msql_close</function> will not close persistent links - generated by <function>msql_pconnect</function>. + &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: - <function>msql_connect</function> and - <function>msql_pconnect</function>. + <simplelist> + <member><function>msql_connect</function></member> + <member><function>msql_pconnect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-connect.xml?r1=1.13&r2=1.14&ty=u Index: phpdoc/en/reference/msql/functions/msql-connect.xml diff -u phpdoc/en/reference/msql/functions/msql-connect.xml:1.13 phpdoc/en/reference/msql/functions/msql-connect.xml:1.14 --- phpdoc/en/reference/msql/functions/msql-connect.xml:1.13 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-connect.xml Mon Apr 4 18:07:59 2005 @@ -1,49 +1,91 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <refentry id="function.msql-connect"> <refnamediv> <refname>msql_connect</refname> <refpurpose>Open mSQL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_connect</methodname> + <type>resource</type><methodname>msql_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - <function>msql_connect</function> establishes a connection to a - mSQL server. The <parameter>hostname</parameter> parameter can also - include a port number. e.g. "hostname:port". - If the hostname is not specified, the connection is established by the - means of a Unix domain socket, being then more efficient then a localhost - TCP socket connection. - </para> - <note> - <simpara> - While this function will accept a colon (":") as a - host/port separator, a comma (",") is the preferred method. - </simpara> - </note> - <para> - Returns a positive mSQL link identifier on success, or &false; on - error. + <function>msql_connect</function> establishes a connection to a mSQL + server. </para> <para> - In case a second call is made to - <function>msql_connect</function> with the same arguments, no new - link will be established, but instead, the link identifier of the - already opened link will be returned. + In case a second call is made to <function>msql_connect</function> with + the same arguments, no new link will be established, but instead, the + link identifier of the already opened link will be returned. </para> <para> - The link to the server will be closed as soon as the execution of - the script ends, unless it's closed earlier by explicitly calling + The link to the server will be closed as soon as the execution of the + script ends, unless it's closed earlier by explicitly calling <function>msql_close</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also - <function>msql_pconnect</function> and - <function>msql_close</function>. + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The hostname can also include a port number. e.g. + <literal>hostname,port</literal>. + </para> + <para> + If not specified, the connection is established by the means of a Unix + domain socket, being then more efficient then a localhost TCP socket + connection. + </para> + <note> + <para> + While this function will accept a colon (<literal>:</literal>) as a + host/port separator, a comma (<literal>,</literal>) is the preferred + method. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The mSQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The mSQL password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive mSQL link identifier on success, or &false; on + error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_pconnect</function></member> + <member><function>msql_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-create-db.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-create-db.xml diff -u phpdoc/en/reference/msql/functions/msql-create-db.xml:1.5 phpdoc/en/reference/msql/functions/msql-create-db.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-create-db.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-create-db.xml Mon Apr 4 18:07:59 2005 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-create-db"> <refnamediv> <refname>msql_create_db</refname> <refpurpose>Create mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>msql_create_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_create_db</function> attempts to create a new database on the server - associated with the specified <parameter>link_identifier</parameter>. + <function>msql_create_db</function> attempts to create a new database on + the mSQL server. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The name of the mSQL database. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - <para> - See also - <function>msql_drop_db</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_drop_db</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-data-seek.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/msql/functions/msql-data-seek.xml diff -u phpdoc/en/reference/msql/functions/msql-data-seek.xml:1.8 phpdoc/en/reference/msql/functions/msql-data-seek.xml:1.9 --- phpdoc/en/reference/msql/functions/msql-data-seek.xml:1.8 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-data-seek.xml Mon Apr 4 18:07:59 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.msql-data-seek"> <refnamediv> <refname>msql_data_seek</refname> <refpurpose>Move internal row pointer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>msql_data_seek</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>row_number</parameter></methodparam> </methodsynopsis> <para> @@ -19,15 +19,38 @@ to <function>msql_fetch_row</function> would return that row. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>row_number</parameter></term> + <listitem> + <para> + The seeked row number. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_object</function>, - <function>msql_fetch_row</function> and - <function>msql_result</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_fetch_array</function></member> + <member><function>msql_fetch_object</function></member> + <member><function>msql_fetch_row</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-db-query.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-db-query.xml diff -u phpdoc/en/reference/msql/functions/msql-db-query.xml:1.4 phpdoc/en/reference/msql/functions/msql-db-query.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-db-query.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-db-query.xml Mon Apr 4 18:07:59 2005 @@ -1,31 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-db-query"> <refnamediv> <refname>msql_db_query</refname> <refpurpose>Send mSQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_db_query</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> - <para> - Returns a positive mSQL query identifier to the query result, or - &false; on error. - </para> <para> <function>msql_db_query</function> selects a database and executes a query - on it. If the optional <parameter>link_identifier</parameter> - is not specified, the function will try to find an open link to the mSQL - server; if no such link is found it will try to create one as if - <function>msql_connect</function> was called with no arguments. + on it. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The name of the mSQL database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The SQL query. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive mSQL query identifier to the query result, or &false; + on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>msql_connect</function>. + <simplelist> + <member><function>msql_query</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-drop-db.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-drop-db.xml diff -u phpdoc/en/reference/msql/functions/msql-drop-db.xml:1.4 phpdoc/en/reference/msql/functions/msql-drop-db.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-drop-db.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-drop-db.xml Mon Apr 4 18:07:59 2005 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-drop-db"> <refnamediv> <refname>msql_drop_db</refname> <refpurpose>Drop (delete) mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_drop_db</methodname> + <type>bool</type><methodname>msql_drop_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - &return.success; + <function>msql_drop_db</function> attempts to drop (remove) a database + from the mSQL server. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>msql_drop_db</function> attempts to drop (remove) an - entire database from the server associated with the specified - link identifier. + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The name of the database. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_create_db</function>. + <simplelist> + <member><function>msql_create_db</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-error.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/msql/functions/msql-error.xml diff -u phpdoc/en/reference/msql/functions/msql-error.xml:1.6 phpdoc/en/reference/msql/functions/msql-error.xml:1.7 --- phpdoc/en/reference/msql/functions/msql-error.xml:1.6 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-error.xml Mon Apr 4 18:07:59 2005 @@ -1,22 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.msql-error"> <refnamediv> <refname>msql_error</refname> <refpurpose>Returns error message of last msql call</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_error</methodname> <void/> </methodsynopsis> <para> <function>msql_error</function> returns the last issued error by the mSQL - server or an empty string if no error was issued. If no link is - explicitly passed, the last successful open link will be used to retrieve - the error message. Note that only the last error message is accessible - with <function>msql_error</function>. + server. Note that only the last error message is accessible with + <function>msql_error</function>. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The last error message or an empty string if no error was issued. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-array.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-array.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-array.xml:1.7 phpdoc/en/reference/msql/functions/msql-fetch-array.xml:1.8 --- phpdoc/en/reference/msql/functions/msql-fetch-array.xml:1.7 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-array.xml Mon Apr 4 18:07:59 2005 @@ -1,47 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.msql-fetch-array"> <refnamediv> <refname>msql_fetch_array</refname> <refpurpose>Fetch row as array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>msql_fetch_array</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> </methodsynopsis> <para> - Returns an array that corresponds to the fetched row, or &false; if - there are no more rows. - </para> - <para> <function>msql_fetch_array</function> is an extended version of <function>msql_fetch_row</function>. In addition to storing the data in the numeric indices of the result array, it also stores the data in associative indices, using the field names as keys. </para> - <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being - the default. - </para> <para> An important thing to note is that using <function>msql_fetch_array</function> is NOT significantly slower than using <function>msql_fetch_row</function>, while it provides a significant added value. </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>result_type</parameter></term> + <listitem> + <para> + A constant that can take the following values: + <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and + <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being + the default. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that corresponds to the fetched row, or &false; if + there are no more rows. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_fetch_array</function> example</title> @@ -72,12 +83,40 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.11 and 5.0.4 </entry> + <entry> + A bug was fixed when retrieving data from columns containing &null; + values. Such columns were not placed into the resulting array. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_fetch_row</function>, - <function>msql_fetch_object</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. + <simplelist> + <member><function>msql_fetch_row</function></member> + <member><function>msql_fetch_object</function></member> + <member><function>msql_data_seek</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-field.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-field.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-field.xml:1.8 phpdoc/en/reference/msql/functions/msql-fetch-field.xml:1.9 --- phpdoc/en/reference/msql/functions/msql-fetch-field.xml:1.8 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-field.xml Mon Apr 4 18:07:59 2005 @@ -1,48 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.msql-fetch-field"> <refnamediv> <refname>msql_fetch_field</refname> <refpurpose>Get field information</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>msql_fetch_field</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> - <para> - Returns an object containing field information - </para> <para> - <function>msql_fetch_field</function> can be used in order to - obtain information about fields in a certain query result. If - the field offset isn't specified, the next field that wasn't yet - retrieved by <function>msql_fetch_field</function> is retrieved. + <function>msql_fetch_field</function> can be used in order to obtain + information about fields in a certain query result. </para> - <para> - The properties of the object are: + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>field_offset</parameter></term> + <listitem> + <para> + The field offset. If not specified, the next field that wasn't yet + retrieved by <function>msql_fetch_field</function> is retrieved. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object containing field information. The properties of the + object are: <itemizedlist> <listitem> - <simpara> - name - column name - </simpara> + <para> + <property>name</property> - column name + </para> </listitem> <listitem> - <simpara> - table - name of the table the column belongs to - </simpara> + <para> + <property>table</property> - name of the table the column belongs to + </para> </listitem> <listitem> - <simpara> - not_null - 1 if the column cannot be &null; - </simpara> + <para> + <property>not_null</property> - 1 if the column cannot be &null; + </para> </listitem> <listitem> - <simpara> - unique - 1 if the column is a unique key - </simpara> + <para> + <property>unique</property> - 1 if the column is a unique key + </para> </listitem> <listitem> <simpara> @@ -51,8 +67,13 @@ </listitem> </itemizedlist> </para> - <para> - See also <function>msql_field_seek</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_field_seek</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-object.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-object.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-object.xml:1.5 phpdoc/en/reference/msql/functions/msql-fetch-object.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-fetch-object.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-object.xml Mon Apr 4 18:07:59 2005 @@ -1,22 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-fetch-object"> <refnamediv> <refname>msql_fetch_object</refname> <refpurpose>Fetch row as object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>msql_fetch_object</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns an object with properties that correspond to the fetched - row, or &false; if there are no more rows. - </para> - <para> <function>msql_fetch_object</function> is similar to <function>msql_fetch_array</function>, with one difference - an object is returned, instead of an array. Indirectly, that means @@ -24,25 +19,29 @@ their offsets (numbers are illegal property names). </para> <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being - the default. - </para> - <para> Speed-wise, the function is identical to <function>msql_fetch_array</function>, and almost as quick as <function>msql_fetch_row</function> (the difference is insignificant). - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object with properties that correspond to the fetched + row, or &false; if there are no more rows. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_fetch_object</function> example</title> @@ -73,12 +72,40 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.11 and 5.0.4 </entry> + <entry> + A bug was fixed when retrieving data from columns containing &null; + values. Such columns were not placed into the resulting array. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_row</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. + <simplelist> + <member><function>msql_fetch_array</function></member> + <member><function>msql_fetch_row</function></member> + <member><function>msql_data_seek</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-fetch-row.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-fetch-row.xml diff -u phpdoc/en/reference/msql/functions/msql-fetch-row.xml:1.5 phpdoc/en/reference/msql/functions/msql-fetch-row.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-fetch-row.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-fetch-row.xml Mon Apr 4 18:07:59 2005 @@ -1,22 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-fetch-row"> <refnamediv> <refname>msql_fetch_row</refname> <refpurpose>Get row as enumerated array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>msql_fetch_row</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns an array that corresponds to the fetched row, or &false; if - there are no more rows. - </para> - <para> <function>msql_fetch_row</function> fetches one row of data from the result associated with the specified query identifier. The row is returned as an array. Each result column is stored in an @@ -27,20 +22,24 @@ return the next row in the result set, or &false; if there are no more rows. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_NUM</constant> being - the default. - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that corresponds to the fetched row, or &false; if + there are no more rows. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_fetch_row</function> example</title> @@ -71,12 +70,40 @@ </programlisting> </example> </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_object</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.11 and 5.0.4 </entry> + <entry> + A bug was fixed when retrieving data from columns containing &null; + values. Such columns were not placed into the resulting array. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_fetch_array</function></member> + <member><function>msql_fetch_object</function></member> + <member><function>msql_data_seek</function></member> + <member><function>msql_result</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-flags.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-flags.xml diff -u phpdoc/en/reference/msql/functions/msql-field-flags.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-flags.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-flags.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-flags.xml Mon Apr 4 18:07:59 2005 @@ -1,21 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-flags"> <refnamediv> <refname>msql_field_flags</refname> <refpurpose>Get field flags</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_field_flags</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> <function>msql_field_flags</function> returns the field flags of - the specified field. Currently this is either, "not &null;", - "primary key", a combination of the two or "" (an empty string). + the specified field. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string containing the field flags of the specified key. + This can be: <literal>primary key not null</literal>, + <literal>not null</literal>, <literal>primary key</literal>, + <literal>unique not null</literal> or <literal>unique</literal>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-len.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-len.xml diff -u phpdoc/en/reference/msql/functions/msql-field-len.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-len.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-len.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-len.xml Mon Apr 4 18:07:59 2005 @@ -1,20 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-len"> <refnamediv> <refname>msql_field_len</refname> <refpurpose>Get field length</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_field_len</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - <function>msql_field_len</function> returns the length of the - specified field or &false; on error. + <function>msql_field_len</function> returns the length of the specified + field. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the length of the specified field or &false; on error. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-name.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-name.xml diff -u phpdoc/en/reference/msql/functions/msql-field-name.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-name.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-name.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-name.xml Mon Apr 4 18:07:59 2005 @@ -1,24 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-name"> <refnamediv> <refname>msql_field_name</refname> - <refpurpose>Get field name</refpurpose> + <refpurpose>Get the name of the specified field in a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_field_name</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - <function>msql_field_name</function> returns the name of the - specified <parameter>field</parameter> from the result resource - <parameter>query_identifier</parameter>. - <literal>msql_field_name($result, 2);</literal> will - return the name of the second field in the result set associated with - the result identifier. + <function>msql_field_name</function> gets the name of the specified field + index. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The name of the field or &false; on failure. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_field_len</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-seek.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-seek.xml diff -u phpdoc/en/reference/msql/functions/msql-field-seek.xml:1.4 phpdoc/en/reference/msql/functions/msql-field-seek.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-field-seek.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-seek.xml Mon Apr 4 18:07:59 2005 @@ -1,27 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-field-seek"> <refnamediv> <refname>msql_field_seek</refname> <refpurpose>Set field offset</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_field_seek</methodname> - <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <type>bool</type><methodname>msql_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - Seeks to the specified field offset. If the next call to - <function>msql_fetch_field</function> won't include a field - offset, this field would be returned. + Seeks to the specified field offset. If the next call to + <function>msql_fetch_field</function> won't include a field offset, this + field would be returned. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns &false; on failure. + &return.success; </para> - <para> - See also: <function>msql_fetch_field</function>. + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>msql_fetch_field</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-table.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-table.xml diff -u phpdoc/en/reference/msql/functions/msql-field-table.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-table.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-table.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-table.xml Mon Apr 4 18:07:59 2005 @@ -1,23 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-table"> <refnamediv> <refname>msql_field_table</refname> <refpurpose>Get table name for field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_field_table</methodname> - <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - Returns the name of the table <parameter>field</parameter> was - fetched from. + Returns the name of the table that the specified field is in. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns &false; on failure. + The name of the table on success, or &false; on failure. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-field-type.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/msql/functions/msql-field-type.xml diff -u phpdoc/en/reference/msql/functions/msql-field-type.xml:1.2 phpdoc/en/reference/msql/functions/msql-field-type.xml:1.3 --- phpdoc/en/reference/msql/functions/msql-field-type.xml:1.2 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-field-type.xml Mon Apr 4 18:07:59 2005 @@ -1,25 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.msql-field-type"> <refnamediv> <refname>msql_field_type</refname> <refpurpose>Get field type</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_field_type</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> - <function>msql_field_type</function> is similar to the - <function>msql_field_name</function> function. The arguments are - identical, but the field type is returned. This will be one of - "int", "char" or "real". + <function>msql_field_name</function> gets the type of the specified field + index. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + &msql.field-offset.req.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns &false; on failure. + The type of the field. One of <literal>int</literal>, + <literal>char</literal>, <literal>real</literal>, <literal>ident</literal>, + <literal>null</literal> or <literal>unknown</literal>. This functions will + return &false; on failure. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-free-result.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-free-result.xml diff -u phpdoc/en/reference/msql/functions/msql-free-result.xml:1.4 phpdoc/en/reference/msql/functions/msql-free-result.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-free-result.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-free-result.xml Mon Apr 4 18:07:59 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-free-result"> <refnamediv> <refname>msql_free_result</refname> <refpurpose>Free result memory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>msql_free_result</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <type>bool</type><methodname>msql_free_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>msql_free_result</function> frees the memory associated @@ -18,10 +18,19 @@ call this function when you want to make sure you don't use too much memory while the script is running. </para> + </refsect1> +<refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.result.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - For downward compatibility, the alias named - <function>msql_freeresult</function> may be used. This, however, is - deprecated and not recommended. + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-list-dbs.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-list-dbs.xml diff -u phpdoc/en/reference/msql/functions/msql-list-dbs.xml:1.4 phpdoc/en/reference/msql/functions/msql-list-dbs.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-list-dbs.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-list-dbs.xml Mon Apr 4 18:07:59 2005 @@ -1,26 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-list-dbs"> <refnamediv> <refname>msql_list_dbs</refname> <refpurpose>List mSQL databases on server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_list_dbs</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_list_dbs</function> will return a result pointer - containing the databases available from the current msql - daemon. Use the <function>msql_result</function> function to - traverse this result pointer. + <function>msql_list_tables</function> lists the databases available on the + specified <parameter>link_identifier</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &msql.linkid.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a result set which may be traversed with any function that fetches + result sets, such as <function>msql_fetch_array</function>. On failure, + this function will return &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For downward compatibility, the alias named - <function>msql_listtables</function> may be used. This, however, is - deprecated and not recommended. + <simplelist> + <member><function>msql_list_tables</function></member> + <member><function>msql_list_fields</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-list-fields.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-list-fields.xml diff -u phpdoc/en/reference/msql/functions/msql-list-fields.xml:1.4 phpdoc/en/reference/msql/functions/msql-list-fields.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-list-fields.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-list-fields.xml Mon Apr 4 18:07:59 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-list-fields"> <refnamediv> <refname>msql_list_fields</refname> <refpurpose>List result fields</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_list_fields</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> @@ -14,18 +14,48 @@ <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_list_fields</function> retrieves information about - the given <parameter>tablename</parameter>. The returned result set can - be traversed with any function that fetches result sets, such as - <function>msql_fetch_array</function>. + <function>msql_list_fields</function> returns information about the given table. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function returns &false; on failure. + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The name of the database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tablename</parameter></term> + <listitem> + <para> + The name of the table. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a result set which may be traversed with any function that fetches + result sets, such as <function>msql_fetch_array</function>. On failure, + this function will return &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For downward compatibility, the alias named - <function>msql_listfields</function> may be used. This, however, is - deprecated and not recommended. + <simplelist> + <member><function>msql_list_tables</function></member> + <member><function>msql_list_dbs</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-list-tables.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-list-tables.xml diff -u phpdoc/en/reference/msql/functions/msql-list-tables.xml:1.5 phpdoc/en/reference/msql/functions/msql-list-tables.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-list-tables.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-list-tables.xml Mon Apr 4 18:07:59 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-list-tables"> <refnamediv> <refname>msql_list_tables</refname> <refpurpose>List tables in an mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_list_tables</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> @@ -14,17 +14,40 @@ </methodsynopsis> <para> <function>msql_list_tables</function> lists the tables on the specified - <parameter>database</parameter>. It returns a result set which may be - traversed with any function that fetches result sets, such as - <function>msql_fetch_array</function>. + <parameter>database</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function returns &false; on failure. + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The name of the database. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a result set which may be traversed with any function that fetches + result sets, such as <function>msql_fetch_array</function>. On failure, + this function will return &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For downward compatibility, the alias named - <function>msql_listtables</function> may be used. This, however, is - deprecated and not recommended. + <simplelist> + <member><function>msql_list_fields</function></member> + <member><function>msql_list_dbs</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-num-fields.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-num-fields.xml diff -u phpdoc/en/reference/msql/functions/msql-num-fields.xml:1.5 phpdoc/en/reference/msql/functions/msql-num-fields.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-num-fields.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-num-fields.xml Mon Apr 4 18:07:59 2005 @@ -1,29 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-num-fields"> <refnamediv> <refname>msql_num_fields</refname> <refpurpose>Get number of fields in result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_num_fields</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>msql_num_fields</function> returns the number of fields in a result set. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downwards compatibility, the alias named - <function>msql_numfields</function> may be used. This, however, is - deprecated and not recommended. + <variablelist> + &msql.result.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of fields in the result set. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_query</function>, - <function>msql_fetch_field</function>, and - <function>msql_num_rows</function>. + <simplelist> + <member><function>msql_query</function></member> + <member><function>msql_fetch_field</function></member> + <member><function>msql_num_rows</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-num-rows.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/msql/functions/msql-num-rows.xml diff -u phpdoc/en/reference/msql/functions/msql-num-rows.xml:1.6 phpdoc/en/reference/msql/functions/msql-num-rows.xml:1.7 --- phpdoc/en/reference/msql/functions/msql-num-rows.xml:1.6 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-num-rows.xml Mon Apr 4 18:07:59 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.msql-num-rows"> <refnamediv> <refname>msql_num_rows</refname> <refpurpose>Get number of rows in result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_num_rows</methodname> <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> @@ -15,14 +15,27 @@ <function>msql_num_rows</function> returns the number of rows in a result set. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downwards compatibility, the alias named - <function>msql_numrows</function> may be used. This, however is - deprecated and not recommended. + <variablelist> + &msql.result.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of rows in the result set. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>msql_db_query</function> and - <function>msql_query</function>. + <simplelist> + <member><function>msql_num_fields</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-pconnect.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-pconnect.xml diff -u phpdoc/en/reference/msql/functions/msql-pconnect.xml:1.5 phpdoc/en/reference/msql/functions/msql-pconnect.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-pconnect.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-pconnect.xml Mon Apr 4 18:07:59 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-pconnect"> <refnamediv> <refname>msql_pconnect</refname> <refpurpose>Open persistent mSQL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>msql_pconnect</methodname> - <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> @@ -18,20 +18,76 @@ <function>msql_connect</function> with two major differences. </para> <para> - First, when connecting, the function would first try to - find a (persistent) link that's already open with the same host. - If one is found, an identifier for it will be returned instead of - opening a new connection. + First, when connecting, the function would first try to find a + (persistent) link that's already open with the same host. + If one is found, an identifier for it will be returned instead of opening + a new connection. </para> <para> - Second, the connection to the SQL server will not be closed when - the execution of the script ends. Instead, the link will remain - open for future use (<function>msql_close</function> will not - close links established by <function>msql_pconnect</function>). + Second, the connection to the SQL server will not be closed when the + execution of the script ends. Instead, the link will remain open for + future use (<function>msql_close</function> will not close links + established by this function). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The hostname can also include a port number. e.g. + <literal>hostname,port</literal>. + </para> + <para> + If not specified, the connection is established by the means of a Unix + domain socket, being then more efficient then a localhost TCP socket + connection. + </para> + <note> + <simpara> + While this function will accept a colon (<literal>:</literal>) as a + host/port separator, a comma (<literal>,</literal>) is the preferred + method. + </simpara> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The mSQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The mSQL password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive mSQL link identifier on success, or &false; on + error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Returns a positive mSQL persistent link identifier on success, or - &false; on error. + <simplelist> + <member><function>msql_connect</function></member> + <member><function>msql_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-query.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/msql/functions/msql-query.xml diff -u phpdoc/en/reference/msql/functions/msql-query.xml:1.6 phpdoc/en/reference/msql/functions/msql-query.xml:1.7 --- phpdoc/en/reference/msql/functions/msql-query.xml:1.6 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-query.xml Mon Apr 4 18:07:59 2005 @@ -1,29 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.msql-query"> <refnamediv> <refname>msql_query</refname> <refpurpose>Send mSQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>msql_query</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_query</function> sends a query to the currently - active database on the server that's associated with the - specified link identifier. If the link identifier isn't - specified, the last opened link is assumed. If no link is open, - the function tries to establish a link as if - <function>msql_connect</function> was called, and use it. + <function>msql_query</function> sends a query to the currently active + database on the server that's associated with the specified link + identifier. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The SQL query. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns a positive mSQL query identifier on success, or &false; on error. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>msql_query</function> example</title> @@ -48,11 +67,15 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_db_query</function>, - <function>msql_select_db</function>, and - <function>msql_connect</function>. + <simplelist> + <member><function>msql_db_query</function></member> + <member><function>msql_select_db</function></member> + <member><function>msql_connect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-result.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/msql/functions/msql-result.xml diff -u phpdoc/en/reference/msql/functions/msql-result.xml:1.4 phpdoc/en/reference/msql/functions/msql-result.xml:1.5 --- phpdoc/en/reference/msql/functions/msql-result.xml:1.4 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-result.xml Mon Apr 4 18:07:59 2005 @@ -1,38 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.msql-result"> <refnamediv> <refname>msql_result</refname> <refpurpose>Get result data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>msql_result</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>row</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam> </methodsynopsis> - <para> - Returns the contents of the cell at the row and offset in the - specified mSQL result set. - </para> <para> - <function>msql_result</function> returns the contents of one cell - from a mSQL result set. The field argument can be the field's - offset, or the field's name, or the field's table dot field's - name (fieldname.tablename). If the column name has been aliased - ('select foo as bar from ...'), use the alias instead of the - column name. + <function>msql_result</function> returns the contents of one cell from a + mSQL result set. </para> <para> - When working on large result sets, you should consider using one - of the functions that fetch an entire row (specified below). As - these functions return the contents of multiple cells in one - function call, they are often much quicker than - <function>msql_result</function>. Also, note that specifying a - numeric offset for the field argument is much quicker than - specifying a fieldname or tablename.fieldname argument. + When working on large result sets, you should consider using one of the + functions that fetch an entire row (specified below). As these functions + return the contents of multiple cells in one function call, they are often + much quicker than <function>msql_result</function>. </para> <para> Recommended high-performance alternatives: @@ -40,13 +29,47 @@ <function>msql_fetch_array</function>, and <function>msql_fetch_object</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downward compatibility, the aliases named - <function>msql</function>, <function>msql_tablename</function>, and - <function>msql_dbname</function> may be used. This, however, is - deprecated and not recommended. + <variablelist> + &msql.result.description; + <varlistentry> + <term><parameter>row</parameter></term> + <listitem> + <para> + The row offset. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's offset, or the field's name, or the field's table + dot field's name (tablename.fieldname.). If the column name has been + aliased ('select foo as bar from ...'), use the alias instead of the + column name. + </para> + <note> + <para> + Specifying a numeric field offset is much quicker than specifying a + fieldname or tablename.fieldname. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the contents of the cell at the row and offset in the + specified mSQL result set. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-select-db.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/msql/functions/msql-select-db.xml diff -u phpdoc/en/reference/msql/functions/msql-select-db.xml:1.5 phpdoc/en/reference/msql/functions/msql-select-db.xml:1.6 --- phpdoc/en/reference/msql/functions/msql-select-db.xml:1.5 Sun Apr 3 18:53:24 2005 +++ phpdoc/en/reference/msql/functions/msql-select-db.xml Mon Apr 4 18:07:59 2005 @@ -1,42 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.msql-select-db"> <refnamediv> <refname>msql_select_db</refname> <refpurpose>Select mSQL database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>msql_select_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - <function>msql_select_db</function> sets the current active - database on the server that's associated with the specified - <parameter>link_identifier</parameter>. If no link identifier is - specified, the last opened link is assumed. If no link is open, the - function will try to establish a link as if - <function>msql_connect</function> was called, and use it. - </para> - <para> - &return.success; + <function>msql_select_db</function> sets the current active database on + the server that's associated with the specified + <parameter>link_identifier</parameter>. </para> <para> - Subsequent calls to <function>msql_query</function> will be - made on the active database. + Subsequent calls to <function>msql_query</function> will be made on the + active database. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For downward compatibility, the alias named - <function>msql_selectdb</function> may be used. This, however, is - deprecated and not recommended. + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The database name. + </para> + </listitem> + </varlistentry> + &msql.linkid.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>msql_connect</function>, - <function>msql_pconnect</function>, and - <function>msql_query</function>. + <simplelist> + <member><function>msql_connect</function></member> + <member><function>msql_pconnect</function></member> + <member><function>msql_query</function></member> + </simplelist> </para> </refsect1> </refentry>