【PHP8.x】array_intersect_ukey()関数の使い方

Copy
1<?php
2
3/**
4 * この関数は、array_intersect_ukey を使用して、複数の配列間でキーを比較し、
5 * 共通のキーを持つ要素を最初の配列から抽出する方法をデモンストレーションします。
6 * キーの比較には、ユーザー定義のコールバック関数が使用されます。
7 */
8function demonstrateArrayIntersectUkey(): void
9{
10    // 最初の配列を定義します。この配列から結果の要素が抽出されます。
11    $array1 = [
12        'Apple'  => 10,
13        'Banana' => 20,
14        'Cherry' => 30,
15        'Date'   => 40,
16    ];
17
18    // 比較対象となる2番目の配列を定義します。
19    $array2 = [
20        'apple'  => 50, // 'Apple' とキーが似ています（大文字・小文字を無視）
21        'Durian' => 60,
22        'Banana' => 70,
23        'Elder'  => 80,
24    ];
25
26    // 比較対象となる3番目の配列を定義します。
27    $array3 = [
28        'APPLE'  => 90, // 'Apple' とキーが似ています（大文字・小文字を無視）
29        'Grape'  => 100,
30        'Banana' => 110,
31        'Fig'    => 120,
32    ];
33
34    // キーを比較するためのコールバック関数を定義します。
35    // array_intersect_ukey は、この関数を使用して各配列のキーを比較します。
36    // この関数は、2つのキーを引数に取り、以下の整数を返さなければなりません:
37    // - 最初のキーが2番目のキーより小さいとみなされる場合、負の数
38    // - 2つのキーが等しいとみなされる場合、ゼロ
39    // - 最初のキーが2番目のキーより大きいとみなされる場合、正の数
40    // ここでは、strcasecmp を使用して大文字・小文字を区別しないキー比較を行います。
41    $keyCompareFunc = function (string $keyA, string $keyB): int {
42        return strcasecmp($keyA, $keyB);
43    };
44
45    // array_intersect_ukey を呼び出して、共通のキーを持つ要素を抽出します。
46    // 最初の配列 ($array1) のキーが、指定されたコールバック関数 ($keyCompareFunc) を使用して、
47    // 他のすべての配列 ($array2, $array3) のキーと比較されます。
48    // その結果、すべての配列に共通してキーが存在する $array1 の要素のみが返されます。
49    $commonKeysArray = array_intersect_ukey($array1, $array2, $array3, $keyCompareFunc);
50
51    echo "元の配列1:\n";
52    print_r($array1);
53
54    echo "\n元の配列2:\n";
55    print_r($array2);
56
57    echo "\n元の配列3:\n";
58    print_r($array3);
59
60    echo "\narray_intersect_ukey の結果 (大文字・小文字を区別しないキー比較):\n";
61    print_r($commonKeysArray);
62
63    // 期待される出力:
64    // 'Apple' のキーは $array2 の 'apple' および $array3 の 'APPLE' と
65    // 大文字・小文字を区別しない比較で一致するため、結果に含まれます。
66    // 'Banana' のキーは $array2 および $array3 の 'Banana' と一致するため、結果に含まれます。
67    // その他のキーは、すべての配列に共通して存在しないため、結果には含まれません。
68    // 結果は ['Apple' => 10, 'Banana' => 20] となります。
69}
70
71// デモンストレーション関数を実行します。
72demonstrateArrayIntersectUkey();

array_intersect_ukeyは、PHPで複数の配列の中から、共通して存在するキーを持つ要素を最初の配列から抽出するための関数です。特に「ukey」は「user-defined key comparison」の略で、キーの比較方法をプログラマーが定義したコールバック関数で行える点が大きな特徴です。

この関数は、引数として最初に抽出元となる$array1、次に比較対象となる任意の数の配列...$arrays、そしてキーを比較するための$key_compare_funcというコールバック関数を受け取ります。$key_compare_funcは、2つのキーを引数に取り、それらを比較して、最初のキーが2番目より小さい場合は負の数、等しい場合はゼロ、大きい場合は正の数を返さなければなりません。このコールバック関数の戻り値に基づいて、array_intersect_ukeyはキーが共通しているかどうかを判断します。

