mb-scrub.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 77a60306bc47d2151ebca7e6983897a0371a9671 Maintainer: mumumu Status: ready -->

<refentry xml:id="function.mb-scrub" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_scrub</refname>
  <refpurpose>文字列に含まれる不正なバイト列を代替文字に置き換える</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_scrub</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   指定されたエンコーディングに基づいて、文字の変換を行います。
   エンコーディングが指定されない場合は、
   デフォルトのエンコーディングが使われます。
   この関数は、不正なバイトシーケンスを代替文字に置換する効果があります。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>string</parameter></term>
    <listitem>
     <para>
      入力文字列
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      <parameter>string</parameter> を解釈するエンコーディング。
      省略されるか、&null; でない場合は、
      <link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding setting</link> が設定されている場合、それを使います。
      設定されていない場合は、<link linkend="ini.default-charset">default_charset</link> の設定を使います。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <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>

</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
-->