-
Notifications
You must be signed in to change notification settings - Fork 72
/
mb-substitute-character.xml
148 lines (138 loc) · 5.09 KB
/
mb-substitute-character.xml
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
144
145
146
147
148
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d023b296f3cfb211f2f3b5a2c39440fe42855e7a Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<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>Устанавливает или получает символ замены</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>
Задаёт замещающий символ на случай, когда кодировка входных данных задана
неверно или код символа не существует в кодировке выходных данных.
Недопустимые символы могут быть заменены на <literal>«none»</literal> (нет вывода),
строку (<type>string</type>) или числовое значение (<type>int</type>)
(код символа Юникода).
</para>
<para>
Эта настройка влияет на поведение следующих функций:
<function>mb_convert_encoding</function>,
<function>mb_convert_variables</function>,
<function>mb_output_handler</function>,
<function>mb_scrub</function>
и <function>mb_send_mail</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>substitute_character</parameter></term>
<listitem>
<para>
Задаёт значение Юникода в виде целого числа (<type>int</type>) или одной
из следующих строк <type>string</type>:
<itemizedlist>
<listitem>
<simpara>
<literal>«none»</literal>: нет вывода
</simpara>
</listitem>
<listitem>
<simpara>
<literal>«long»</literal>: код конечного (в выходной кодировке)
символа (например: <literal>U+3000</literal>, <literal>JIS+7E7E</literal>)
</simpara>
</listitem>
<listitem>
<simpara>
<literal>«entity»</literal>: сущность конечного (в выходной кодировке)
символа (например: <literal>&#x200;</literal>)
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Если аргумент <parameter>substitute_character</parameter> установили, функция вернёт &true;
в случае успешного выполнения, иначе &false;.
Функция вернёт текущую настройку,
если символ <parameter>substitute_character</parameter> не установили.
</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>substitute_character</parameter>
больше не поддерживается; вместо этого передают значение <literal>"none"</literal>.
</entry>
</row>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования функции <function>mb_substitute_character</function></title>
<programlisting role="php">
<![CDATA[
<?php
/* Установка замещающего символа Unicode U+3013 (GETA MARK) */
mb_substitute_character(0x3013);
/* Задаём шестнадцатеричный формат */
mb_substitute_character("long");
/* Отображение текущей настройки */
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
-->