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

Copy
1<?php
2
3/**
4 * array_udiff_uassoc の使用例。
5 *
6 * この関数は、最初の配列 ($array1) に存在し、他のどの配列にも存在しないすべての要素を返します。
7 * 要素の比較には、値の比較にユーザー定義の関数を、キーの比較に別のユーザー定義の関数を使用します。
8 *
9 * システムエンジニアを目指す初心者の方へ:
10 * この関数は、配列の「値」と「キー」の両方を、カスタムの比較ルールに基づいて厳密に比較し、
11 * 最初の配列に固有の要素を見つけたい場合に非常に役立ちます。
12 * 例えば、データベースから取得したデータと、現在のメモリ上のデータの差分を検出する際などに利用できます。
13 */
14
15/**
16 * 値を比較するためのコールバック関数。
17 * 大文字小文字を区別しない文字列比較を行います。
18 *
19 * @param mixed $valueA 比較する最初の値
20 * @param mixed $valueB 比較する2番目の値
21 * @return int $valueA が $valueB より小さい場合は負の整数、等しい場合は0、大きい場合は正の整数
22 */
23function compareValues(mixed $valueA, mixed $valueB): int
24{
25    // strcasecmp は大文字小文字を区別せずに文字列を比較します。
26    // 非文字列型が渡された場合は、文字列にキャストしてから比較します。
27    return strcasecmp((string)$valueA, (string)$valueB);
28}
29
30/**
31 * キーを比較するためのコールバック関数。
32 * 大文字小文字を区別する文字列比較を行います。
33 *
34 * @param mixed $keyA 比較する最初のキー
35 * @param mixed $keyB 比較する2番目のキー
36 * @return int $keyA が $keyB より小さい場合は負の整数、等しい場合は0、大きい場合は正の整数
37 */
38function compareKeys(mixed $keyA, mixed $keyB): int
39{
40    // strcmp は大文字小文字を区別して文字列を比較します。
41    // 非文字列型が渡された場合は、文字列にキャストしてから比較します。
42    return strcmp((string)$keyA, (string)$keyB);
43}
44
45// 比較対象の最初の配列
46$array1 = [
47    'fruit_a' => 'Apple',
48    'fruit_b' => 'Banana',
49    'fruit_c' => 'Orange',
50    'fruit_d' => 'Grape',
51    'fruit_e' => 'apple', // キーは異なるが、値は 'Apple' と実質同じ
52];
53
54// 比較対象の2番目の配列
55$array2 = [
56    'fruit_a' => 'apple',  // キーは同じ、値は 'compareValues' で 'Apple' と等しいとみなされる
57    'fruit_b' => 'Banana', // キーも値も $array1 と一致
58    'fruit_f' => 'Mango',  // $array1 には存在しない
59];
60
61// 比較対象の3番目の配列
62$array3 = [
63    'fruit_c' => 'orange', // キーは同じ、値は 'compareValues' で 'Orange' と等しいとみなされる
64    'fruit_g' => 'Peach',  // $array1 には存在しない
65];
66
67// array_udiff_uassoc を使って $array1 にのみ存在する要素を見つける
68// 第4引数に値の比較関数、第5引数にキーの比較関数を指定します。
69$diff = array_udiff_uassoc($array1, $array2, $array3, 'compareValues', 'compareKeys');
70
71// 結果を出力
72// 結果には、$array1 にあって、$array2 や $array3 のどの配列にも、
73// 'compareValues'で値が等しく、かつ'compareKeys'でキーが等しい要素がなかったものが含まれます。
74//
75// 期待される出力例:
76// Array
77// (
78//     [fruit_d] => Grape
79//     [fruit_e] => apple
80// )
81//
82// 解説:
83// - 'fruit_a' => 'Apple': $array2 の 'fruit_a' => 'apple' と、キーも値も一致（値は大文字小文字無視）するため、差分ではない。
84// - 'fruit_b' => 'Banana': $array2 の 'fruit_b' => 'Banana' と、キーも値も一致するため、差分ではない。
85// - 'fruit_c' => 'Orange': $array3 の 'fruit_c' => 'orange' と、キーも値も一致（値は大文字小文字無視）するため、差分ではない。
86// - 'fruit_d' => 'Grape': 他の配列に同じキーと値の組み合わせが存在しないため、差分として残る。
87// - 'fruit_e' => 'apple': 他の配列に同じキーと値の組み合わせが存在しないため、差分として残る。
88print_r($diff);

