[PHP-DOC] cvs: phpdoc /en/reference/pgsql/functions pg-field-table.xml

[Philip Olson]

philip          Sun May  7 01:12:30 2006 UTC

  Added files:                 
    /phpdoc/en/reference/pgsql/functions        pg-field-table.xml 
  Log:
  Initial commit
  
  

http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/pgsql/functions/pg-field-table.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/pgsql/functions/pg-field-table.xml
+++ phpdoc/en/reference/pgsql/functions/pg-field-table.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.pg-field-table">
 <refnamediv>
  <refname>pg_field_table</refname> 
  <refpurpose>Returns the name or oid of the tables field</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pg_field_table</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
   <methodparam><type>bool</type><parameter>oid_only</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_field_table</function> returns the name of the table that field 
   belongs to, or the table's oid if <parameter>oid_only</parameter> is &true;.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       PostgreSQL query result resource, returned by 
<function>pg_query</function>,
       <function>pg_query_params</function> or <function>pg_execute</function>
       (among others).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>field_number</parameter></term>
      <listitem>
       <para>
        Field number, starting from 0.
       </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>oid_only</parameter></term>
      <listitem>
       <para>
        By default the tables name that field belongs to is returned but
        if <parameter>oid_only</parameter> is set to &true;, then the
        oid will instead be returned.
       </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success either the fields table name or oid. Or, &false; on failure.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Getting table information about a field</title>
    <programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=publisher") or die("Could not connect");

$res = pg_query($dbconn, "SELECT bar FROM foo");

echo pg_field_table($res, 0);
echo pg_field_table($res, 0, true);

$res = pg_query($dbconn, "SELECT version()");
var_dump(pg_field_table($res, 0));
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
foo
14379580

bool(false)
]]>
    </screen>
   </example> 
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Returning the oid is much faster than returning the table name because
    fetching the table name requires a query to the database system table.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_field_name</function></member>
    <member><function>pg_field_type</function></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:"../../../../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
-->