関数が返す戻り値は配列であり、これはすべての引数として与えられた配列に共通して存在するキーを持つ要素を、最初の$array1から抽出した結果です。つまり、共通キーが見つかった場合でも、その要素の値は$array1のものが採用されます。

サンプルコードでは、strcasecmpという関数を内部で利用するコールバック関数を定義し、大文字・小文字を区別せずにキーを比較する例が示されています。これにより、'Apple'、'apple'、'APPLE'といったキーを同じものとして扱い、それらが共通キーとして存在するかどうかを判断し、$array1から該当する要素を抽出しています。これにより、柔軟な条件で配列間の共通キー要素を特定することが可能になります。

Copy
1<?php
2
3/**
4 * array_intersect_ukey の使用例
5 * 複数の配列に共通して存在するキーを見つけ、最初の配列 ($array1) の値を保持した配列を返します。
6 * キーの比較はユーザー定義のコールバック関数によって行われます。
7 */
8
9// 最初の配列を定義します。
10$array1 = [
11    'fruit' => 'apple',
12    'color' => 'red',
13    'size' => 'medium',
14    'taste' => 'sweet',
15];
16
17// 2番目の配列を定義します。
18// 'color'と'taste'のキーが$array1と共通しています。
19$array2 = [
20    'color' => 'blue',
21    'shape' => 'round',
22    'taste' => 'sour',
23];
24
25// 3番目の配列を定義します。
26// 'color'のキーが$array1と$array2と共通しています。
27$array3 = [
28    'size' => 'large',
29    'color' => 'green',
30    'origin' => 'japan',
31];
32
33// キーを比較するためのコールバック関数を定義します。
34// この関数は、2つのキーを受け取り、
35// - 0 を返すとキーが一致するとみなされます。
36// - 負の値を返すと $key1 が $key2 より小さいとみなされます。
37// - 正の値を返すと $key1 が $key2 より大きいとみなされます。
38// ここでは文字列を辞書順で比較する `strcmp` 関数を使用します。
39$key_compare_func = function (string $key1, string $key2): int {
40    // strcmp は文字列の比較を行い、0を返した場合にキーが一致すると判断されます。
41    return strcmp($key1, $key2);
42};
43
44// array_intersect_ukey 関数を使用して、すべての配列に共通するキーを見つけます。
45// 結果の配列には、共通のキーに対応する $array1 の値が含まれます。
46$intersected_array = array_intersect_ukey($array1, $array2, $array3, $key_compare_func);
47
48// 結果を出力して確認します。
49echo "--- 元の配列 ---\n";
50echo "配列1:\n";
51print_r($array1);
52
53echo "配列2:\n";
54print_r($array2);
55
56echo "配列3:\n";
57print_r($array3);
58
59echo "\n--- 共通するキーを持つ要素 (配列1の値) ---\n";
60// この例では、'color' キーがすべての配列に共通しているため、
61// 'color' => 'red' が結果として出力されます。
62print_r($intersected_array);
63
64?>

PHPのarray_intersect_ukey関数は、複数の配列間でキーを比較し、共通して存在するキーを持つ要素を抽出するために利用されます。キーの比較方法はユーザーが定義するコールバック関数によって柔軟に指定できる点が特徴です。

この関数は、最初の引数として基準となる配列$array1、次に比較対象となる任意の数の配列...$arrays、そしてキーを比較するためのコールバック関数$key_compare_funcを受け取ります。$key_compare_funcは2つのキーを受け取り、キーが一致すると判断される場合は0を返す必要があります。例えば、文字列キーを辞書順で比較するにはstrcmp関数を利用したコールバック関数が適しています。

戻り値は新しい配列で、引数として渡されたすべての配列に共通して存在するキーに対応する$array1の要素のみが含まれます。共通のキーであっても、$array1以外の配列の値は結果に反映されません。

サンプルコードでは、$array1、$array2、$array3という3つの配列が用意されており、キーの比較にはstrcmpを利用したコールバック関数が指定されています。この設定で関数を実行すると、'color'というキーが3つの配列すべてに共通していることが確認できます。そのため、最終的な結果の配列には、$array1から取得された'color' => 'red'という要素のみが含まれて出力されます。このように、特定の比較ルールに基づいて共通のキーを持つ要素を効率的に取得できる関数です。