array_udiff_uassoc関数は、複数の配列を比較し、最初の配列にのみ存在する要素を抽出する関数です。PHP 8で利用でき、特に値の比較とキーの比較にそれぞれ独自のコールバック関数を指定できる点が特徴で、これにより柔軟な条件での差分検出が可能となります。

引数には、比較元の最初の配列と、比較対象となる一つ以上の配列を指定します。さらに、値の比較を行うコールバック関数と、キーの比較を行うコールバック関数をそれぞれ指定します。これらのコールバック関数は、比較対象の2つの要素を受け取り、その大小関係を整数で返します。戻り値は、最初の配列にあり、他のどの配列にもキーと値がコールバック関数によって一致しなかった要素のみを含む新しい配列です。

サンプルコードのように、値は大文字小文字を区別せず、キーは大文字小文字を区別して比較するといった、カスタムルールでの差分検出が可能です。例えば'fruit_a' => 'Apple'と'fruit_a' => 'apple'は、キーは一致し、値も大文字小文字を無視すれば一致するため差分とはみなされません。この関数は、データベースデータとメモリ上のデータの差分検出や、カスタム条件での設定変更の検出など、厳密かつ柔軟な配列比較が必要な場面で非常に役立ちます。

Copy
1<?php
2
3/**
4 * array_udiff_uassoc のための値比較コールバック関数。
5 * 複数のキーを持つ連想配列（多次元配列の要素）を比較します。
6 * この関数は、キーの存在と各キーの値に基づいて2つの配列を比較し、
7 * キーワード「multidimensional」を考慮した多次元的な比較ロジックを提供します。
8 *
9 * @param array $val1 比較する最初の配列（値）
10 * @param array $val2 比較する2番目の配列（値）
11 * @return int 比較結果。0 ($val1 が $val2 と等しい), -1 ($val1 が $val2 より小さい), 1 ($val1 が $val2 より大きい)。
12 */
13function compareMultidimensionalValues(array $val1, array $val2): int
14{
15    // 比較対象となるすべてのキーを結合し、ソートして比較順序を安定させる
16    $allKeys = array_unique(array_merge(array_keys($val1), array_keys($val2)));
17    sort($allKeys);
18
19    foreach ($allKeys as $key) {
20        $hasKey1 = array_key_exists($key, $val1);
21        $hasKey2 = array_key_exists($key, $val2);
22
23        // キーの存在自体を比較
24        if ($hasKey1 && !$hasKey2) {
25            return 1; // $val1にのみキーが存在する場合、$val1が大きいとみなす
26        }
27        if (!$hasKey1 && $hasKey2) {
28            return -1; // $val2にのみキーが存在する場合、$val1が小さいとみなす
29        }
30        if (!$hasKey1 && !$hasKey2) {
31            continue; // 両方にキーがない場合はスキップ
32        }
33
34        // キーが両方に存在する場合、その値を比較
35        // 値がさらに配列の場合、PHPのデフォルトの配列比較ルールに従う
36        // 例: [1, 2] と [1, 2] は等しいが、[1, 2] と [2, 1] は等しくない
37        $cmp = $val1[$key] <=> $val2[$key];
38        if ($cmp !== 0) {
39            return $cmp;
40        }
41    }
42
43    return 0; // すべてのキーと値が一致した場合
44}
45
46/**
47 * array_udiff_uassoc のためのキー比較コールバック関数。
48 * 文字列キーを比較します。
49 *
50 * @param string $key1 比較する最初のキー
51 * @param string $key2 比較する2番目のキー
52 * @return int 比較結果。0 ($key1 が $key2 と等しい), -1 ($key1 が $key2 より小さい), 1 ($key1 が $key2 より大きい)。
53 */
54function compareStringKeys(string $key1, string $key2): int
55{
56    return $key1 <=> $key2; // 宇宙船演算子で文字列を比較
57}
58
59// --- サンプルコードの実行部分 ---
60
61// 比較対象となる多次元配列を準備
62// 各要素はユーザー情報を表す連想配列であり、これが「多次元」の要素となる
63$array1 = [
64    'user_a' => ['id' => 1, 'name' => 'Alice', 'role' => 'admin'],
65    'user_b' => ['id' => 2, 'name' => 'Bob', 'role' => 'editor'],
66    'user_c' => ['id' => 3, 'name' => 'Charlie', 'role' => 'viewer'],
67    'user_e' => ['id' => 5, 'name' => 'Eve', 'role' => 'guest'], // array1にのみ存在する要素
68];
69
70$array2 = [
71    'user_a' => ['id' => 1, 'name' => 'Alice', 'role' => 'admin'], // array1のuser_aと完全に一致
72    'user_b' => ['id' => 2, 'name' => 'Robert', 'role' => 'editor'], // nameが異なるため、array1のuser_bは不一致と見なされる
73    'user_d' => ['id' => 4, 'name' => 'David', 'role' => 'admin'], // array1には存在しない
74    'user_c' => ['id' => 3, 'name' => 'Charlie', 'role' => 'viewer_v2'], // roleが異なるため、array1のuser_cは不一致と見なされる
75];
76
77$array3 = [
78    'user_c' => ['id' => 3, 'name' => 'Charlie', 'role' => 'viewer'], // array1のuser_cと完全に一致
79    'user_f' => ['id' => 6, 'name' => 'Frank', 'role' => 'moderator'],
80];
81
82echo "--- 比較対象配列 ---" . PHP_EOL;
83echo "Array1: " . json_encode($array1, JSON_PRETTY_PRINT) . PHP_EOL . PHP_EOL;
84echo "Array2: " . json_encode($array2, JSON_PRETTY_PRINT) . PHP_EOL . PHP_EOL;
85echo "Array3: " . json_encode($array3, JSON_PRETTY_PRINT) . PHP_EOL . PHP_EOL;
86
87// array_udiff_uassoc を使用して、array1 にのみ存在するキーと値のペアを検索
88// value_compare_func に compareMultidimensionalValues を、
89// key_compare_func に compareStringKeys を指定します。
90// array_udiff_uassoc は、$array1 の中で、$array2 または $array3 に
91// キーと値のペアが完全に一致する要素がないものを返します。
92$diff = array_udiff_uassoc(
93    $array1,
94    $array2,
95    $array3,
96    'compareMultidimensionalValues',
97    'compareStringKeys'
98);
99
100echo "--- array_udiff_uassoc の結果 ---" . PHP_EOL;
101echo "Array1 の中で、Array2 または Array3 にキーと値が完全に一致しない要素:" . PHP_EOL;
102echo json_encode($diff, JSON_PRETTY_PRINT) . PHP_EOL;
103

