php-doc-ru/reference/mysql/functions/mysql-fetch-field.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: n/a Maintainer: lovchy Status: ready -->
<!-- splitted from ./en/functions/mysql.xml, last change in rev 1.2 -->
  <refentry xml:id="function.mysql-fetch-field" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>mysql_fetch_field</refname>
    <refpurpose>
     Возвращает информацию о колонке из результата запроса в виде объекта.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Описание</title>
     <methodsynopsis>
      <type>object</type><methodname>mysql_fetch_field</methodname>
      <methodparam><type>resource</type><parameter>result</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
     </methodsynopsis>
    <para>
     Возвращает объект, содержащий информацию о колонке.
    </para>
    <para>
     <function>mysql_fetch_field</function> может использоваться для получения
     информации о колонках конкретного запроса. Если смещение не указано,
     функция возвращает информацию о первой колонке, которая ещё не была
     обработана функцией <function>mysql_fetch_field</function>.
    </para>
    <para>
     Свойства объекта:
     <itemizedlist>
      <listitem>
       <simpara>
        name - название колонки
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        table - название таблицы, которой принадлежит колонка
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        max_length - максимальная длинна содержания
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        not_null - 1, если колонка не может быть равна &null;
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        primary_key - 1, если колонка -- первичный индекс
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        unique_key - 1, если колона -- уникальный индекс
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        multiple_key - 1, если колонка -- не уникальный индекс
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        numeric - 1, если колонка численная
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        blob - 1, если колонка -- BLOB
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        type - тип колонки
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        unsigned - 1, если колонка строго положительная (unsigned)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        zerofill - 1, если колонка заполняется нулями (zero-filled)
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    &database.field-case;
    <para>
     <example>
      <title>Пример использования <function>mysql_fetch_field</function></title>
      <programlisting role="php">
<![CDATA[
<?php
mysql_connect('localhost:3306', $user, $password)
    or die("Could not connect: " . mysql_error());
mysql_select_db("database");
$result = mysql_query("select * from table")
    or die("Query failed: " . mysql_error());
/* получаем данные о колонке */
$i = 0;
while ($i < mysql_num_fields($result)) {
    echo "Information for column $i:<br />\n";
    $meta = mysql_fetch_field($result, $i);
    if (!$meta) {
        echo "No information available<br />\n";
    }
    echo "<pre>
blob:         $meta->blob
max_length:   $meta->max_length
multiple_key: $meta->multiple_key
name:         $meta->name
not_null:     $meta->not_null
numeric:      $meta->numeric
primary_key:  $meta->primary_key
table:        $meta->table
type:         $meta->type
unique_key:   $meta->unique_key
unsigned:     $meta->unsigned
zerofill:     $meta->zerofill
</pre>";
    $i++;
}
mysql_free_result($result);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     См. также <function>mysql_field_seek</function>.
    </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
-->