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

Copy
1<?php
2
3/**
4 * array_uintersect の使用例
5 *
6 * このスクリプトは、ユーザー定義の比較関数を使用して配列の共通要素を比較・抽出します。
7 * `array_uintersect` は、要素の値の比較方法をカスタマイズしたい場合に特に有用です。
8 * この例では、文字列を大文字・小文字を区別せずに比較し、共通の要素を見つけます。
9 */
10
11// 比較対象となる2つの配列を定義します。
12$array1 = ["Apple", "Banana", "orange", "Grape", "Melon"];
13$array2 = ["banana", "ORANGE", "Kiwi", "apple"];
14
15/**
16 * ユーザー定義の比較関数
17 *
18 * この関数は array_uintersect に渡され、2つの値を比較します。
19 * - 値1が値2より小さい場合、負の整数を返します。
20 * - 値1が値2より大きい場合、正の整数を返します。
21 * - 両方の値が等しい場合、0を返します。
22 *
23 * この例では、strcasecmp を使用して、文字列を大文字・小文字を区別せずに比較します。
24 *
25 * @param string $a 比較する最初の値
26 * @param string $b 比較する2番目の値
27 * @return int 比較結果を示す整数
28 */
29$caseInsensitiveCompare = function (string $a, string $b): int {
30    return strcasecmp($a, $b);
31};
32
33// array_uintersect を使用して、大文字・小文字を区別せずに共通の要素を抽出します。
34$result = array_uintersect($array1, $array2, $caseInsensitiveCompare);
35
36echo "元の配列1: " . implode(", ", $array1) . PHP_EOL;
37echo "元の配列2: " . implode(", ", $array2) . PHP_EOL;
38echo "大文字・小文字を区別しない共通要素 (array_uintersect): " . implode(", ", $result) . PHP_EOL;
39
40// 期待される出力:
41// 元の配列1: Apple, Banana, orange, Grape, Melon
42// 元の配列2: banana, ORANGE, Kiwi, apple
43// 大文字・小文字を区別しない共通要素 (array_uintersect): Apple, Banana, orange
44// (または apple, banana, ORANGE - array_uintersect は最初の配列の値を保持します)
45
46?>

PHPのarray_uintersect関数は、複数の配列から共通する要素を抽出する際に、ユーザーが定義した比較ルールを適用できる点が特徴です。標準のarray_intersect関数とは異なり、要素の値の比較方法を細かく制御したい場合に大変役立ちます。

この関数は、比較対象となる複数の配列を引数として受け取ります。最後の引数には、2つの値を比較してその順序関係を示す整数（負の数、0、正の数）を返すコールバック関数を指定します。このコールバック関数が、要素同士を比較し、共通性を判断する基準となります。関数が返す配列には、渡されたすべての配列に存在する共通要素が含まれますが、値は最初の配列（$array1）から取得されます。

サンプルコードでは、array_uintersectを用いて、文字列を大文字・小文字を区別せずに比較し、共通の要素を見つける方法を示しています。ここではstrcasecmpという組み込み関数を利用した匿名関数を比較関数として定義しています。これにより、「Apple」と「apple」、「orange」と「ORANGE」を同じ要素として認識し、共通部分として抽出することが可能です。このように、独自の比較ロジックを適用して配列の共通要素を見つけたい場合にarray_uintersectは非常に有用です。

