-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy patharray.xml
More file actions
1616 lines (1428 loc) · 44.5 KB
/
array.xml
File metadata and controls
1616 lines (1428 loc) · 44.5 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
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3061900171d4ae84d532571bfd6eda823726dad4 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<sect1 xml:id="language.types.array">
<title>配列</title>
<para>
全ての配列関数の一覧は、<link linkend="ref.array">配列関数</link>
を参照ください。
</para>
<para>
PHP の配列は、実際には順番付けられたマップです。マップは型の一種で、
<emphasis>値</emphasis>を<emphasis>キー</emphasis>に関連付けます。
この型は、さまざまな使い道にあわせて最適化されます。
配列としてだけでなく、リスト (ベクター)、
ハッシュテーブル (マップの実装の一つ)、辞書、コレクション、スタック、
キュー等として使用することが可能です。
PHP の配列には他の PHP 配列を値として保持することができるため、
非常に簡単にツリー構造を表現することが可能です。
</para>
<para>
これらのデータ構造に関する説明は本マニュアルの範囲を超えるので省略しますが、
各々について、少なくとも一つは例を示します。
この分野は広範囲にまたがり、さまざまな文献が存在します。
より詳細な情報については、それらの文献を参照ください。
</para>
<sect2 xml:id="language.types.array.syntax">
<title>構文</title>
<sect3 xml:id="language.types.array.syntax.array-func">
<title><function>array</function> で指定</title>
<para>
配列(<type>array</type>)は、言語に組み込まれた
<function>array</function> で作成することが可能です。この構造は、
特定の数のカンマで区切られた
<literal><replaceable>key</replaceable> => <replaceable
>value</replaceable></literal> の組を引数とします。
</para>
<synopsis>
array(
<optional><replaceable>key</replaceable> => </optional><replaceable>value</replaceable>,
<optional><replaceable>key2</replaceable> => </optional><replaceable>value2</replaceable>,
<optional><replaceable>key3</replaceable> => </optional><replaceable>value3</replaceable>,
...
)</synopsis>
<!-- Do not fix the whitespace for the synopsis end element. A limitation of PhD prevents proper trimming -->
<para>
最後の要素のあとのカンマは、書いても書かなくてもかまいません。
配列を一行で定義する場合は、ふつうは最後のカンマを省略します。つまり、
<literal>array(1, 2)</literal> のほうが
<literal>array(1, 2, )</literal> よりおすすめだということです。
しかし複数行で定義する場合は、最後のカンマをつけることが一般的です。
そうしておけば、配列の最後に要素を追加するのが容易になるからです。
</para>
<note>
<para>
<literal>array()</literal> を <literal>[]</literal>
で置き換えることが出来る、配列の短縮構文も使えます。
</para>
</note>
<example>
<title>シンプルな配列定義</title>
<programlisting role="php">
<![CDATA[
<?php
$array1 = array(
"foo" => "bar",
"bar" => "foo",
);
// 配列の短縮構文
$array2 = [
"foo" => "bar",
"bar" => "foo",
];
var_dump($array1, $array2);
?>
]]>
</programlisting>
</example>
<para>
<varname>key</varname> は、<type>int</type> または
<type>string</type>です。
<replaceable>value</replaceable> には任意の型を指定できます。
</para>
<para xml:id="language.types.array.key-casts">
さらに、次のような <replaceable>key</replaceable> のキャストが発生します。
<itemizedlist>
<listitem>
<simpara>
10 進数の <type>int</type> として妥当な形式の <type>String</type> は、
数値の前に <literal>+</literal> 記号がついていない限り、
<type>int</type> 型にキャストされます。
つまり、キーに <literal>"8"</literal> を指定すると、実際には
<literal>8</literal> として格納されるということです。一方 <literal>"08"</literal>
はキャストされません。これは十進数として妥当な形式ではないからです。
</simpara>
</listitem>
<listitem>
<simpara>
<type>float</type>s もまた <type>int</type> にキャストされます。つまり、
小数部分は切り捨てられるということです。たとえばキーに <literal>8.7</literal> を指定すると、実際には
<literal>8</literal> として格納されます。
</simpara>
</listitem>
<listitem>
<simpara>
<type>bool</type> も <type>int</type> にキャストされます。つまり、
キーに &true; を指定すると実際には <literal>1</literal> に格納され、
同様にキーを &false; とすると実際には <literal>0</literal> となります。
</simpara>
</listitem>
<listitem>
<simpara>
<type>Null</type> は空文字列にキャストされます。つまり、キーに
<literal>null</literal> を指定すると、実際には <literal>""</literal> として格納されます。
</simpara>
</listitem>
<listitem>
<simpara>
<type>array</type> や <type>object</type> は、キーとして<emphasis>使えません</emphasis>。
キーとして使おうとすると <literal>Illegal offset type</literal> という警告が発生します。
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
配列の宣言時に同じキーで複数の要素を指定すると、
最後に指定したものがそれまでの値を上書きします。
</para>
<example>
<title>型のキャストと値の上書きの例</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(
1 => "a",
"1" => "b",
1.5 => "c",
true => "d",
);
var_dump($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
[1]=>
string(1) "d"
}
]]>
</screen>
<para>
上の例では、すべてのキーが <literal>1</literal> にキャストされます。
そして後から指定した値がどんどん前の値を上書きしていき、最終的には最後に代入された
<literal>"d"</literal> だけが残ります。
</para>
</example>
<para>
PHP においては添字配列と連想配列の間に違いはなく、配列型は 1 つだけで、
同じ配列で整数のインデックスと文字列のインデックスを同時に使えます。
</para>
<example>
<title>整数と文字列のキーの混在例</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(
"foo" => "bar",
"bar" => "foo",
100 => -100,
-100 => 100,
);
var_dump($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(4) {
["foo"]=>
string(3) "bar"
["bar"]=>
string(3) "foo"
[100]=>
int(-100)
[-100]=>
int(100)
}
]]>
</screen>
</example>
<para>
<replaceable>key</replaceable> はオプションです。省略した場合、PHP
はこれまでに使われた整数のキーの中で最大のものに 1 を加えた値を使います。
</para>
<example>
<title>数値添字配列でキーを省略する例</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array("foo", "bar", "hello", "world");
var_dump($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(4) {
[0]=>
string(3) "foo"
[1]=>
string(3) "bar"
[2]=>
string(5) "hello"
[3]=>
string(5) "world"
}
]]>
</screen>
</example>
<para>
一部の要素にだけキーを指定することもできます。
</para>
<example>
<title>一部の要素にだけキーを指定する例</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(
"a",
"b",
6 => "c",
"d",
);
var_dump($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(4) {
[0]=>
string(1) "a"
[1]=>
string(1) "b"
[6]=>
string(1) "c"
[7]=>
string(1) "d"
}
]]>
</screen>
<para>
ごらんの通り、最後の値である <literal>"d"</literal> のキーは
<literal>7</literal> となります。それまでにキーとして使われた最大の整数が
<literal>6</literal> だからです。
</para>
</example>
<example>
<title>複雑な型のキャストと上書きの例</title>
<para>
以下の例は、型のキャストされた時と、要素が上書きされる時の全ての場合を示しています。
</para>
<programlisting role="php">
<![CDATA[
<?php
$array = array(
1 => 'a',
'1' => 'b', // 値 "a" は "b" で上書きされます。
1.5 => 'c', // 値 "b" は "c" で上書きされます。
-1 => 'd',
'01' => 'e', // この値は数値形式の文字列ではないので、キー1を上書きしません
'1.5' => 'f', // この値は数値形式の文字列ではないので、キー1を上書きしません
true => 'g', // 値 "c" は "g" で上書きされます。
false => 'h',
'' => 'i',
null => 'j', // 値 "i" は "j" で上書きされます。
'k', // 値 "k" にはキー2が割り当てられます。なぜなら、これより前のキーの最大値は1だからです。
2 => 'l', // 値 "k" は "l" で上書きされます。
);
var_dump($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(7) {
[1]=>
string(1) "g"
[-1]=>
string(1) "d"
["01"]=>
string(1) "e"
["1.5"]=>
string(1) "f"
[0]=>
string(1) "h"
[""]=>
string(1) "j"
[2]=>
string(1) "l"
}
]]>
</screen>
</example>
<example>
<title>負のインデックスの例</title>
<simpara>
負の整数キー <literal>n</literal> を代入すると、PHP は次のキーを <literal>n+1</literal> に代入します。
</simpara>
<programlisting role="php">
<![CDATA[
<?php
$array = [];
$array[-5] = 1;
$array[] = 2;
var_dump($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
[-5]=>
int(1)
[-4]=>
int(2)
}
]]>
</screen>
<warning>
<simpara>
PHP 8.3.0 より前のバージョンでは、負の整数キー <literal>n</literal> を代入すると、
次のキーは <literal>0</literal> に代入されていました。
そのため、前の例は次のように出力されていました:
</simpara>
<informalexample>
<screen>
<![CDATA[
array(2) {
[-5]=>
int(1)
[0]=>
int(2)
}
]]>
</screen>
</informalexample>
</warning>
</example>
</sect3>
<sect3 xml:id="language.types.array.syntax.accessing">
<title>角括弧構文による配列要素へのアクセス</title>
<para>
配列の要素へのアクセスには <literal>array[key]</literal> 構文を使います。
</para>
<example>
<title>配列の要素へのアクセス</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(
"foo" => "bar",
42 => 24,
"multi" => array(
"dimensional" => array(
"array" => "foo"
)
)
);
var_dump($array["foo"]);
var_dump($array[42]);
var_dump($array["multi"]["dimensional"]["array"]);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(3) "bar"
int(24)
string(3) "foo"
]]>
</screen>
</example>
<note>
<para>
PHP 8.0.0 より前のバージョンでは、
配列の要素にアクセスするときに、
角括弧と波括弧がどちらも同じ意味で使えていました。
(つまり、この例で <literal>$array[42]</literal> と <literal>$array{42}</literal>
は同じものを表しているということです)。
波括弧で配列にアクセスする文法は、
PHP 7.4.0 以降は非推奨になり、
PHP 8.0.0 以降はサポートされなくなっています。
</para>
</note>
<example>
<title>配列のデリファレンス</title>
<programlisting role="php">
<![CDATA[
<?php
function getArray() {
return array(1, 2, 3);
}
$secondElement = getArray()[1];
var_dump($secondElement);
?>
]]>
</programlisting>
</example>
<note>
<para>
配列に定義されていないキーへアクセスしたときの挙動は、
未定義の変数にアクセスしたときと同じです。
つまり、<constant>E_WARNING</constant> レベルの警告
(PHP 8.0.0 より前のバージョンでは <constant>E_NOTICE</constant>)
が発生し、結果が &null; になります。
</para>
</note>
<note>
<para>
配列で文字列以外のスカラー値をデリファレンスした場合は、
返される結果は &null; となります。
PHP 7.4.0 より前のバージョンでは、何もエラーは発生しませんでした。
PHP 7.4.0 以降では、<constant>E_NOTICE</constant> が発生します。
PHP 8.0.0 以降では、<constant>E_WARNING</constant> が発生します。
</para>
</note>
</sect3>
<sect3 xml:id="language.types.array.syntax.modifying">
<title>角括弧構文で作成/修正</title>
<para>
明示的に値を設定することにより、既存の配列を修正することも可能です。
</para>
<para>
これは、角括弧の中にキーを指定し、配列に値を代入することにより行います。
キーを省略することも可能です。この場合、空の角括弧
("<literal>[]</literal>") の変数名として追加してください。
</para>
<synopsis>
$arr[<replaceable>key</replaceable>] = <replaceable>value</replaceable>;
$arr[] = <replaceable>value</replaceable>;
// <replaceable>key</replaceable> は <type>string</type> または
// <type>int</type>のどちらかです。
// <replaceable>value</replaceable> の型は、何でもかまいません。
</synopsis>
<para>
<varname>$arr</varname> がまだ存在しない場合、
あるいは &null; や &false; に設定されている場合は、
新しく配列を作成します。
つまり、これは配列を作成する方法のひとつでもあります。
とはいえ、この方法を使うことはおすすめしません。なぜなら、既に
<varname>$arr</varname> に何らかの値
(リクエスト変数からの文字列など) が入っている場合にはその値がそのまま残り、
<literal>[]</literal> が実際には
<link linkend="language.types.string.substr">文字列アクセス演算子</link>
を表してしまうからです。
変数を初期化するときには、直接代入するほうがよいでしょう。
</para>
<note>
<simpara>
PHP 7.1.0 以降では、文字列に空のインデックス演算子を適用すると
致命的なエラーが発生するようになりました。
これまでのバージョンではエラーにならず、文字列が配列に変換されていました。
</simpara>
</note>
<note>
<simpara>
PHP 8.1.0 以降では、
&false; に設定している値から新しく配列を作成することは推奨されません。
&null; や未定義の値から配列を新しく作成することはまだ許可されています。
</simpara>
</note>
<para>
ある値を変更するには、
新しい値に値を代入します。特定のキー/値の組を削除したい場合には、
<function>unset</function> を使用する必要があります。
</para>
<example>
<title>角括弧と配列の使用</title>
<programlisting role="php">
<![CDATA[
<?php
$arr = array(5 => 1, 12 => 2);
$arr[] = 56; // このスクリプトのこの位置に記述した場合、
// $arr[13] = 56; と同じです
$arr["x"] = 42; // キー"x"の新しい要素を配列に追加します
unset($arr[5]); // 配列から要素を削除します
var_dump($arr);
unset($arr); // 配列全体を削除します
var_dump($arr);
?>
]]>
</programlisting>
</example>
<note>
<para>
上記のように、キーを省略して新規要素を追加する場合、
追加される数値添字は、使用されている添字の最大値 +1 (ただし、少なくとも 0 以上) になります。
まだ数値添字が存在しない場合は、添字は <literal>0</literal>
(ゼロ) となります。
</para>
<warning>
<simpara>
PHP 4.3.0 以降、上記のような添字生成動作は変更されました。
現在では、配列に追加する際に、
その配列の最大添字が負である場合は次の添字はゼロ
(<literal>0</literal>) となります。
以前は、正の添字の場合と同様に新しい添字は最大添字に +1
したものがセットされました。
</simpara>
</warning>
<para>
次のキー生成において、オフセットとして使われる整数値
(添字の最大値) に対応するエントリーが、
必ずしも配列内に存在するわけではないことに注意してください。
しかし、その値は、多くの場合、
配列にある整数のキー値の最大値と等しいはずです。以下に例を示します。
</para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
// 簡単な配列を生成します。
$array = array(1, 2, 3, 4, 5);
print_r($array);
// 全てのアイテムを削除しますが、配列自体は削除しないでおきます。
foreach ($array as $i => $value) {
unset($array[$i]);
}
print_r($array);
// アイテムを追加します(新しい添え字は0ではなく
// 5となることに注意)
$array[] = 6;
print_r($array);
// 添え字を振りなおします。
$array = array_values($array);
$array[] = 7;
print_r($array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[0] => 1
[1] => 2
[2] => 3
[3] => 4
[4] => 5
)
Array
(
)
Array
(
[5] => 6
)
Array
(
[0] => 6
[1] => 7
)
]]>
</screen>
</informalexample>
</note>
</sect3>
<sect3 xml:id="language.types.array.syntax.destructuring">
<title>配列の分解</title>
<para>
配列は、言語構造 <literal>[]</literal> (PHP 7.1.0 以降)
または、<function>list</function> を使って分解することができます。
これらの言語構造は、
配列を個別の値に分解する用途に使えます。
</para>
<example>
<title>配列の分解</title>
<programlisting role="php">
<![CDATA[
<?php
$source_array = ['foo', 'bar', 'baz'];
[$foo, $bar, $baz] = $source_array;
echo $foo, PHP_EOL; // "foo" を出力します。
echo $bar, PHP_EOL; // "bar" を出力します。
echo $baz, PHP_EOL; // "baz" を出力します。
?>
]]>
</programlisting>
</example>
<para>
これは、多次元配列を &foreach; で反復処理しながら分解する用途に使えます。
</para>
<example>
<title>foreach での配列の分解</title>
<programlisting role="php">
<![CDATA[
<?php
$source_array = [
[1, 'John'],
[2, 'Jane'],
];
foreach ($source_array as [$id, $name]) {
echo "{$id}: '{$name}'\n";
}
?>
]]>
</programlisting>
</example>
<para>
変数が与えられない配列の要素は無視されます。
配列の分解は、常にインデックス <literal>0</literal> から始まります。
</para>
<example>
<title>要素を無視する</title>
<programlisting role="php">
<![CDATA[
<?php
$source_array = ['foo', 'bar', 'baz'];
// インデックス2の要素を、変数 $baz に代入します
[, , $baz] = $source_array;
echo $baz; // "baz" を出力します。
?>
]]>
</programlisting>
</example>
<para>
PHP 7.1.0 以降では、
連想配列も分解できるようになりました。
数値をキーとした配列の右側の要素を、
インデックスを明示的に指定することで簡単に選択できるようになっています。
</para>
<example>
<title>連想配列の分解</title>
<programlisting role="php">
<![CDATA[
<?php
$source_array = ['foo' => 1, 'bar' => 2, 'baz' => 3];
// インデックス 'baz' の要素を、変数 $three に代入します。
['baz' => $three] = $source_array;
echo $three, PHP_EOL; // 3 を出力します。
$source_array = ['foo', 'bar', 'baz'];
// インデックス 2 の要素を、変数 $baz に代入します。
[2 => $baz] = $source_array;
echo $baz, PHP_EOL; // "baz" を出力します。
?>
]]>
</programlisting>
</example>
<para>
配列の分解を使うと、2つの変数を簡単に入れ替えることができます。
</para>
<example>
<title>2つの変数の入れ替え</title>
<programlisting role="php">
<![CDATA[
<?php
$a = 1;
$b = 2;
[$b, $a] = [$a, $b];
echo $a, PHP_EOL; // 2 を出力します。
echo $b, PHP_EOL; // 1 を出力します。
?>
]]>
</programlisting>
</example>
<note>
<para>
分解時に値を代入する際には、<literal>...</literal> 演算子はサポートされていません。
</para>
</note>
<note>
<para>
定義されていない配列のキーにアクセスしようとすると、
未定義の変数にアクセスする場合と同じ扱いになります。
つまり、<constant>E_WARNING</constant> レベルの警告
(PHP 8.0.0 より前のバージョンでは <constant>E_NOTICE</constant>)
が発生し、結果が &null; になります。
</para>
</note>
<note>
<para>
スカラー値を分解すると、全ての変数に &null; が代入されます。
</para>
</note>
</sect3>
</sect2><!-- end syntax -->
<sect2 xml:id="language.types.array.useful-funcs">
<title>有用な関数</title>
<para>
配列で使用する便利な関数がたくさんあります。
<link linkend="ref.array">配列関数</link> の節を参照ください。
</para>
<note>
<para>
<function>unset</function>関数は配列のキーを削除することが出来ます。
ただし、これによってインデックスの再構築が行われるわけではないことに
注意してください。
"通常の整数添字" (0 から始まり、1 つずつ増加) のみを使用している場合、
<function>array_values</function>
を用いてインデックスを再構築することができます。
</para>
<example>
<title>中間にある要素を unset する</title>
<programlisting role="php">
<![CDATA[
<?php
$a = array(1 => 'one', 2 => 'two', 3 => 'three');
/* これにより配列は以下の様に定義されます。
$a = array(1 => 'one', 3 => 'three');
以下ではありません:
$a = array(1 => 'one', 2 =>'three');
*/
unset($a[2]);
var_dump($a);
$b = array_values($a);
// $b は、array(0 => 'one', 1 =>'three')となります
var_dump($b);
?>
]]>
</programlisting>
</example>
</note>
<para>
配列専用の制御構造として &foreach; があります。
この構造は、配列の要素に簡単に連続的にアクセスする手段を提供します。
</para>
</sect2>
<sect2 xml:id="language.types.array.donts">
<title>配列ですべきこととしてはならないこと</title>
<sect3 xml:id="language.types.array.foo-bar">
<title>なぜ、<literal>$foo[bar]</literal> は使用できないのか?</title>
<para>
連想配列の添字の前後は常に引用符で括る必要があります。
例えば、$foo[bar] ではなく $foo['bar'] を使用してください。
しかし、$foo[bar] はなぜ誤りなのでしょうか?
古いスクリプトで次のような構文を見たことがあるかもしれません。
</para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$foo[bar] = 'enemy';
echo $foo[bar];
// etc
?>
]]>
</programlisting>
</informalexample>
<para>
これは間違っていますが、動作します。では、なぜ間違っているのでしょう?
それは、このコードには文字列 (<literal>'bar'</literal> - 引用符で括られている)
ではなく未定義の定数 (<literal>bar</literal>) が使用されているためです。
下位互換性の維持のため、未定義の定数は同じ名前の文字列に自動的に変換されます。
そのため、このコードは動作します。
例えば、<constant>bar</constant> という名前の定義されていない定数があるとすると、
PHP は <literal>'bar'</literal> という文字列でそれを置換して使用します。
</para>
<warning>
<simpara>
生の文字列を未定義の定数として扱う振る舞いは、
<constant>E_NOTICE</constant>
レベルの警告が発生します。
この振る舞いは PHP 7.2.0 以降は推奨されなくなり、
<constant>E_WARNING</constant> レベルの警告が発生します。
PHP 8.0.0 以降は、この振る舞いは削除され、
<classname>Error</classname> 例外がスローされるようになっています。
</simpara>
</warning>
<simpara>
これは、キーを <emphasis>常に</emphasis> クォートするという意味ではありません。
<link linkend="language.constants">定数</link>や
<link linkend="language.variables">変数</link>
をキーとして使う際には、クォートしてしまうと PHP
はそれを解釈できなくなってしまいます。
</simpara>
<example>
<title>キーのクォート</title>
<programlisting role="php">
<![CDATA[
<?php
error_reporting(E_ALL);
ini_set('display_errors', true);
ini_set('html_errors', false);
// 単純な配列
$array = array(1, 2);
$count = count($array);
for ($i = 0; $i < $count; $i++) {
echo "\nChecking $i: \n";
echo "Bad: " . $array['$i'] . "\n";
echo "Good: " . $array[$i] . "\n";
echo "Bad: {$array['$i']}\n";
echo "Good: {$array[$i]}\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Checking 0:
Notice: Undefined index: $i in /path/to/script.html on line 9
Bad:
Good: 1
Notice: Undefined index: $i in /path/to/script.html on line 11
Bad:
Good: 1
Checking 1:
Notice: Undefined index: $i in /path/to/script.html on line 9
Bad:
Good: 2
Notice: Undefined index: $i in /path/to/script.html on line 11
Bad:
Good: 2
]]>
</screen>
</example>
<para>
この具体例を以下に示します。
</para>
<example>
<title>その他の例</title>
<programlisting role="php">
<![CDATA[
<?php
// エラーを全て表示するよう設定
error_reporting(E_ALL);
$arr = array('fruit' => 'apple', 'veggie' => 'carrot');
// 正しい
echo $arr['fruit'], PHP_EOL; // apple
echo $arr['veggie'], PHP_EOL; // carrot
// 間違い。未定義の定数fruitを使用しているため動作せず、
// PHP がエラーを発生させます。
//
// Error: Undefined constant "fruit"
try {
echo $arr[fruit];
} catch (Error $e) {
echo get_class($e), ': ', $e->getMessage(), PHP_EOL;
}
// 検証のため、定数を定義してみましょう。
// fruitという名前の定数に値'veggie'を代入します。
define('fruit', 'veggie');
// ここでは、出力が異なることに注意してください。
echo $arr['fruit'], PHP_EOL; // apple
echo $arr[fruit], PHP_EOL; // carrot
// 以下は文字列の中であるためOKです。定数は、文字列の中では解釈されな
// いため、エラーはここでは発生しません。
echo "Hello $arr[fruit]", PHP_EOL; // Hello apple
// 例外が1つあり、文字列の中で波括弧で配列を括った場合には、
// 定数が解釈されます
echo "Hello {$arr[fruit]}", PHP_EOL; // Hello carrot
echo "Hello {$arr['fruit']}", PHP_EOL; // Hello apple
// 文字列結合で同じことをすることもできます
echo "Hello " . $arr['fruit'], PHP_EOL; // Hello apple
?>
]]>
</programlisting>
</example>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
// これは動作せず、以下のようなパースエラーを発生します:
// Parse error: parse error, expecting T_STRING' or T_VARIABLE' or T_NUM_STRING'
// 文字列の中でスーパーグローバルを使用した場合も無論同様です。
print "Hello $arr['fruit']";
print "Hello $_GET['foo']";
?>
]]>
</programlisting>
</informalexample>
<para>
<link linkend="language.types.array.syntax"
>構文</link> で説明した通り、角括弧
('<literal>[</literal>' および '<literal>]</literal>')