File: ibase-connect.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 (216 lines) | stat: -rw-r--r-- 6,454 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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-connect">
 <refnamediv>
  <refname>ibase_connect</refname>
  <refpurpose>Open a connection to an InterBase database</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ibase_connect</methodname>
   <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
  </methodsynopsis>
  <para>
   Establishes a connection to an InterBase server.
  </para>
  <para>
   In case a second call is made to <function>ibase_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. 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>ibase_close</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       The <parameter>database</parameter> argument has to be a valid path to
       database file on the server it resides on. If the server is not local,
       it must be prefixed with either 'hostname:' (TCP/IP), '//hostname/'
       (NetBEUI) or 'hostname@' (IPX/SPX), depending on the connection
       protocol used.   
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
       The user name. Can be set with the
       <literal>ibase.default_user</literal> &php.ini; directive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       The password for <parameter>username</parameter>. Can be set with the
       <literal>ibase.default_password</literal> &php.ini; directive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       <parameter>charset</parameter> is the default character set for a
       database.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>buffers</parameter></term>
     <listitem>
      <para>
       <parameter>buffers</parameter> is the number of database buffers to
       allocate for the server-side cache. If 0 or omitted, server chooses
       its own default.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dialect</parameter></term>
     <listitem>
      <para>
       <parameter>dialect</parameter> selects the default SQL dialect for any
       statement executed within a connection, and it defaults to the highest
       one supported by client libraries. Functional only with InterBase 6
       and up.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>role</parameter></term>
     <listitem>
      <para>
       Functional only with InterBase 5 and up.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sync</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an InterBase link identifier on success, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If you get some error like "arithmetic exception, numeric overflow, or
   string truncation. Cannot transliterate character between character sets"
   (this occurs when you try use some character with accents) when using this
   and after <function>ibase_query</function> you must set the character set
   (i.e. ISO8859_1 or your current character set).
  </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.0.0</entry>
       <entry>
        The <parameter>buffers</parameter>, <parameter>dialect</parameter>
        and <parameter>role</parameter> parameters were added
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ibase_connect</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$host = 'localhost:/path/to/your.gdb';

$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
    echo $row->email, "\n";
}
ibase_free_result($sth);
ibase_close($dbh);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ibase_pconnect</function></member>
    <member><function>ibase_close</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
-->