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

Copy
1<?php
2
3/**
4 * 配列の現在のキーを取得するサンプルコード
5 */
6
7$array = [
8    'apple' => 'red',
9    'banana' => 'yellow',
10    'orange' => 'orange',
11];
12
13// 配列の内部ポインタを最初の要素に移動する
14reset($array);
15
16// 現在のキーを取得する
17$currentKey = key($array);
18
19// 結果を出力する
20echo "現在のキー: " . $currentKey . PHP_EOL; // 出力: 現在のキー: apple
21
22// 内部ポインタを次の要素に移動する
23next($array);
24
25// 現在のキーを取得する
26$currentKey = key($array);
27
28// 結果を出力する
29echo "現在のキー: " . $currentKey . PHP_EOL; // 出力: 現在のキー: banana
30
31//キーが存在しない場合
32$array = [];
33$key = key($array);
34
35if ($key === null) {
36    echo "配列が空であるか、内部ポインタが範囲外です。" . PHP_EOL;
37}

PHPのkey()関数は、配列の内部ポインタが指す現在の要素のキーを取得するために使用します。この関数は引数として配列 $array を受け取り、現在のキーを文字列または整数で返します。配列が空であるか、内部ポインタが配列の範囲外を指している場合は null を返します。

サンプルコードでは、まず連想配列 $array を定義し、reset() 関数を使って内部ポインタを最初の要素に移動させています。その後、key($array) を呼び出すことで、最初の要素のキーである 'apple' を取得し、出力しています。

次に、next() 関数を使って内部ポインタを次の要素に移動させ、再度 key($array) を呼び出すことで、次の要素のキーである 'banana' を取得し、出力しています。

最後に、空の配列の場合の挙動を確認するために、key()関数がnullを返すことを確認しています。key()関数を使用する前にreset()関数で内部ポインタを初期化することで、意図したキーを取得することができます。配列のキーの存在をチェックしたい場合は、array_key_exists() 関数も合わせてご確認ください。

Copy
1<?php
2
3/**
4 * 配列の現在の要素のキーを取得するサンプルコード
5 */
6$array = [
7    'name' => 'Taro',
8    'age' => 30,
9    'city' => 'Tokyo',
10];
11
12// 配列のキーを取得する前に、内部ポインタを先頭にリセットすることが推奨されます。
13reset($array);
14
15$key = key($array);
16
17if ($key !== null) {
18    echo "現在のキー: " . $key . PHP_EOL; // 出力: 現在のキー: name
19} else {
20    echo "配列が空であるか、内部ポインタが無効です。" . PHP_EOL;
21}
22
23// 内部ポインタを移動してからキーを取得する例
24next($array);
25$key = key($array);
26
27if ($key !== null) {
28    echo "現在のキー: " . $key . PHP_EOL; // 出力: 現在のキー: age
29} else {
30    echo "配列が空であるか、内部ポインタが無効です。" . PHP_EOL;
31}

PHPのkey()関数は、配列の内部ポインタが現在指している要素のキーを取得するための関数です。

この関数は、引数としてキーを取得したい配列を一つ受け取ります。戻り値は、内部ポインタが指している要素のキーです。キーが文字列の場合は文字列型、数値の場合は整数型が返されます。もし配列が空であったり、内部ポインタが配列の最後の要素を超えて無効な位置を指していたりする場合には null を返します。

サンプルコードでは、まず$arrayという連想配列を定義しています。reset()関数で内部ポインタを配列の先頭に戻してからkey()を実行すると、先頭要素のキーである'name'が取得されます。次にnext()関数で内部ポインタを一つ次の要素へ移動させ、再度key()を実行すると、2番目の要素のキーである'age'が取得できます。このようにkey()関数は、配列の内部ポインタの位置に依存するため、next()やprev()、reset()といったポインタを操作する関数と組み合わせて使用するのが一般的です。