archived-doc-en/reference/pdo_odbc/pdo-odbc.xml

<?xml version="1.0" encoding="utf-8"?>
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.pdo-odbc" role="class">
 <title>The Pdo\Odbc class</title>
 <titleabbrev>Pdo\Odbc</titleabbrev>

 <partintro>

  <!-- {{{ ClassName intro -->
  <section xml:id="pdo-odbc.intro">
   &reftitle.intro;
   <simpara>
    A <classname>PDO</classname> subclass representing a connection using
    the ODBC PDO driver.
   </simpara>
  </section>
  <!-- }}} -->

  <section xml:id="pdo-odbc.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <packagesynopsis>
    <package>Pdo</package>

    <classsynopsis class="class">
     <ooclass>
      <classname>Odbc</classname>
     </ooclass>

     <ooclass>
      <modifier>extends</modifier>
      <classname>PDO</classname>
     </ooclass>

     <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
      <xi:fallback/>
     </xi:include>

     <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="pdo-odbc.constants.attr-use-cursor-library">Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY</varname>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="pdo-odbc.constants.attr-assume-utf8">Pdo\Odbc::ATTR_ASSUME_UTF8</varname>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="pdo-odbc.constants.sql-use-if-needed">Pdo\Odbc::SQL_USE_IF_NEEDED</varname>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="pdo-odbc.constants.sql-use-driver">Pdo\Odbc::SQL_USE_DRIVER</varname>
     </fieldsynopsis>
     <fieldsynopsis>
      <modifier>public</modifier>
      <modifier>const</modifier>
      <type>int</type>
      <varname linkend="pdo-odbc.constants.sql-use-odbc">Pdo\Odbc::SQL_USE_ODBC</varname>
     </fieldsynopsis>

     <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='PDO'])">
      <xi:fallback/>
     </xi:include>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='PDO'])">
      <xi:fallback/>
     </xi:include>
    </classsynopsis>
   </packagesynopsis>
   <!-- }}} -->

  </section>

  <section xml:id="pdo-odbc.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="pdo-odbc.constants.attr-use-cursor-library">
     <term><constant>Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY</constant></term>
     <listitem>
      <para>
       This option controls whether the ODBC cursor library is used.
       The ODBC cursor library supports some advanced ODBC features
       (e.g. block scrollable cursors),
       which may not be implemented by the driver.
       The following values are supported:
       <variablelist>
        <varlistentry xml:id="pdo-odbc.constants.sql-use-if-needed">
         <term><constant>Pdo\Odbc::SQL_USE_IF_NEEDED</constant></term>
         <listitem>
          <simpara>
           Use the ODBC cursor library when needed.
           This is the default.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry xml:id="pdo-odbc.constants.sql-use-driver">
         <term><constant>Pdo\Odbc::SQL_USE_DRIVER</constant></term>
         <listitem>
          <simpara>
           Never use the ODBC cursor library.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry xml:id="pdo-odbc.constants.sql-use-odbc">
         <term><constant>Pdo\Odbc::SQL_USE_ODBC</constant></term>
         <listitem>
          <simpara>
           Always use the ODBC cursor library.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-odbc.constants.attr-assume-utf8">
     <term><constant>Pdo\Odbc::ATTR_ASSUME_UTF8</constant></term>
     <listitem>
      <simpara>
       Windows only.
       If &true;, UTF-16 encoded character data (<literal>CHAR</literal>,
       <literal>VARCHAR</literal> and <literal>LONGVARCHAR</literal>)
       is converted to UTF-8 when reading from or writing data to the database.
       If &false; (the default), character encoding conversion may be done by the driver.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
 </partintro>

</reference>
<!-- 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
-->