Update refnames, IDs and methodsynopsis to the new-oo-style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249681 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2008-01-02 13:58:46 +00:00
parent bcb3c2a793
commit 4307023b46
15 changed files with 126 additions and 153 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<reference xml:id="class.mysqli-result" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MySQLi_Result class</title>
<titleabbrev>MySQLi_Result</titleabbrev>
@ -34,7 +34,7 @@
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-result')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis[1])" />
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-result')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[2])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-result')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->

View file

@ -1,19 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-field-tell" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.current-field" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result->current_field</refname>
<refname>mysqli_field_tell</refname>
<refname>result->current_field</refname>
<refpurpose>Get current field offset of a result pointer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_field_tell</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
@ -21,6 +16,11 @@
<type>int</type><varname>current_field</varname>
</fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_field_tell</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns the position of the field cursor used for the last
<function>mysqli_fetch_field</function> call. This value can

View file

@ -1,28 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-data-seek" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.data-seek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::data_seek</refname>
<refname>mysqli_data_seek</refname>
<refname>result->data_seek()</refname>
<refpurpose>Adjusts the result pointer to an arbitary row in the result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_result::data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_data_seek</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
The <function>mysqli_data_seek</function> function seeks to an arbitrary
result pointer specified by the <parameter>offset</parameter> in the

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-array" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.fetch-array" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_array</refname>
<refname>mysqli_fetch_array</refname>
<refname>result->fetch_array()</refname>
<refpurpose>Fetch a result row as an associative, a numeric array, or both</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_resultfetch_array</methodname>
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_fetch_array</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>fetch_array</methodname>
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Returns an array that corresponds to the fetched row or &null; if there
are no more rows for the resultset represented by the

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-assoc" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.fetch-assoc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_assoc</refname>
<refname>mysqli_fetch_assoc</refname>
<refname>mysqli->fetch_assoc()</refname>
<refpurpose>Fetch a result row as an associative array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_result::fetch_assoc</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_fetch_assoc</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>fetch_assoc</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns an associative array that corresponds to the fetched row or &null;
if there are no more rows.

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-field-direct" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result::fetch-field-direct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_field_direct</refname>
<refname>mysqli_fetch_field_direct</refname>
<refname>result->fetch_field_direct()</refname>
<refpurpose>Fetch meta-data for a single field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>object</type><methodname>mysqli_result::fetch_field_direct</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>object</type><methodname>mysqli_fetch_field_direct</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>object</type><methodname>fetch_field_direct</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Returns an object which contains field definition informations from
specified resultset.

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-field" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.fetch-field" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_field</refname>
<refname>mysqli_fetch_field</refname>
<refname>result->fetch_field()</refname>
<refpurpose>Returns the next field in the result set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>object</type><methodname>mysqli_result::fetch_field</methodname>
<void/>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>object</type><methodname>mysqli_fetch_field</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>object</type><methodname>fetch_field</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Returns the definition of one column of a result set as an object. Call
this function repeatedly to retrieve information about all columns in the

View file

@ -1,27 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-fields" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.fetch-fields" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_fields</refname>
<refname>mysqli_fetch_fields</refname>
<refname>result->fetch_fields()</refname>
<refpurpose>Returns an array of objects representing the fields in a result set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_result::fetch_fields</methodname>
<void/>
</methodsynopsis>
<para>Procedural Style:</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_fetch_fields</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>fetch_fields</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
This function serves an identical purpose to the
<function>mysqli_fetch_field</function> function with the single

View file

@ -1,14 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-object" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.fetch-object" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_object</refname>
<refname>mysqli_fetch_object</refname>
<refname>result->fetch_object()</refname>
<refpurpose>Returns the current row of a result set as an object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>object</type><methodname>mysqli_result::fetch_object</methodname>
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>object</type><methodname>mysqli_fetch_object</methodname>
@ -16,15 +22,6 @@
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>object</type><methodname>fetch_object</methodname>
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
The <function>mysqli_fetch_object</function> will return the current row
result set as an object where the attributes of the object represent the

View file

@ -1,27 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-row" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.fetch-row" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_row</refname>
<refname>mysqli_fetch_row</refname>
<refname>result->fetch_row()</refname>
<refpurpose>Get a result row as an enumerated array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_result::fetch_row</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_fetch_row</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>fetch_row</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Fetches one row of data from the result set and returns it as an enumerated
array, where each column is stored in an array offset starting from 0 (zero).

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-num-fields" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.field-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result->field_count</refname>
<refname>mysqli_num_fields</refname>
<refname>result->field_count</refname>
<refpurpose>Get the number of fields in a result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_num_fields</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<fieldsynopsis><type>int</type><varname>field_count</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_num_fields</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of fields from specified result set.
</para>

View file

@ -1,28 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-field-seek" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.field-seek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::field_seek</refname>
<refname>mysqli_field_seek</refname>
<refname>result->field_seek()</refname>
<refpurpose>Set result pointer to a specified field offset</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_result::field_seek</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_field_seek</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>field_seek</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Sets the field cursor to the given offset. The next call to
<function>mysqli_fetch_field</function> will retrieve the field definition

View file

@ -1,35 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-free-result" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.free" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::free</refname>
<refname>mysqli_free_result</refname>
<refname>result->free()</refname>
<refpurpose>Frees the memory associated with a result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (all methods are equivalent):</para>
<methodsynopsis>
<type>void</type><methodname>mysqli_result::free</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>void</type><methodname>mysqli_result::close</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>void</type><methodname>mysqli_result::free_result</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>void</type><methodname>mysqli_free_result</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (all methods are equivalent):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>free</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>void</type><methodname>close</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>void</type><methodname>free_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Frees the memory associated with the result.
</para>

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-fetch-lengths" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.lengths" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result->lengths</refname>
<refname>mysqli_fetch_lengths</refname>
<refname>result->lengths()</refname>
<refpurpose>Returns the lengths of the columns of the current row in the result set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_fetch_lengths</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<fieldsynopsis><type>array</type><varname>lengths</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_fetch_lengths</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
The <function>mysqli_fetch_lengths</function> function returns an array
containing the lengths of every column of the current row within the result

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mysqli-num-rows" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.2 $ -->
<refentry xml:id="mysqli-result.num-rows" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result->num_rows</refname>
<refname>mysqli_num_rows</refname>
<refname>result->num_rows</refname>
<refpurpose>Gets the number of rows in a result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_num_rows</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_result</classname></ooclass>
<fieldsynopsis><type>int</type><varname>num_rows</varname></fieldsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_num_rows</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of rows in the result set.
</para>