archived-doc-ru/reference/pgsql/functions/pg-convert.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 39bb8a868935a56cfce438b0169e13c02c93211c Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-convert" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_convert</refname>
  <refpurpose>
   Преобразовывает значения ассоциативного массива в вид, который соответствует SQL-запросам
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>pg_convert</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>pg_convert</function> проверяет и преобразовывает значения
   массива <parameter>values</parameter> в значения, которые соответствуют формату SQL-выражения.
   Предварительное условие функции <function>pg_convert</function> —
   таблица <parameter>table_name</parameter> должна существовать, а количество колонок
   в таблице должно быть не меньше количества значений в массиве <parameter>values</parameter>.
   Имена колонок в таблице <parameter>table_name</parameter> должны совпадать
   с ключами массива <parameter>values</parameter>, типы данных значений массива
   также должны совпадать с типами данных колонок. В случае удачной
   конвертации функция возвращает массив преобразованных значений, иначе возвращает &false;.
  </para>
  <note>
   <para>
    Логические значения преобразовываются в логический тип СУБД PostgreSQL.
    Поддерживаются также строковые представления логического значения.
    Значение &null; преобразовывается в значения NULL СУБД PostgreSQL.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Имя таблицы базы данных.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Данные для преобразования.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Одна или комбинация констант <constant>PGSQL_CONV_IGNORE_DEFAULT</constant>,
       <constant>PGSQL_CONV_FORCE_NULL</constant> или
       <constant>PGSQL_CONV_IGNORE_NOT_NULL</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает массив (<type>array</type>),
   который содержит преобразованные данные&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выбрасывает исключение <classname>ValueError</classname> или <classname>TypeError</classname>,
   если значение или тип поля не соответствует правильному типу СУБД PostgreSQL.
  </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>
       Функция теперь выбрасывает исключение <classname>ValueError</classname>
       или <classname>TypeError</classname>,
       если значение или тип поля не соответствуют правильному типу СУБД PostgreSQL;
       раньше функция выдавала ошибку уровня <constant>E_WARNING</constant>.
      </entry>
     </row>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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

$dbconn = pg_connect('dbname=foo');

$tmp = array(
    'author' => 'Joe Thackery',
    'year' => 2005,
    'title' => 'My Life, by Joe Thackery'
);

$vals = pg_convert($dbconn, 'authors', $tmp);

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_meta_data</function></member>
    <member><function>pg_insert</function></member>
    <member><function>pg_select</function></member>
    <member><function>pg_update</function></member>
    <member><function>pg_delete</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
-->