<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry xml:id='function.pg-transaction-status' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_transaction_status</refname>
  <refpurpose>Returns the current in-transaction status of the server</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pg_transaction_status</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
  </methodsynopsis>
  <para>
    Returns the current in-transaction status of the server.
  </para>
  <caution>
    <para>
      <function>pg_transaction_status</function> will give incorrect results when using
      a PostgreSQL 7.3 server that has the parameter <literal>autocommit</literal>
      set to off.  The server-side autocommit feature has been
      deprecated and does not exist in later server versions.
    </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>The status can be <constant>PGSQL_TRANSACTION_IDLE</constant> (currently idle),
    <constant>PGSQL_TRANSACTION_ACTIVE</constant> (a command is in progress),
    <constant>PGSQL_TRANSACTION_INTRANS</constant> (idle, in a valid transaction block),
    or <constant>PGSQL_TRANSACTION_INERROR</constant> (idle, in a failed transaction block).
    <constant>PGSQL_TRANSACTION_UNKNOWN</constant> is reported if the connection is bad.
    <constant>PGSQL_TRANSACTION_ACTIVE</constant> is reported only when a query
    has been sent to the server and not yet completed.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_transaction_status</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
  $dbconn = pg_connect("dbname=publisher") or die("Could not connect");
  $stat = pg_transaction_status($dbconn);
  if ($stat === PGSQL_TRANSACTION_UNKNOWN) {
      echo 'Connection is bad';
  } else if ($stat === PGSQL_TRANSACTION_IDLE) {
      echo 'Connection is currently idle';
  } else {
      echo 'Connection is in a transaction state';
  }    
?>
]]>
    </programlisting>
   </example>
  </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
-->
