setattribute.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c60137e9d56c40861f6235d60c4553937c77af22 Maintainer: takagi Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<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>
       フェッチする際、数値を文字列に変換するかどうかを指定します。
       <type>bool</type> の値を指定します:
       変換を有効にする場合 &true;、
       無効にする場合、&false; にします。
       <!-- By default, ??? TODO. -->
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>PDO::ATTR_STATEMENT_CLASS</constant></term>
     <listitem>
      <para>
       PDOStatement から派生した、
       ユーザーが提供するステートメントクラスを設定する。
       <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>
       タイムアウト秒数を指定します。
       数値を指定します。
      </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; を指定すると、
       プリペアドステートメントを常にエミュレートします。
       そうでない場合、
       ネイティブのプリペアドステートメントを使おうとします。
       ドライバが現在のクエリを正しく準備できなかった場合は、
       常にエミュレート方式を使います。
      </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><methodname>PDO::getAttribute</methodname></member>
    <member><methodname>PDOStatement::getAttribute</methodname></member>
    <member><methodname>PDOStatement::setAttribute</methodname></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:"~/.phpdoc/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
-->