File: PDOStatement-bindColumn.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (172 lines) | stat: -rw-r--r-- 4,994 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
  <refentry id="function.PDOStatement-bindColumn">
   <refnamediv>
    <refname>PDOStatement::bindColumn</refname>
    <refpurpose>
     Bind a column to a PHP variable
    </refpurpose>
   </refnamediv>
   <refsect1 role="description">
    &reftitle.description;
    <methodsynopsis>
     <type>bool</type><methodname>PDOStatement::bindColumn</methodname>
     <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
     <methodparam><type>mixed</type><parameter role="reference">param</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam>
     <methodparam choice="opt"><type>mixed</type><parameter>driver_options</parameter></methodparam>
    </methodsynopsis>

     &warn.experimental.func;
    <para>
     On each row fetch <parameter>param</parameter> will contain the value of
     the corresponding column. <parameter>column</parameter> is the 1-based
     offset of the column, or the column name. For maximum portability, do not
     call this function before calling
     <function>PDOStatement::execute</function>.
    </para>

   </refsect1>

   <refsect1 role="parameters">
    &reftitle.parameters;
    <para>
     <variablelist>
      <varlistentry>
       <term><parameter>column</parameter></term>
        <listitem>
         <para>
          Number of the column (1-indexed) in the result set.
         </para>
        </listitem>
       </varlistentry>
      <varlistentry>
       <term><parameter>param</parameter></term>
        <listitem>
         <para>
          Name of the PHP variable to which the column will be bound.
         </para>
        </listitem>
       </varlistentry>
      <varlistentry>
       <term><parameter>type</parameter></term>
        <listitem>
         <para>
          Data type of the parameter, specified by the PDO_PARAM_* constants.
         </para>
        </listitem>
       </varlistentry>
      <varlistentry>
       <term><parameter>maxlen</parameter></term>
        <listitem>
         <para>
          Maximum length of the parameter.
         </para>
        </listitem>
       </varlistentry>
      <varlistentry>
       <term><parameter>driver_options</parameter></term>
        <listitem>
         <para>
          
         </para>
        </listitem>
       </varlistentry>
     </variablelist>
    </para>
   </refsect1>

   <refsect1 role="examples">
    &reftitle.examples;
    <para>
     <example>
      <title>Binding result set output to PHP variables</title>
      <para>
       Binding columns in the result set to PHP variables is an effective
       way to make the data contained in each row immediately available to
       your application. The following example demonstrates how PDO allows
       you to bind and retrieve columns with a variety of options and with
       intelligent defaults.
      </para>
      <programlisting role="php">
  <![CDATA[
<?php
function readData($dbh) {
  $sql = 'SELECT name, colour, calories FROM fruit';
  try {
    $stmt = $dbh->prepare($sql);
    $stmt->execute();

    /* Bind by column number with an explicit data type & length */
    $stmt->bindColumn(1, $name, PDO_PARAM_STR, 64);

    /* Bind by column number with default data type & length */
    $stmt->bindColumn(2, $colour);

    /* Bind by column name with default data type & length */
    $stmt->bindColumn('CALORIES', $cals);

    while ($row = $stmt->fetch(PDO_FETCH_BOUND)) {
      $data = $name . "\t" . $colour . "\t" . $cals . "\n";
      print $data;
    }
  }
  catch (PDOException $e) {
    print $e->getMessage();
  }
}
readData($dbh);
?>
  ]]>
      </programlisting>
      &example.outputs;
      <screen>
  <![CDATA[
apple   red     150
banana  yellow  175
kiwi    green   75
orange  orange  150
mango   red     200
strawberry      red     25
  ]]>
      </screen>
     </example>
    </para>
   </refsect1>

   <refsect1 role="seealso">
    &reftitle.seealso;
    <para>
     <simplelist>
      <member><function>PDOStatement::execute</function></member>
      <member><function>PDOStatement::fetch</function></member>
      <member><function>PDOStatement::fetchAll</function></member>
      <member><function>PDOStatement::fetchSingle</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
-->