mb-convert-variables.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 92f1b8b177eb5730382abf9f27bae868f1bb636f Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_convert_variables</refname>
  <refpurpose>
   Преобразовывает символы в переменной(-ых) из одной кодировки в другую
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>mb_convert_variables</methodname>
   <methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>from_encoding</parameter></methodparam>
   <methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
  </methodsynopsis>
  <para>
   Конвертирует символы в переменных <parameter>var</parameter> и <parameter>vars</parameter> из
   кодировки, указанной в параметре <parameter>from_encoding</parameter>, в кодировку,
   указанную в параметре <parameter>to_encoding</parameter>.
  </para>
  <para>
   Функция <function>mb_convert_variables</function> объединяет строки из массива
   или объекта для определения их кодировки, так как в случае коротких строк
   определить кодировку часто не удаётся. Поэтому недопустимо
   помещать в один массив или объект строки в разных кодировках.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>to_encoding</parameter></term>
     <listitem>
      <para>
       Кодировка, в которую необходимо перекодировать строку (<type>string</type>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>from_encoding</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>from_encoding</parameter> задаётся в виде массива (<type>array</type>)
       или строки (<type>string</type>) с разделёнными запятой кодировками,
       функция попытается определить кодировку исходной
       строки на основе списка кодировок, заданных
       в параметре <parameter>from-coding</parameter>. Если параметр <parameter>from_encoding</parameter>
       не задан, будет выбрана кодировка, из INI-директивы с именем <literal>detect_order</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>var</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>var</parameter> — это ссылка на переменную, которую
       нужно преобразовать. Это может быть строка (<type>string</type>), массив (<type>array</type>) или объект (<type>object</type>).
       Функция <function>mb_convert_variables</function> предполагает, что для всех параметров
       задана одинаковая кодировка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>vars</parameter></term>
     <listitem>
      <para>
       Дополнительные <parameter>var</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает исходную кодировку в случае успешного выполнения или &false; в случае возникновения ошибки.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>mb_convert_variables</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/* Преобразование переменных $post1, $post2 во внутреннюю кодировку скрипта */
$interenc = mb_internal_encoding();
$inputenc = mb_convert_variables($interenc, "ASCII,UTF-8,SJIS-win", $post1, $post2);
?>
]]>
    </programlisting>
   </example>
  </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
-->