pg-field-table.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-field-table" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_field_table</refname> 
  <refpurpose>Retourne le nom ou l'oid d'une table</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>int</type><type>false</type></type><methodname>pg_field_table</methodname>
   <methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter>field</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>oid_only</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_field_table</function> retourne le nom de la table à laquelle
   le champ appartient ou l'oid de la table si le paramètre
   <parameter>oid_only</parameter> vaut &true;.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      &pgsql.parameter.result;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>field</parameter></term>
      <listitem>
       <para>
        Numéro du champ, commençant à 0.
       </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>oid_only</parameter></term>
      <listitem>
       <para>
        Par défaut, le nom de la table à laquelle le champ appartient est retourné mais
        si le paramètre <parameter>oid_only</parameter> est défini à &true;, alors,
        ce sera l'oid qui sera retourné.
       </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   En cas de succès, le nom de la table ou l'oid, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.result-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Récupération des informations d'une table à partir d'un champ</title>
    <programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=publisher") or die("Connexion impossible");

$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>
    Retourner l'oid est plus rapide que de retourner le nom de la table, car
    la récupération du nom de la table nécessite une requête sur la table système
    de la base de données.
   </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:"~/.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
-->