mb-substitute-character.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_substitute_character</refname>
  <refpurpose>Set/Get substitution character</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>int</type><type>bool</type></type><methodname>mb_substitute_character</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>int</type><type>null</type></type><parameter>substitute_character</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Specifies a substitution character when input character encoding is invalid
   or character code does not exist in output character
   encoding. Invalid characters may be substituted <literal>"none"</literal> (no output),
   <type>string</type> or <type>int</type> value (Unicode character code value).
  </para>
  <para>
   This setting affects <function>mb_convert_encoding</function>,
   <function>mb_convert_variables</function>,
   <function>mb_output_handler</function>,
   <function>mb_scrub</function>,
   and <function>mb_send_mail</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>substitute_character</parameter></term>
     <listitem>
      <para>
       Specify the Unicode value as an <type>int</type>, 
       or as one of the following <type>string</type>s:
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>"none"</literal>: no output
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>"long"</literal>: Output character code value (Example:
          <literal>U+3000</literal>, <literal>JIS+7E7E</literal>)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>"entity"</literal>: Output character entity (Example:
          <literal>&amp;#x200;</literal>)
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If <parameter>substitute_character</parameter> is set, it returns &true; for success,
   otherwise returns &false;. 
   If <parameter>substitute_character</parameter> is not set, it returns the current
   setting.
  </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>
       Passing an empty string to <parameter>substitute_character</parameter>
       is no longer supported; <literal>"none"</literal> should be passed instead.
      </entry>
     </row>
     &mbstring.changelog.encoding-nullable;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mb_substitute_character</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* Set with Unicode U+3013 (GETA MARK) */
mb_substitute_character(0x3013);

/* Set hex format */
mb_substitute_character("long");

/* Display current setting */
echo mb_substitute_character();
?>
]]>
    </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
-->