Copy
1<?php
2
3/**
4 * array_uintersect の基本的な使用例
5 * 
6 * 複数の配列から、ユーザー定義の比較関数に基づいて共通する値を抽出します。
7 * この関数は配列の「値」を比較し、共通する要素を返します。
8 * array_intersect_key 関数が「キー」を比較するのに対し、
9 * array_uintersect は「値」を比較する点が異なります。
10 */
11
12/**
13 * 大文字小文字を区別せずに文字列を比較するコールバック関数。
14 * 
15 * array_uintersect はこの関数を使い、2つの値を比較します。
16 * 負の数を返すと $a が $b より小さい、正の数を返すと $a が $b より大きい、
17 * 0 を返すと $a と $b が等しいと判断されます。
18 *
19 * @param string $a 比較する最初の文字列
20 * @param string $b 比較する2番目の文字列
21 * @return int 負の数、正の数、または 0
22 */
23function compareStringsCaseInsensitive(string $a, string $b): int
24{
25    // strcasecmp は大文字小文字を区別しない文字列比較を行います。
26    return strcasecmp($a, $b);
27}
28
29// 最初の配列を定義します。
30$array1 = [
31    'fruit_a' => 'Apple',
32    'fruit_b' => 'Banana',
33    'fruit_c' => 'Orange',
34    'fruit_d' => 'Grape',
35];
36
37// 2番目の配列を定義します。
38// array1 と一部共通する値を含みますが、大文字小文字が異なる場合もあります。
39$array2 = [
40    'item_x' => 'apple', // 'Apple' と大文字小文字を無視すれば一致
41    'item_y' => 'Grape',
42    'item_z' => 'Mango',
43    'item_w' => 'banana', // 'Banana' と大文字小文字を無視すれば一致
44];
45
46// 3番目の配列を定義します。(オプション)
47$array3 = [
48    'produce_1' => 'apple',
49    'produce_2' => 'Kiwi',
50    'produce_3' => 'Banana', // 'Banana' と大文字小文字を無視すれば一致
51];
52
53echo "--- 元の配列 ---" . PHP_EOL;
54echo "配列1: " . print_r($array1, true);
55echo "配列2: " . print_r($array2, true);
56echo "配列3: " . print_r($array3, true);
57
58// array_uintersect を使用して、大文字小文字を区別せずに共通する値を抽出します。
59// 比較関数として 'compareStringsCaseInsensitive' を指定します。
60// 結果の配列のキーは維持されず、新しい数値キーが割り当てられます。
61$commonValues = array_uintersect($array1, $array2, $array3, 'compareStringsCaseInsensitive');
62
63echo "--- array_uintersect の結果 (共通値) ---" . PHP_EOL;
64echo "結果: " . print_r($commonValues, true);
65
66/*
67このコードを実行すると、以下の結果が出力されます。
68
69--- 元の配列 ---
70配列1: Array
71(
72    [fruit_a] => Apple
73    [fruit_b] => Banana
74    [fruit_c] => Orange
75    [fruit_d] => Grape
76)
77配列2: Array
78(
79    [item_x] => apple
80    [item_y] => Grape
81    [item_z] => Mango
82    [item_w] => banana
83)
84配列3: Array
85(
86    [produce_1] => apple
87    [produce_2] => Kiwi
88    [produce_3] => Banana
89)
90--- array_uintersect の結果 (共通値) ---
91結果: Array
92(
93    [0] => Apple
94    [1] => Banana
95    [2] => Grape
96)
97
98解説:
99- 'Apple' (array1), 'apple' (array2), 'apple' (array3) は比較関数により共通と判断され、
100  array1 から見つかった値 'Apple' が結果に含まれます。
101- 'Banana' (array1), 'banana' (array2), 'Banana' (array3) も同様に共通と判断され、
102  array1 から見つかった値 'Banana' が結果に含まれます。
103- 'Grape' (array1), 'Grape' (array2) は共通と判断され、
104  array1 から見つかった値 'Grape' が結果に含まれます。
105- array_uintersect は共通要素の値を最初の配列から取得し、結果のキーは新しい数値キーとなります。
106*/

array_uintersect関数は、複数の配列の中から「共通する値」を、開発者が定義した比較ルール（コールバック関数）に基づいて見つけ出し、新しい配列として返すPHPの関数です。この関数は配列の「値」に着目して比較を行うため、キーを比較するarray_intersect_key関数とは異なる点にご注意ください。

引数には、比較対象となる複数の配列と、値の比較方法を定義するcallable型の関数を指定します。この比較関数は、2つの値を引数として受け取り、最初の値が2番目の値より小さい場合は負の数、大きい場合は正の数、等しい場合はゼロを返します。戻り値は、共通する値だけを含む新しい配列で、そのキーは元の配列から引き継がれず、自動的に0から始まる数値キーが割り当てられます。共通と判断された値は、最初の引数として渡された配列から取得されます。

上記のサンプルコードでは、compareStringsCaseInsensitiveというコールバック関数を定義し、大文字と小文字を区別せずに文字列を比較するように設定しています。$array1、$array2、$array3の3つの配列をarray_uintersectでこのコールバック関数を使って比較すると、「Apple」「Banana」「Grape」が大文字小文字を無視して共通の文字列と判断されます。例えば、$array1の'Apple'、$array2の'apple'、$array3の'apple'が等しいと判断され、結果には$array1から取得された'Apple'が格納されます。これにより、ユーザー定義の柔軟な条件で共通要素を抽出できます。