cubrid-fetch-field.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 32040dd7e5d98c136502134110681f80443dd000 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.cubrid-fetch-field">
 <refnamediv>
  <refname>cubrid_fetch_field</refname>
  <refpurpose>Получает информацию о столбце результирующего набора в виде объекта</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>object</type><methodname>cubrid_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>
  <simpara>
   Функция возвращает объект, в свойствах которого содержится информация о столбце.
   Свойства объекта:
  </simpara>
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem><simpara>имя столбца</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table</parameter></term>
     <listitem><simpara>имя таблицы</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>def</parameter></term>
     <listitem><simpara>значение столбца по умолчанию</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max_length</parameter></term>
     <listitem><simpara>максимальная длина столбца</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>not_null</parameter></term>
     <listitem><simpara>1, если не может быть NULL</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>primary_key</parameter></term>
     <listitem><simpara>1, если является первичным ключом</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>unique_key</parameter></term>
     <listitem><simpara>1, если является уникальным ключом</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>multiple_key</parameter></term>
     <listitem><simpara>1, если является неуникальным ключом</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>numeric</parameter></term>
     <listitem><simpara>1, если содержит числовое значение</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>blob</parameter></term>
     <listitem><simpara>1, если содержит BLOB</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem><simpara>тип столбца</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>unsigned</parameter></term>
     <listitem><simpara>1, если беззнаковый тип</simpara></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>zerofill</parameter></term>
     <listitem><simpara>1, если дополняется нулями</simpara></listitem>
    </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>result</parameter></term>
    <listitem><simpara><parameter>Result</parameter>, полученный из <function>cubrid_execute</function></simpara></listitem>
  </varlistentry>
  <varlistentry>
   <term><parameter>field_offset</parameter></term>
   <listitem><simpara>
    Числовой индекс столбца. Если не задан, то будет извлечён следующий, не
    извлечённый этой функцией, столбец.
    <parameter>field_offset</parameter> начинается с нуля.
    </simpara></listitem>
  </varlistentry>
 </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Функция возвращает объект с описанными свойствами
   в случае успешного выполнения.
  </simpara>
  <simpara>
   Функция возвращает &false;, если возникла ошибка.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>
    Пример использования функции <function>cubrid_fetch_field</function>
   </title>
   <programlisting role="php">
<![CDATA[
<?php

$conn = cubrid_connect("localhost", 33000, "demodb");
$req = cubrid_execute($conn, "SELECT event_code,athlete_code,nation_code,game_date FROM game WHERE host_year=1988 and event_code=20001;");

var_dump(cubrid_fetch_row($req));

cubrid_field_seek($req, 1);
$field = cubrid_fetch_field($req);

printf("\n--- Field Properties ---\n");
printf("%-30s %s\n", "имя столбца:", $field->name);
printf("%-30s %s\n", "имя таблицы:", $field->table);
printf("%-30s \"%s\"\n", "значение столбца по умолчанию:", $field->def);
printf("%-30s %d\n", "максимальная длина столбца:", $field->max_length);
printf("%-30s %d\n", "не может быть NULL:", $field->not_null);
printf("%-30s %d\n", "является первичным ключом:", $field->primary_key);
printf("%-30s %d\n", "является уникальным ключом:", $field->unique_key);
printf("%-30s %d\n", "является неуникальным ключом:", $field->multiple_key);
printf("%-30s %d\n", "содержит числовое значение:", $field->numeric);
printf("%-30s %d\n", "содержит BLOB:", $field->blob);
printf("%-30s %s\n", "тип столбца:", $field->type);
printf("%-30s %d\n", "беззнаковый тип:", $field->unsigned);
printf("%-30s %d\n", "дополняется нулями:", $field->zerofill);

cubrid_close_request($req);

cubrid_disconnect($conn);

?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
array(4) {
  [0]=>
  string(5) "20001"
  [1]=>
  string(5) "16681"
  [2]=>
  string(3) "KOR"
  [3]=>
  string(9) "1988-9-30"
}

--- Field Properties ---
имя столбца:                         athlete_code
имя таблицы:                         game
значение столбца по умолчанию:          ""
максимальная длина столбца:             0
не может быть NULL:                  1
является первичным ключом:             1
является уникальным ключом:            1
является неуникальным ключом:           0
содержит числовое значение:             1
содержит BLOB:                       0
тип столбца:                         integer
беззнаковый тип:                      0
дополняется нулями:                    0
]]>
   </screen>
  </example>
 </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
-->