mb-regex-set-options.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1a025802f7201d353c1c1c4dccc7d9d6fdf563d4 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<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>マルチバイト正規表現関数のデフォルトオプションを取得または設定する</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>Regex のオプション</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>
        <function>mb_regex_set_options</function> に <literal>"e"</literal>
        オプションを設定しても、何も起きません。
        <function>mb_ereg_replace</function> や <function>mb_eregi_replace</function> で指定するようにしてください。
       </para>
      </note>
      <table>
       <title>Regex 構文モード(ひとつだけ設定可能です)</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 regex</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 regex</entry>
         </row>
         <row>
          <entry>d</entry>
          <entry>POSIX Extended regex</entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   以前設定されていたオプションを返します。
   <parameter>options</parameter> が省略された場合、または &null; の場合、
   現在設定されているオプションを文字列で返します。
  </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> は、nullable になりました。
      </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> オプションを指定すると、<constant>E_DEPRECATED</constant> が発生するようになりました。
      </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
-->