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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDO-getAttribute">
<refnamediv>
<refname>PDO::getAttribute</refname>
<refpurpose>
Retrieve a database connection attribute
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>PDO::getAttribute</methodname>
<methodparam><type>long</type><parameter>attribute</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This function returns the value of a database connection attribute. To
retrieve PDOStatement attributes, refer to
<function>PDOStatement::getAttribute</function>.
</para>
<para>
Note that some databases may not support all of the database connection
attributes.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
One of the <literal>PDO_ATTR_*</literal> constants. The constants that
apply to database connections are as follows:
<simplelist>
<member><literal>PDO_ATTR_AUTOCOMMIT</literal></member>
<member><literal>PDO_ATTR_CASE</literal></member>
<member><literal>PDO_ATTR_CLIENT_VERSION</literal></member>
<member><literal>PDO_ATTR_CONNECTION_STATUS</literal></member>
<member><literal>PDO_ATTR_ERRMODE</literal></member>
<member><literal>PDO_ATTR_ORACLE_NULLS</literal></member>
<member><literal>PDO_ATTR_PERSISTENT</literal></member>
<member><literal>PDO_ATTR_PREFETCH</literal></member>
<member><literal>PDO_ATTR_SERVER_INFO</literal></member>
<member><literal>PDO_ATTR_SERVER_VERSION</literal></member>
<member><literal>PDO_ATTR_TIMEOUT</literal></member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A successful call returns the value of the requested PDO attribute.
An unsuccessful call returns <literal>null</literal>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieving database connection attributes</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = new PDO('odbc:sample', 'db2inst1', 'ibmdb2');
print "\nPDO_ATTR_AUTOCOMMIT: ";
print $conn->getAttribute(PDO_ATTR_AUTOCOMMIT);
print "\nPDO_ATTR_ERRMODE: ";
print $conn->getAttribute(PDO_ATTR_ERRMODE);
print "\nPDO_ATTR_CASE: ";
print $conn->getAttribute(PDO_ATTR_CASE);
print "\nPDO_ATTR_CLIENT_VERSION: ";
print $conn->getAttribute(PDO_ATTR_CLIENT_VERSION);
print "\nPDO_ATTR_CONNECTION_STATUS: ";
print $conn->getAttribute(PDO_ATTR_CONNECTION_STATUS);
print "\nPDO_ATTR_ORACLE_NULLS: ";
print $conn->getAttribute(PDO_ATTR_ORACLE_NULLS);
print "\nPDO_ATTR_PERSISTENT: ";
print $conn->getAttribute(PDO_ATTR_PERSISTENT);
print "\nPDO_ATTR_PREFETCH: ";
print $conn->getAttribute(PDO_ATTR_PREFETCH);
print "\nPDO_ATTR_SERVER_INFO: ";
print $conn->getAttribute(PDO_ATTR_SERVER_INFO);
print "\nPDO_ATTR_SERVER_VERSION: ";
print $conn->getAttribute(PDO_ATTR_SERVER_VERSION);
print "\nPDO_ATTR_TIMEOUT: ";
print $conn->getAttribute(PDO_ATTR_TIMEOUT);
?>
]]>
</programlisting>
<!--
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
-->
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PDO::setAttribute</function></member>
<member><function>PDOStatement::getAttribute</function></member>
<member><function>PDOStatement::setAttribute</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
-->
|
