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

Copy
1<?php
2
3/**
4 * 複数の配列間で、ユーザー定義の比較関数を用いてキーが一致する要素を抽出するサンプルコード。
5 * array_intersect_uassoc 関数は、最初の配列 (array1) から、
6 * 他のすべての配列と共通のキーを持つ要素を返します。
7 * キーの比較には、最後の引数として渡されるコールバック関数が使用されます。
8 */
9
10// 最初の配列を定義
11$array1 = ['apple' => 1, 'banana' => 2, 'cherry' => 3, 'date' => 4];
12
13// 2番目の配列を定義
14$array2 = ['cherry' => 5, 'banana' => 6, 'elderberry' => 7];
15
16// 3番目の配列を定義
17$array3 = ['banana' => 8, 'cherry' => 9, 'fig' => 10];
18
19// キーを比較するためのコールバック関数を定義（PHP 8のアロー関数を使用）
20// この関数は2つのキーを受け取り、それらの比較結果（負、0、正）を返します。
21// ここでは、標準の文字列比較関数 strcmp を使用しています。
22// strcmp は、第一引数が第二引数より小さい場合は負の数を、
23// 等しい場合は 0 を、大きい場合は正の数を返します。
24$keyCompareFunc = fn($key1, $key2) => strcmp($key1, $key2);
25
26// array_intersect_uassoc を使用して、すべての配列に共通するキーを持つ要素を抽出
27// 結果配列には、$array1 から共通キーに対応する要素（キーと値のペア）が含まれます。
28$resultArray = array_intersect_uassoc($array1, $array2, $array3, $keyCompareFunc);
29
30// 結果を表示
31echo "--- 元の配列 ---\n";
32echo "array1: " . print_r($array1, true);
33echo "array2: " . print_r($array2, true);
34echo "array3: " . print_r($array3, true);
35
36echo "--- 共通のキーを持つ要素 (array1から抽出) ---\n";
37print_r($resultArray);
38
39/*
40期待される出力例:
41--- 元の配列 ---
42array1: Array
43(
44    [apple] => 1
45    [banana] => 2
46    [cherry] => 3
47    [date] => 4
48)
49array2: Array
50(
51    [cherry] => 5
52    [banana] => 6
53    [elderberry] => 7
54)
55array3: Array
56(
57    [banana] => 8
58    [cherry] => 9
59    [fig] => 10
60)
61--- 共通のキーを持つ要素 (array1から抽出) ---
62Array
63(
64    [banana] => 2
65    [cherry] => 3
66)
67*/
68
69?>

PHP 8のarray_intersect_uassoc関数は、複数の配列間でキーが共通する要素を、ユーザー定義の比較関数を用いて抽出する際に使用されます。この関数は、最初の配列（$array1）から、他のすべての比較対象配列に共通して存在するキーに対応する要素のみを抜き出し、新しい配列として返します。

引数には、まず要素を抽出したい最初の配列（$array1）を指定します。次に、比較対象となる複数の配列を好きなだけ指定できます。最後の引数には、キー同士を比較するためのコールバック関数（callable）を渡します。このコールバック関数は、2つのキーを受け取り、それらの大小関係を示す数値（負、0、正）を返します。サンプルコードでは、文字列キーを比較するためにPHP標準のstrcmp関数を利用したアロー関数を定義しています。

戻り値は、共通のキーに対応する$array1の要素（キーと値のペア）を持つ新しい配列です。サンプルコードでは、$array1、$array2、$array3の3つの配列を比較し、定義したコールバック関数でキーを比較しています。その結果、共通するキーである'banana'と'cherry'に対応する$array1の要素が抽出され、最終的に['banana' => 2, 'cherry' => 3]という配列が得られています。これにより、特定のルールに基づいて配列の共通部分を見つけることができます。

