【PHP8.x】end関数の使い方

Copy
1<?php
2
3/**
4 * PHPの end() 関数の使用例を示します。
5 * end() 関数は、配列の内部ポインタを最終要素に移動させ、その最終要素の値を返します。
6 * この例では、まず foreach ループで配列の全要素を表示し、その後に end() 関数で最後の要素を取得します。
7 * キーワード「php endforeach」との関連性を示すため、foreach の代替構文を使用しています。
8 */
9function demonstrateEndFunctionWithForeach(): void
10{
11    // サンプルとなる文字列の配列を定義
12    $fruits = ['Apple', 'Banana', 'Cherry', 'Date', 'Elderberry'];
13
14    echo "--- 配列の全要素を foreach ループで表示 ---" . PHP_EOL;
15    // foreach ループを使って配列の全ての要素を順番に表示します。
16    // PHP の代替構文 (foreach ... endforeach;) を使用しています。
17    foreach ($fruits as $key => $fruit):
18        echo "要素 [{$key}]: {$fruit}" . PHP_EOL;
19    endforeach; // foreach ループの終了を示すキーワード
20
21    echo PHP_EOL . "--- end() 関数で最後の要素を取得 ---" . PHP_EOL;
22    // end() 関数を呼び出すことで、配列の内部ポインタが最後の要素に移動し、
23    // その最後の要素の値が $lastFruit 変数に代入されます。
24    $lastFruit = end($fruits);
25
26    echo "end() 関数で取得した最後の要素: {$lastFruit}" . PHP_EOL;
27
28    echo PHP_EOL . "--- 空の配列に対する end() の動作 ---" . PHP_EOL;
29    // 空の配列に対して end() を呼び出すと、false が返されます。
30    $emptyArray = [];
31    $resultEmpty = end($emptyArray);
32    // var_export を使うことで、false が文字列 'false' として表示され、より分かりやすくなります。
33    echo "空の配列に対する end() の結果: " . var_export($resultEmpty, true) . PHP_EOL;
34}
35
36// 上記の関数を実行して、end() 関数の動作を確認します。
37demonstrateEndFunctionWithForeach();
38
39?>

PHPのend()関数は、配列の内部ポインタをその配列の最後の要素に移動させ、その最終要素の値を返す関数です。この関数は、引数として操作したい配列をarray &$arrayのように参照渡しで受け取ります。これにより、関数内で配列の内部ポインタが変更されるため、後続のポインタ操作（例: current(), next()など）に影響を与えます。戻り値はmixed型で、最後の要素の値が返されますが、配列が空の場合にはfalseが返される点に注意が必要です。

提供されたサンプルコードでは、まず$fruitsという文字列の配列が定義されています。配列の全要素を順番に表示するために、foreach ($fruits as $key => $fruit): ... endforeach;というPHPの代替構文を用いたループが使用されています。endforeach;キーワードは、一般的な}の代わりにループの終わりを示すものです。

ループの後、end($fruits)を呼び出すことで、$fruits配列の内部ポインタは最後の要素である「Elderberry」に移動し、その値が$lastFruit変数に代入されて出力されます。

さらに、空の配列$emptyArrayに対してend()関数を適用すると、戻り値がfalseとなることも示されています。これはvar_export()関数を使って明示的に表示されており、end()関数を使用する際の重要な考慮事項となります。この関数は、配列の最後の要素を簡単に取得したい場合に非常に便利です。

Copy
1<?php
2
3// end() 関数は、配列の内部ポインタを最後の要素に移動させ、その要素の値を返します。
4// システムエンジニアを目指す初心者向けのサンプルコードです。
5
6$fruits = ['apple', 'banana', 'orange', 'grape'];
7
8echo "元の配列:\n";
9print_r($fruits);
10
11// end() を呼び出すと、内部ポインタが最後の要素 'grape' を指すようになり、
12// その値が $lastFruit 変数に代入されます。
13$lastFruit = end($fruits);
14
15echo "end() で取得した最後の要素: " . $lastFruit . "\n";
16
17// end() 実行後、配列の内部ポインタは最後の要素を指しています。
18// current() を使って現在の内部ポインタが指す要素を確認できます。
19echo "current() で確認した現在の要素: " . current($fruits) . "\n";
20
21?>

PHPのend関数は、配列の中から最後の要素を効率的に取得するための機能です。この関数は、引数として渡された配列の「内部ポインタ」と呼ばれる、現在の注目している位置を示す目印を、配列のいちばん最後の要素まで移動させます。そして、その最後の要素の値を戻り値として返します。引数array &$arrayは、配列そのものを参照（直接変更）することを意味するため、end関数を呼び出した後も、配列の内部ポインタは最後の要素を指した状態が維持されます。戻り値mixedは、配列の最後の要素が文字列や数値など、どのような種類の値であっても取得できることを示します。

サンプルコードでは、$fruitsという名前の配列にいくつかの果物が格納されています。end($fruits)を実行すると、この配列の内部ポインタは「grape」という最後の要素の位置に移動し、その値である「grape」が$lastFruit変数に代入されます。end関数が実行された後も、配列の内部ポインタは最後の要素を指し続けているため、次にcurrent($fruits)関数を使って内部ポインタが現在どこを指しているかを確認すると、やはり「grape」という値が表示されます。このようにend関数は、配列の最後の要素を簡単に取得できるだけでなく、配列内の操作の出発点として内部ポインタを最後の位置に設定したい場合にも役立ちます。