PHPのarray_udiff_uassoc関数は、複数の配列間で「キー」と「値」の両方を、ユーザーが定義した比較ルールに基づいて比較し、最初の配列にのみ存在する要素を抽出する関数です。

この関数は、比較の基準となる配列（$array1）と、比較対象となる一つ以上の配列（$array2, ...$arrays）を受け取ります。最大の特徴は、値の比較を行うためのコールバック関数（$value_compare_func）と、キーの比較を行うためのコールバック関数（$key_compare_func）をそれぞれ指定できる点です。これにより、PHPの標準的な比較では難しい複雑なロジックを適用できます。戻り値は、$array1に存在する要素のうち、他のどの配列にもキーと値のペアが完全に一致しないものだけを集めた新しい配列です。

提供されたサンプルコードでは、compareMultidimensionalValues関数が、多次元配列の要素である連想配列を詳細に比較するカスタムロジックを提供しています。この関数は、キーの存在有無や各キーに対応する値まで含めて比較するため、複雑なデータ構造の差分を正確に検出できます。また、compareStringKeys関数は、配列のキー（文字列）を比較するためのシンプルな関数です。これらのカスタム比較関数をarray_udiff_uassocに渡すことで、$array1の中から他の配列とキーと値が完全に一致しない要素を効率的に特定し、結果として表示しています。