mysql-fetch-field.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 65e697ff671608989432a6e6bf8ae8128b2be2c7 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mysql-fetch-field" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_fetch_field</refname>
  <refpurpose>Возвращает информацию о колонке из результата запроса в виде объекта</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_fetch_field</function></member>
    <member><methodname>PDOStatement::getColumnMeta</methodname></member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <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><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Возвращает объект, содержащий информацию о колонке. Эту функцию
   можно использовать для получения информации о полях в переданном
   результате запроса.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.result.description;
    <varlistentry>
     <term><parameter>field_offset</parameter></term>
     <listitem>
      <para>
       Числовое смещение поля. Если смещение не указано,
       функция возвращает информацию о первой колонке, которая
       ещё не была обработана этой функцией.
       Нумерация <parameter>field_offset</parameter> начинается с <literal>0</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает <type>object</type>, содержащий информацию о колонке.
   Объект содержит следующие свойства:
  </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>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>mysql_fetch_field</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$conn = mysql_connect('localhost', 'mysql_user', 'mysql_password');
if (!$conn) {
    die('Ошибка при соединении: ' . mysql_error());
}
mysql_select_db('database');
$result = mysql_query('select * from table');
if (!$result) {
    die('Ошибка в запросе: ' . mysql_error());
}
/* получаем данные о колонке */
$i = 0;
while ($i < mysql_num_fields($result)) {
    echo "Информация о колонке $i:<br />\n";
    $meta = mysql_fetch_field($result, $i);
    if (!$meta) {
        echo "Информация недоступна<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>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &database.field-case;
  <note>
   <para>
    Если поля или таблицы имеют дополнительные имена в запросе SQL,
    то будет возвращены эти дополнительные имена. Исходное имя может быть получено, например,
    с помощью <methodname>mysqli_result::fetch_field</methodname>.
   </para>
  </note>
 </refsect1>

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