archived-doc-ru/reference/iconv/functions/iconv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a223531900823441f82d178ca4e94c0444f24576 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.iconv" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>iconv</refname>
  <refpurpose>Преобразовывает строку из одной кодировки символов в другую</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>iconv</methodname>
   <methodparam><type>string</type><parameter>from_encoding</parameter></methodparam>
   <methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   Преобразовывает строку <parameter>string</parameter> из кодировки <parameter>from_encoding</parameter>
   в кодировку <parameter>to_encoding</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>from_encoding</parameter></term>
     <listitem>
      <para>
       Текущая кодировка, используемая для интерпретации параметра <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>to_encoding</parameter></term>
     <listitem>
      <para>
       Требуемая на выходе кодировка.
      </para>
      <para>
       Если к параметру <parameter>to_encoding</parameter> добавлена строка
       <literal>//TRANSLIT</literal>, включается режим транслитерации.
       Это значит, что в случае, если символ не может быть представлен в требуемой кодировке,
       он может быть заменён одним или несколькими похожими символами.
       Если добавлена строка <literal>//IGNORE</literal>, то символы,
       которые не могут быть представлены в требуемой кодировке, будут
       удалены.
       В случае отсутствия вышеуказанных параметров
       будет сгенерирована ошибка уровня <constant>E_NOTICE</constant>,
       а функция вернёт &false;.
      </para>
      <caution>
       <para>
        Как будет работать <literal>//TRANSLIT</literal> и будет ли вообще, зависит от
        системной реализации iconv() (<constant>ICONV_IMPL</constant>).
        Известны некоторые реализации, которые просто игнорируют
        <literal>//TRANSLIT</literal>, так что конвертация для символов некорректных
        для <parameter>to_encoding</parameter> скорее всего закончится ошибкой.
       </para>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Строка (&string;) для преобразования.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает преобразованную строку&return.falseforfailure;.
  </para>
 </refsect1>

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

echo 'Исходная строка        : ', $text, PHP_EOL;
echo 'С добавлением TRANSLIT : ', iconv("UTF-8", "ISO-8859-1//TRANSLIT", $text), PHP_EOL;
echo 'С добавлением IGNORE   : ', iconv("UTF-8", "ISO-8859-1//IGNORE", $text), PHP_EOL;
echo 'Обычное преобразование : ', iconv("UTF-8", "ISO-8859-1", $text), PHP_EOL;

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Исходная строка        : Это символ евро - '€'.
С добавлением TRANSLIT : Это символ евро - 'EUR'.
С добавлением IGNORE   :Это символ евро - ''.
Обычное преобразование :
Notice: iconv(): Detected an illegal character in input string in .\iconv-example.php on line 7
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Доступные кодировки и опции зависят от установленной реализации iconv.
    Если параметр <parameter>from_encoding</parameter> или <parameter>from_encoding</parameter>
    не поддерживается в текущей системе, будет возвращено значение &false;.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_convert_encoding</function></member>
    <member><methodname>UConverter::transcode</methodname></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
-->