Copy
1<?php
2
3/**
4 * 2つのキーを大文字・小文字を区別せずに比較するコールバック関数。
5 * array_intersect_uassoc のキー比較に使用されます。
6 *
7 * @param string $key1 最初のキー
8 * @param string $key2 2番目のキー
9 * @return int 0: キーが等しい, 負の数: $key1 < $key2, 正の数: $key1 > $key2
10 */
11function compareKeysCaseInsensitive(string $key1, string $key2): int
12{
13    // キーを小文字に変換して比較することで、大文字・小文字を区別しない比較を実現します。
14    // PHP 7 以降で導入された <=> (spaceship operator) は、
15    // 3方向比較 (より小さい、等しい、より大きい) の結果を -1, 0, 1 で返します。
16    return strtolower($key1) <=> strtolower($key2);
17}
18
19// 最初の配列
20// 商品名と在庫数を想定します。
21$stockItems1 = [
22    'Apple'  => 10,
23    'Banana' => 20,
24    'cherry' => 30,
25    'Date'   => 40,
26];
27
28// 2番目の配列
29// 別の店舗の在庫情報などを想定します。
30$stockItems2 = [
31    'apple'  => 10,  // キーは大文字小文字が異なりますが、値は同じ
32    'BANANA' => 200, // キーは大文字小文字が異なりますが、値は異なる
33    'Cherry' => 30,  // キーは大文字小文字が異なりますが、値は同じ
34    'Elder'  => 50,
35];
36
37// array_intersect_uassoc を使用して、2つの配列の共通要素を見つけます。
38// キーの比較にはユーザー定義の `compareKeysCaseInsensitive` 関数を使用し、
39// 値の比較はPHPの標準的な `==` 演算子で行われます。
40//
41// 戻り値は、$stockItems1 の要素のうち、
42// 他のすべての配列にも、同じキー（コールバック関数で比較）と
43// 同じ値（標準比較）を持つ要素が存在するものになります。
44$commonStock = array_intersect_uassoc($stockItems1, $stockItems2, 'compareKeysCaseInsensitive');
45
46echo "複数の配列に共通して存在する商品の在庫情報（キーは大文字小文字を無視して比較）：\n";
47print_r($commonStock);
48
49/*
50上記のコードを実行すると、以下の出力が得られます。
51
52共通要素の配列:
53Array
54(
55    [Apple] => 10
56    [cherry] => 30
57)
58
59解説：
60- 'Apple' => 10 は、$stockItems1 のキー 'Apple' と $stockItems2 のキー 'apple' が
61  compareKeysCaseInsensitive 関数によって「同じ」と判断され、
62  値 10 も同じであるため、共通要素として抽出されます。（$stockItems1 のキーが保持されます）
63- 'cherry' => 30 は、$stockItems1 のキー 'cherry' と $stockItems2 のキー 'Cherry' が
64  compareKeysCaseInsensitive 関数によって「同じ」と判断され、
65  値 30 も同じであるため、共通要素として抽出されます。（$stockItems1 のキーが保持されます）
66- 'Banana' => 20 は、$stockItems1 のキー 'Banana' と $stockItems2 のキー 'BANANA' は
67  compareKeysCaseInsensitive 関数によって「同じ」と判断されますが、
68  値 20 と 200 が異なるため、共通要素とはみなされません。
69- 'Date' => 40 は、$stockItems2 に対応するキー（大文字小文字無視）が存在しないため、
70  共通要素とはみなされません。
71*/

PHPのarray_intersect_uassoc関数は、複数の配列の中からキーと値が両方とも一致する要素を抽出する際に使用されます。特に、キーの比較方法をユーザーが自由に定義できる点が特徴です。

この関数は、最初の引数に基準となる配列（$array1）を、2番目以降の引数に比較対象となる配列（...$arrays）を複数受け取ります。そして、最後の引数にはキーを比較するためのコールバック関数（$key_compare_func）を指定します。このコールバック関数は、2つのキーを受け取り、それらが等しい場合は0を、異なる場合は負または正の整数を返します。値の比較にはPHPの標準的な==演算子が用いられます。

戻り値は、$array1の要素のうち、他のすべての配列にもキー（コールバック関数による比較）と値（標準比較）が一致する要素が存在するものです。戻り値の配列のキーは$array1のものが保持されます。

サンプルコードでは、stockItems1とstockItems2という2つの配列から共通の在庫情報を抽出しています。キーの比較には、大文字・小文字を区別せずに比較するcompareKeysCaseInsensitive関数を指定しています。これにより、例えば'Apple'と'apple'のようなキーも同じものとみなされます。結果として、キーも値も一致する'Apple' => 10と'cherry' => 30が共通要素として抽出されています。'Banana'の項目はキーは一致しますが値が異なるため、共通要素には含まれません。