pg-fetch-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 39bb8a868935a56cfce438b0169e13c02c93211c Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-fetch-object" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_fetch_object</refname>
  <refpurpose>Выбирает строку результата запроса и возвращает данные в виде объекта</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>object</type><type>false</type></type><methodname>pg_fetch_object</methodname>
   <methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>row</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>class</parameter><initializer>"stdClass"</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>constructor_args</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>pg_fetch_object</function> возвращает объект, свойства которого
   соответствуют именам полей выборки. Функция опционально создаёт экземпляр
   конкретного класса и передаёт параметры конструктору этого класса.
  </para>
  &database.fetch-null;
  <para>
   По скорости функция идентична функции <function>pg_fetch_array</function>
   и немного медленней функции <function>pg_fetch_row</function>;
   разница незначительна.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      &pgsql.parameter.result;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row</parameter></term>
     <listitem>
      <para>
       Номер строки, которую функция выбирает из результата запроса. Нумерация начинается
       с нуля. Функция берёт следующую по очереди строку, если аргумент опущен или равен &null;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>class</parameter></term>
      <listitem>
       <para>
        Имя класса объекта, который создаст и вернёт функция. Если не задано,
        функция создаст экземпляр класса <classname>stdClass</classname>.
       </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>constructor_args</parameter></term>
      <listitem>
       <para>
        Необязательный массив (<type>array</type>) параметров для передачи в конструктор
        объекта <parameter>class</parameter>.
       </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает объект (<type>object</type>), имена и значения свойств которого соответствуют
   именам и значениям полей результата запроса. Функция преобразовывает значения <literal>NULL</literal>
   базы данных в значения PHP &null;.
  </para>
  <para>
   Функция возвращает значение &false;, если значение параметра
   <parameter>row</parameter> превышает число строк в результате запроса,
   когда строк в результате не осталось, и при прочих ошибках.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выбросит исключение <classname>ValueError</classname>,
   если в параметр <parameter>constructor_args</parameter> передали не пустой массив,
   а у класса нет конструктора.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Функция теперь выбрасывает исключение a <classname>ValueError</classname>,
       если в параметр <parameter>constructor_args</parameter> передали не пустой массив,
       а у класса нет конструктора;
       раньше функция выбрасывала исключение <classname>Exception</classname>.
      </entry>
     </row>
     &pgsql.changelog.result-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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

$database = "store";

$db_conn = pg_connect("host=localhost port=5432 dbname=$database");
if (!$db_conn) {
  echo "Невозможно соединиться с базой postgres $database\n";
  exit;
}

$qu = pg_query($db_conn, "SELECT * FROM books ORDER BY author");


while ($data = pg_fetch_object($qu)) {
  echo $data->author . " (";
  echo $data->year . "): ";
  echo $data->title . "<br />";
}

pg_free_result($qu);
pg_close($db_conn);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_query</function></member>
    <member><function>pg_fetch_array</function></member>
    <member><function>pg_fetch_assoc</function></member>
    <member><function>pg_fetch_row</function></member>
    <member><function>pg_fetch_result</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
-->