-
Notifications
You must be signed in to change notification settings - Fork 57
/
array-filter.xml
289 lines (268 loc) · 6.92 KB
/
array-filter.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 31cacb6f262f455c616094cfe6d09bc0d1df2748 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<refentry xml:id="function.array-filter" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_filter</refname>
<refpurpose>
コールバック関数を使用して、配列の要素をフィルタリングする
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_filter</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<parameter>callback</parameter>
関数によりフィルタ処理が行われた <parameter>array</parameter>
の全ての要素を含む配列を返します。
<parameter>callback</parameter> 関数が &true; を返した場合、
<parameter>array</parameter> の現在の値が結果の配列に入ります。
</para>
<para>
配列のキーは保存されます。
<parameter>array</parameter> にインデックスが振られていた場合、結果が異なる場合があります。
結果の &array; のインデックスは、 <function>array_values</function> 関数を使って振り直すことができます。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
処理する配列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
使用するコールバック関数。
</para>
<para>
コールバック関数が与えられなかった場合、
<parameter>array</parameter> のエントリの中で空のものはすべて削除されます。
この場合の「空」の定義については、<function>empty</function> 関数を参照ください。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
引数として、何を <parameter>callback</parameter> に送るのかを決めるフラグ。
<itemizedlist>
<listitem>
<simpara><constant>ARRAY_FILTER_USE_KEY</constant> - 値ではなく、キーだけを
<parameter>callback</parameter> の引数として渡す</simpara>
</listitem>
<listitem>
<simpara><constant>ARRAY_FILTER_USE_BOTH</constant> - 値だけではなく、値とキーの両方を
<parameter>callback</parameter> の引数として渡す</simpara>
</listitem>
</itemizedlist>
デフォルトは <literal>0</literal> で値のみを<parameter>callback</parameter>の引数として渡します。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
フィルタリングされた結果の配列を返します。
</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>callback</parameter> は、nullable になりました。
</entry>
</row>
&array.changelog.by-ref;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<!--
<refsect1 role="errors">
&reftitle.errors;
&errors.no.unusual.errors;
</refsect1>
-->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_filter</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
function odd($var)
{
// 渡された整数が奇数かどうかを返します
return $var & 1;
}
function even($var)
{
// 渡された整数が偶数かどうかを返します
return !($var & 1);
}
$array1 = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5];
$array2 = [6, 7, 8, 9, 10, 11, 12];
echo "Odd :\n";
print_r(array_filter($array1, "odd"));
echo "Even:\n";
print_r(array_filter($array2, "even"));
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
Odd :
Array
(
[a] => 1
[c] => 3
[e] => 5
)
Even:
Array
(
[0] => 6
[2] => 8
[4] => 10
[6] => 12
)
]]>
</screen>
</example>
<example>
<title><parameter>callback</parameter> がない
<function>array_filter</function>
</title>
<programlisting role="php">
<![CDATA[
<?php
$entry = [
0 => 'foo',
1 => false,
2 => -1,
3 => null,
4 => '',
5 => '0',
6 => 0,
];
print_r(array_filter($entry));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[0] => foo
[2] => -1
)
]]>
</screen>
</example>
<example>
<title><function>array_filter</function> で
<parameter>mode</parameter> を使う例</title>
<programlisting role="php">
<![CDATA[
<?php
$arr = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4];
var_dump(array_filter($arr, function($k) {
return $k == 'b';
}, ARRAY_FILTER_USE_KEY));
var_dump(array_filter($arr, function($v, $k) {
return $k == 'b' || $v == 4;
}, ARRAY_FILTER_USE_BOTH));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
["b"]=>
int(2)
}
array(2) {
["b"]=>
int(2)
["d"]=>
int(4)
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<caution>
<para>
配列の内容がコールバック関数内で変更された場合
(たとえば要素が追加されたり削除されたりなど)
のこの関数の挙動は未定義です。
</para>
</caution>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>array_intersect</function></member>
<member><function>array_map</function></member>
<member><function>array_reduce</function></member>
<member><function>array_walk</function></member>
</simplelist>
</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
-->