1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?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>&#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
-->
|
