mb-regex-set-options.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1a025802f7201d353c1c1c4dccc7d9d6fdf563d4 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_regex_set_options</refname>
  <refpurpose>
   Устанавливает или получает значение по умолчанию для настроек функций mbregex
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_regex_set_options</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Устанавливает параметры по умолчанию, описанные в параметре <parameter>options</parameter>, для функций
   регулярных выражений, работающих со строками в многобайтных кодировках.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Настройки, которые нужно задать. Это строка, в которой каждый
       символ отвечает за какую-то настройку. Чтобы установить режим,
       необходимо указать его символ в конце строки, однако, можно задать только один режим,
       но несколько опций.
      </para>

      <table>
       <title>Настройки регулярных выражений</title>
       <tgroup cols="3">
        <thead>
         <row>
          <entry>Настройка</entry>
          <entry>Описание</entry>
          <entry>&Changelog;</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>i</entry>
          <entry>Включение неоднозначных совпадений</entry>
          <entry></entry>
         </row>
         <row>
          <entry>x</entry>
          <entry>Включает форму расширенного шаблона</entry>
          <entry></entry>
         </row>
         <row>
          <entry>m</entry>
          <entry><literal>'.'</literal> совпадения с переводами строк</entry>
          <entry></entry>
         </row>
         <row>
          <entry>s</entry>
          <entry><literal>«^»</literal> → <literal>«\A»</literal>, <literal>«$»</literal> → <literal>«\Z»</literal></entry>
          <entry></entry>
         </row>
         <row>
          <entry>p</entry>
          <entry>То же, что и объединение настроек <literal>m</literal> и <literal>s</literal></entry>
          <entry></entry>
         </row>
         <row>
          <entry>l</entry>
          <entry>Поиск совпадений с наибольшей длиной</entry>
          <entry></entry>
         </row>
         <row>
          <entry>n</entry>
          <entry>Игнорировать пустые совпадения</entry>
          <entry></entry>
         </row>
         <row>
          <entry>e</entry>
          <entry>Вычисление кода результата функцией <function>eval</function></entry>
          <entry>Объявлено устаревшим в PHP 7.1.0 и удалено в PHP 8.0.0</entry>
         </row>
        </tbody>
       </tgroup>
      </table>
      <note>
       <para>
        Настройка <literal>«e»</literal> не даёт эффекта при установке через функцию <function>mb_regex_set_options</function>.
        Её указывают с функциями <function>mb_ereg_replace</function> или <function>mb_eregi_replace</function>.
       </para>
      </note>
      <table>
       <title>Синтаксические режимы регулярных выражений (может быть задан только один)</title>
       <tgroup cols="2">
        <thead>
         <row>
          <entry>Режим</entry>
          <entry>Описание</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>j</entry>
          <entry>Java (Sun java.util.regex)</entry>
         </row>
         <row>
          <entry>u</entry>
          <entry>Регулярные выражения GNU</entry>
         </row>
         <row>
          <entry>g</entry>
          <entry>grep</entry>
         </row>
         <row>
          <entry>c</entry>
          <entry>Emacs</entry>
         </row>
         <row>
          <entry>r</entry>
          <entry>Ruby</entry>
         </row>
         <row>
          <entry>z</entry>
          <entry>Perl</entry>
         </row>
         <row>
          <entry>b</entry>
          <entry>Регулярные выражения POSIX Basic</entry>
         </row>
         <row>
          <entry>d</entry>
          <entry>Регулярные выражения POSIX Extended</entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает предыдущие настройки. Если параметр <parameter>options</parameter> опущен или равен &null;,
   возвращает строку (<type>string</type>), которая описывает текущие параметры.
  </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.0.0</entry>
      <entry>
       Если параметр <parameter>options</parameter> задан и не равен &null;,
       возвращаются <emphasis>предыдущие</emphasis>
       параметры. Ранее возвращались <emphasis>текущие</emphasis> параметры.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Параметр <parameter>options</parameter> теперь может принимать значение &null;.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Опция <literal>«e»</literal> теперь выбрасывает исключение <classname>ValueError</classname>.
      </entry>
     </row>
     <row>
      <entry>7.1.0</entry>
      <entry>
       Опция <literal>«e»</literal> теперь выдаёт ошибку уровня <classname>ValueError</classname>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_split</function></member>
    <member><function>mb_ereg</function></member>
    <member><function>mb_eregi</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
-->