File: ingres-fetch-array.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (144 lines) | stat: -rw-r--r-- 3,919 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.ingres-fetch-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ingres_fetch_array</refname>
  <refpurpose>Fetch a row of result into an array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>ingres_fetch_array</methodname>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function is an extended version of
   <function>ingres_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>
   If two or more columns of the result have the same field names,
   the last column will take precedence. To access the other
   column(s) of the same name, you must use the numeric index of the
   column or make an alias for the column.
   <informalexample>
    <programlisting role="php">
<![CDATA[
<?php

ingres_query("select t1.f1 as foo t2.f1 as bar from t1, t2");
$result = ingres_fetch_array();
$foo = $result["foo"];
$bar = $result["bar"];

?>
]]>
    </programlisting>
   </informalexample>
  </para>
  <para>
   Speed-wise, the function is identical to
   <function>ingres_fetch_object</function>, and almost as quick as
   <function>ingres_fetch_row</function> (the difference is
   insignificant).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result_type</parameter></term>
     <listitem>
      <para>
       <parameter>result_type</parameter> can be INGRES_NUM for
       enumerated array, INGRES_ASSOC for associative array, or
       INGRES_BOTH (default).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       The connection link identifier. If not specified, the last opened link
       is used.
      </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>ingres_fetch_array</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
ingres_connect($database, $user, $password);

ingres_query("select * from table");
while ($row = ingres_fetch_array()) {
    echo $row["user_id"];  // using associative array
    echo $row["fullname"];
    echo $row[1];          // using enumerated array
    echo $row[2];
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ingres_query</function></member>
    <member><function>ingres_num_fields</function></member>
    <member><function>ingres_field_name</function></member>
    <member><function>ingres_fetch_object</function></member>
    <member><function>ingres_fetch_row</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->