mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
1266a49f87
Sometimes it has been written as "substrchar" and sometimes as "substchar". The latter makes more sense since there is no "r" in "substitute", so we use it throughout. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343156 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.3 KiB
XML
119 lines
3.3 KiB
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>mixed</type><methodname>mb_substitute_character</methodname>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>substchar</parameter><initializer>mb_substitute_character()</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 &null; (no output),
|
|
<type>string</type> or <type>integer</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>,
|
|
and <function>mb_send_mail</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>substchar</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the Unicode value as an <type>integer</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>&#x200;</literal>)
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
If <parameter>substchar</parameter> is set, it returns &true; for success,
|
|
otherwise returns &false;.
|
|
If <parameter>substchar</parameter> is not set, it returns the current
|
|
setting.
|
|
</para>
|
|
</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
|
|
-->
|