mb-detect-order.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 92f1b8b177eb5730382abf9f27bae868f1bb636f Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_detect_order</refname>
  <refpurpose>
   Устанавливает или получает порядок определения кодировки символов
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>bool</type></type><methodname>mb_detect_order</methodname>
   <methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Устанавливает порядок автоматического определения кодировки символов
   в значение, переданное в параметр <parameter>encoding</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>encoding</parameter> — массив (<type>array</type>) или
       разделённый запятыми список кодировок символов. Подробнее о существующих в PHP кодировках символов рассказано
       в разделе «<link linkend="mbstring.supported-encodings">Поддерживаемые кодировки символов</link>».
      </para>
      <para>
       Если параметр <parameter>encoding</parameter> не задан или равен &null;, функция вернёт
       текущий порядок определения кодировок символов в виде массива.
      </para>
      <para>
       Эта настройка влияет на работу функций
       <function>mb_detect_encoding</function> и <function>mb_send_mail</function>.
      </para>
      <para>
       Модуль <literal>mbstring</literal> содержит следующие
       фильтры определения кодировок. Если для следующих кодировок существует
       недопустимая последовательность байтов, определение кодировки завершится неудачно:
      </para>
      <simpara>
       <literal>UTF-8</literal>, <literal>UTF-7</literal>,
       <literal>ASCII</literal>,
       <literal>EUC-JP</literal>,<literal>SJIS</literal>,
       <literal>eucJP-win</literal>, <literal>SJIS-win</literal>,
       <literal>JIS</literal>, <literal>ISO-2022-JP</literal>
      </simpara>
      <para>
       Модуль <literal>mbstring</literal> определяет кодировку <literal>ISO-8859-*</literal>
       как <literal>ISO-8859-*</literal>.
      </para>
      <para>
       Определение кодировок <literal>UTF-16</literal>, <literal>UTF-32</literal>,
       <literal>UCS2</literal> и <literal>UCS4</literal>
       всегда будет неудачным.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

  <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &mbstring.changelog.encoding-nullable;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>mb_detect_order</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/* Установка порядка определения списком перечисленных кодировок */
mb_detect_order("eucjp-win,sjis-win,UTF-8");

/* Установка порядка определения массивом */
$ary[] = "ASCII";
$ary[] = "JIS";
$ary[] = "EUC-JP";
mb_detect_order($ary);

/* Отображение текущего порядка обнаружения */
echo implode(", ", mb_detect_order());
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Пример бесполезных порядков определения</title>
    <programlisting>
<![CDATA[
; Всегда определяет как ISO-8859-1
detect_order = ISO-8859-1, UTF-8

; Всегда определяет как UTF-8, так как ASCII/UTF-7 —
; подмножество UTF-8
detect_order = UTF-8, ASCII, UTF-7
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_internal_encoding</function></member>
    <member><function>mb_http_input</function></member>
    <member><function>mb_http_output</function></member>
    <member><function>mb_send_mail</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
-->