Repository navigation
Expand file tree
/
Copy pathmb-convert-variables.xml
More file actions
128 lines (123 loc) · 4.39 KB
/
Copy pathmb-convert-variables.xml
File metadata and controls
128 lines (123 loc) · 4.39 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2bc5ed7ad57629c4fbd299f352c38e57099cfedd Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_convert_variables</refname>
<refpurpose>変数の文字コードを変換する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_convert_variables</methodname>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>from_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
</methodsynopsis>
<para>
エンコーディング
<parameter>from_encoding</parameter> の変数
<parameter>var</parameter> と <parameter>vars</parameter> をエンコーディング
<parameter>to_encoding</parameter> に変換します。
</para>
<para>
<function>mb_convert_variables</function> は、エンコーディング検出のために
Array または Object の文字列を結合します。これは、
エンコーディング検出は短い文字列では失敗する傾向があるためです。このため、
1 つの配列またはオブジェクトで異なるエンコーディングを混ぜることはできません。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>to_encoding</parameter></term>
<listitem>
<para>
文字列の変換後のエンコーディング。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>from_encoding</parameter></term>
<listitem>
<simpara>
変数の現在のエンコーディング。
配列またはカンマ区切りの文字列とすることで、
複数のエンコーディングを指定できます。
この場合、指定したエンコーディングの中から検出します。
<literal>"auto"</literal> は、INI 設定
<link linkend="ini.mbstring.language">mbstring.language</link>
に従って展開されます。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
<parameter>var</parameter>(3番目以降の引数)は、変換する変数への
リファレンスです。文字列、配列、オブジェクトを指定することが可能です。
<function>mb_convert_variables</function> は全てのパラメータが
同じエンコーディングを有することを仮定します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>vars</parameter></term>
<listitem>
<para>
追加の変数。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功時に変換前の文字エンコーディングを返し、失敗した場合に &false; を返します。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mb_convert_variables</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
/* 変数 $post1, $post2 を内部エンコーディングに変換する */
$interenc = mb_internal_encoding();
$inputenc = mb_convert_variables($interenc, "ASCII,UTF-8,SJIS-win", $post1, $post2);
?>
]]>
</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
-->