php-doc-en/reference/mysqli/functions/mysqli-fetch-fields.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.23 $ -->
<refentry id="function.mysqli-fetch-fields">
 <refnamediv>
  <refname>mysqli_fetch_fields</refname>
  <refname>result->fetch_fields()</refname>
  <refpurpose>Returns an array of objects representing the fields in a result set</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>Procedural Style:</para>
  <methodsynopsis>
   <type>array</type><methodname>mysqli_fetch_fields</methodname>
   <methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
  </methodsynopsis>
  <para>Object oriented style (method):</para>
  <classsynopsis>
   <ooclass><classname>mysqli_result</classname></ooclass>
   <methodsynopsis>
    <type>array</type><methodname>fetch_fields</methodname>
    <void/>
   </methodsynopsis>
  </classsynopsis>
  <para>
   This function serves an identical purpose to the 
   <function>mysqli_fetch_field</function> function with the single
   difference that, instead of returning one object at a time for each field,
   the columns are returned as an array of objects.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysqli.result.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of objects which contains field definition information or
   &false; if no field information is available.
  </para>
  <para>
  <table>
   <title>Object properties</title>
   <tgroup cols='2'>
    <thead>
     <row>
      <entry>Property</entry>
      <entry>Description</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>name</entry>
      <entry>The name of the column</entry>
     </row>
     <row>
      <entry>orgname</entry>
      <entry>Original column name if an alias was specified</entry>
     </row>
     <row>
      <entry>table</entry>
      <entry>The name of the table this field belongs to (if not calculated)</entry>
     </row>
     <row>
      <entry>orgtable</entry>
      <entry>Original table name if an alias was specified</entry>
     </row>
     <row>
      <entry>def</entry>
      <entry>The default value for this field, represented as a string</entry>
     </row>
     <row>
      <entry>max_length</entry>
      <entry>The maximum width of the field for the result set.</entry>
     </row>
     <row>
      <entry>length</entry>
      <entry>The width of the field, as specified in the table definition.</entry>
     </row>
     <row>
      <entry>charsetnr</entry>
      <entry>The character set number for the field.</entry>
     </row>
     <row>
      <entry>flags</entry>
      <entry>An integer representing the bit-flags for the field.</entry>
     </row>
     <row>
      <entry>type</entry>
      <entry>The data type used for this field</entry>
     </row>
     <row>
      <entry>decimals</entry>
      <entry>The number of decimals used (for integer fields)</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Object oriented style</title>
   <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";

if ($result = $mysqli->query($query)) {

    /* Get field information for all columns */
    $finfo = $result->fetch_fields();

    foreach ($finfo as $val) {
        printf("Name:     %s\n", $val->name);
        printf("Table:    %s\n", $val->table);
        printf("max. Len: %d\n", $val->max_length);
        printf("Flags:    %d\n", $val->flags);
        printf("Type:     %d\n\n", $val->type);
    }
    $result->close();
}

/* close connection */
$mysqli->close();
?>
]]>
  </programlisting>
  </example>
  <example>
   <title>Procedural style</title>
   <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";

if ($result = mysqli_query($link, $query)) {

    /* Get field information for all columns */
    $finfo = mysqli_fetch_fields($result);

    foreach ($finfo as $val) {
        printf("Name:     %s\n", $val->name);
        printf("Table:    %s\n", $val->table);
        printf("max. Len: %d\n", $val->max_length);
        printf("Flags:    %d\n", $val->flags);
        printf("Type:     %d\n\n", $val->type);
    }
    mysqli_free_result($result);
}

/* close connection */
mysqli_close($link);
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
Name:     Name
Table:    Country
max. Len: 11
Flags:    1
Type:     254

Name:     SurfaceArea
Table:    Country
max. Len: 10
Flags:    32769
Type:     4

]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysqli_num_fields</function></member>
    <member><function>mysqli_fetch_field_direct</function></member>
    <member><function>mysqli_fetch_field</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
-->