pg-set-client-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-set-client-encoding" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_set_client_encoding</refname>
  <refpurpose>
   Устанавливает клиентскую кодировку
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pg_set_client_encoding</methodname>
   <methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>encoding</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_set_client_encoding</function> устанавливает клиентскую
   кодировку и возвращает 0 в случае успешного выполнения, -1 в случае возникновения ошибки.
  </para>
  <para>
   PostgreSQL автоматически конвертирует данные из кодировки базы данных
   в кодировку клиентского приложения.
  </para>
  <note>
   <para>
    Прежнее название функции: <function>pg_setclientencoding</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection-with-unspecified-default;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       Требуемая клиентская кодировка. Список возможных значений:
       <literal>SQL_ASCII</literal>, <literal>EUC_JP</literal>,
       <literal>EUC_CN</literal>, <literal>EUC_KR</literal>,
       <literal>EUC_TW</literal>, <literal>UNICODE</literal>,
       <literal>MULE_INTERNAL</literal>, <literal>LATINX</literal> (X=1...9),
       <literal>KOI8</literal>, <literal>WIN</literal>,
       <literal>ALT</literal>, <literal>SJIS</literal>,
       <literal>BIG5</literal> or <literal>WIN1250</literal>.
      </para>
      <para>
       Список доступных кодировок зависит от версии PostgreSQL. Смотрите
       документацию к вашей версии сервера.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает <literal>0</literal> в случае успешного выполнения, либо <literal>-1</literal> в случае возникновения ошибки.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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

$conn = pg_pconnect("dbname=publisher");
if (!$conn) {
  echo "Произошла ошибка.\n";
  exit;
}

// Установка кодировки в UNICODE. Данные будут автоматически
// преобразованы из кодировки в базе данных к клиентской.
pg_set_client_encoding($conn, "UNICODE");

$result = pg_query($conn, "SELECT author, email FROM authors");
if (!$result) {
  echo "Произошла ошибка.\n";
  exit;
}

// Выводим UTF-8 данные
while ($row = pg_fetch_row($result)) {
  echo "Author: $row[0]  E-mail: $row[1]";
  echo "<br />\n";
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_client_encoding</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
-->