reference/pdo/pdo/getattribute.xml
5bef6e3f51b6add9f9f27ad65409b66f6ab44af7
...
...
@@ -9,15 +9,15 @@
9
9
</refnamediv>
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type class="union"><type>bool</type><type>int</type><type>string</type><type>array</type><type>null</type></type><methodname>PDO::getAttribute</methodname>
12
+
<methodsynopsis role="PDO">
13
+
<modifier>public</modifier> <type>mixed</type><methodname>PDO::getAttribute</methodname>
14
14
<methodparam><type>int</type><parameter>attribute</parameter></methodparam>
15
15
</methodsynopsis>
16
16

17
17
<para>
18
18
This function returns the value of a database connection attribute. To
19
19
retrieve PDOStatement attributes, refer to
20
-
<function>PDOStatement::getAttribute</function>.
20
+
<methodname>PDOStatement::getAttribute</methodname>.
21
21
</para>
22
22

23
23
<para>
...
...
@@ -35,7 +35,7 @@
35
35
<term><parameter>attribute</parameter></term>
36
36
<listitem>
37
37
<para>
38
-
One of the <literal>PDO::ATTR_*</literal> constants. The constants that
38
+
One of the <literal>PDO::ATTR_*</literal> constants. The generic attributes that
39
39
apply to database connections are as follows:
40
40
<simplelist>
41
41
<member><literal>PDO::ATTR_AUTOCOMMIT</literal></member>
...
...
@@ -52,6 +52,11 @@
52
52
<member><literal>PDO::ATTR_TIMEOUT</literal></member>
53
53
</simplelist>
54
54
</para>
55
+
<simpara>
56
+
Some drivers may make use of additional driver specific attributes.
57
+
Note that driver specific attributes <emphasis>must not</emphasis> be used
58
+
with other drivers.
59
+
</simpara>
55
60
</listitem>
56
61
</varlistentry>
57
62
</variablelist>
...
...
@@ -66,6 +71,14 @@
66
71
</para>
67
72
</refsect1>
68
73

74
+
<refsect1 role="errors">
75
+
&reftitle.errors;
76
+
<para>
77
+
<methodname>PDO::getAttribute</methodname> may throw a <exceptionname>PDOException</exceptionname>
78
+
when the underlying driver does not support the requested <parameter>attribute</parameter>.
79
+
</para>
80
+
</refsect1>
81
+

69
82
<refsect1 role="examples">
70
83
&reftitle.examples;
71
84
<para>
...
...
@@ -104,9 +117,9 @@ Use the PEAR Coding Standards
104
117
&reftitle.seealso;
105
118
<para>
106
119
<simplelist>
107
-
<member><function>PDO::setAttribute</function></member>
108
-
<member><function>PDOStatement::getAttribute</function></member>
109
-
<member><function>PDOStatement::setAttribute</function></member>
120
+
<member><methodname>PDO::setAttribute</methodname></member>
121
+
<member><methodname>PDOStatement::getAttribute</methodname></member>
122
+
<member><methodname>PDOStatement::setAttribute</methodname></member>
110
123
</simplelist>
111
124
</para>
112
125
</refsect1>
113
126