<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="pdo.setattribute" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>PDO::setAttribute</refname>

<refpurpose>

设置属性

</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="PDO">

<modifier>public</modifier> <type>bool</type><methodname>PDO::setAttribute</methodname>

<methodparam><type>int</type><parameter>attribute</parameter></methodparam>

<methodparam><type>mixed</type><parameter>value</parameter></methodparam>

</methodsynopsis>

<para>

设置数据库句柄属性。下面列出了一些可用的通用属性；有些驱动可能使用另外的特定属性。

请注意，特定的驱动程序属性<emphasis>不得</emphasis>用于其他驱动程序。

<variablelist>

<varlistentry>

<term><constant>PDO::ATTR_CASE</constant></term>

<listitem>

<para>

强制列名为指定的大小写。可以采用以下某个值：

</para>

<variablelist>

<varlistentry>

<term><constant>PDO::CASE_LOWER</constant></term>

<listitem>

<simpara>

强制列名小写。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::CASE_NATURAL</constant></term>

<listitem>

<simpara>

保留数据库驱动返回的列名。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::CASE_UPPER</constant></term>

<listitem>

<simpara>

强制列名大写。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_ERRMODE</constant></term>

<listitem>

<para>

PDO 的报错方式。可以采用以下某个值：

</para>

<variablelist>

<varlistentry>

<term><constant>PDO::ERRMODE_SILENT</constant></term>

<listitem>

<simpara>

仅设置错误代码。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ERRMODE_WARNING</constant></term>

<listitem>

<simpara>

引发 <constant>E_WARNING</constant> 警告。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ERRMODE_EXCEPTION</constant></term>

<listitem>

<simpara>

抛出 <classname>PDOException</classname>。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_ORACLE_NULLS</constant></term>

<listitem>

<note>

<simpara>

此属性适用于所有驱动程序，而不仅仅是 Oracle。

</simpara>

</note>

<para>

确定是否以及如何转换 &null; 和空字符串。可以采用以下值之一：

</para>

<variablelist>

<varlistentry>

<term><constant>PDO::NULL_NATURAL</constant></term>

<listitem>

<simpara>

不发生转换。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::NULL_EMPTY_STRING</constant></term>

<listitem>

<simpara>

空字符串转换为 &null;。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::NULL_TO_STRING</constant></term>

<listitem>

<simpara>

&null; 被转换为空字符串。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_STRINGIFY_FETCHES</constant></term>

<listitem>

<para>

控制是否将获取的值（&null; 除外）转换为字符串。采用 <type>bool</type> 类型的值：&true; 表示启用，&false;

表示禁用（默认）。除非将 <constant>PDO::ATTR_ORACLE_NULLS</constant> 设置为

<constant>PDO::NULL_TO_STRING</constant>，否则 &null; 值保持不变。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_STATEMENT_CLASS</constant></term>

<listitem>

<para>

设置从 PDOStatement 派生的用户提供的语句类。

<!-- TODO improve description of the value it takes, or refer to other docs -->

需要 <literal>array(string classname, array(mixed constructor_args))</literal>。

</para>

<caution>

<simpara>

不能用于持久 PDO 实例。

</simpara>

</caution>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_TIMEOUT</constant></term>

<listitem>

<para>

指定超时的秒数。需要 <type>int</type> 类型的值。

</para>

<note>

<para>

并非所有驱动都支持此选项，这意味着驱动和驱动之间可能会有差异。比如，SQLite 等待的时间达到此值后就放弃获取可写锁，但其他驱动可能会将此值解释为一个连接或读取超时的间隔。

</para>

</note>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_AUTOCOMMIT</constant></term>

<listitem>

<note>

<simpara>

仅适用于 OCI、Firebird 和 MySQL 驱动程序。

</simpara>

</note>

<para>

是否自动提交每个单独的语句。采用 <type>bool</type> 类型的值：&true; 表示启用，&false; 表示禁用。默认为 &true;。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_EMULATE_PREPARES</constant></term>

<listitem>

<note>

<simpara>

仅适用于 OCI、Firebird 和 MySQL 驱动程序。

</simpara>

</note>

<para>

是否启用或禁用预处理语句的模拟。有些驱动天然不支持或有限度地支持预处理语句。如果设置为 &true;，PDO

始终模拟预处理语句，否则 PDO 将会尝试使用本地预处理语句。如果驱动不能成功预处理当前查询，PDO 将始终回退到模拟预处理语句上。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::MYSQL_ATTR_USE_BUFFERED_QUERY</constant></term>

<listitem>

<note>

<simpara>

仅适用于 MySQL 驱动程序。

</simpara>

</note>

<para>

是否使用缓冲查询。采用 <type>bool</type> 类型的值：&true; 表示启用，&false; 表示禁用。默认情况下，默认为 &true;。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>PDO::ATTR_DEFAULT_FETCH_MODE</constant></term>

<listitem>

<para>

设置默认获取模式。关于模式的说明以及如何使用可以在 <methodname>PDOStatement::fetch</methodname> 文档找到。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>attribute</parameter></term>

<listitem>

<para>

要修改的属性。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>value</parameter></term>

<listitem>

<para>

设置 <parameter>attribute</parameter> 的值，属性的不同导致需要的类型也会不同。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>PDO::getAttribute</function></member>

<member><function>PDOStatement::getAttribute</function></member>

<member><function>PDOStatement::setAttribute</function></member>

</simplelist>

</para>

</refsect1>

</refentry>