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

Copy
1<?php
2
3/**
4 * array_intersect_key関数の使用例。
5 * 複数の配列から、すべての配列に共通して存在するキーを持つ要素を抽出します。
6 * この例では、多次元配列の最上位のキーを比較してフィルタリングする方法を示します。
7 */
8
9// サンプルデータ: 複数の商品の詳細情報を含む多次元配列
10$allProducts = [
11    'PROD_A001' => [
12        'name' => 'スマートフォン',
13        'price' => 50000,
14        'category' => 'Electronics'
15    ],
16    'PROD_B002' => [
17        'name' => 'ワイヤレスイヤホン',
18        'price' => 15000,
19        'category' => 'Electronics'
20    ],
21    'PROD_C003' => [
22        'name' => 'スマートウォッチ',
23        'price' => 25000,
24        'category' => 'Wearable'
25    ],
26    'PROD_D004' => [
27        'name' => 'タブレットPC',
28        'price' => 40000,
29        'category' => 'Electronics'
30    ],
31];
32
33// 別のデータ: 在庫がある商品IDのリスト (値はキーの存在のみを示すため何でも良い)
34$inStockProducts = [
35    'PROD_A001' => true,
36    'PROD_C003' => true,
37    'PROD_E005' => true, // この商品IDは $allProducts には存在しません
38];
39
40// array_intersect_key() を使用して、$allProducts から $inStockProducts に
41// 存在するキー（商品ID）を持つ商品データのみを抽出します。
42// array_intersect_keyは、最初の配列のキーが、続く全ての配列にも存在する場合に、
43// 最初の配列のそのキーと値を保持します。
44$availableProducts = array_intersect_key($allProducts, $inStockProducts);
45
46echo "--- 全商品データ ---" . PHP_EOL;
47print_r($allProducts);
48echo PHP_EOL;
49
50echo "--- 在庫がある商品IDリスト ---" . PHP_EOL;
51print_r($inStockProducts);
52echo PHP_EOL;
53
54echo "--- 在庫がある商品データ (array_intersect_keyでフィルタリング) ---" . PHP_EOL;
55print_r($availableProducts);
56echo PHP_EOL;
57
58// 上記のコードを実行すると、`$availableProducts` には以下の内容が出力されます。
59// `PROD_A001` と `PROD_C003` の商品データのみが抽出されます。
60// `PROD_B002` と `PROD_D004` は `$inStockProducts` にキーが存在しないため除外されます。
61// `PROD_E005` は `$allProducts` にキーが存在しないため、結果には含まれません。
62/*
63Array
64(
65    [PROD_A001] => Array
66        (
67            [name] => スマートフォン
68            [price] => 50000
69            [category] => Electronics
70        )
71
72    [PROD_C003] => Array
73        (
74            [name] => スマートウォッチ
75            [price] => 25000
76            [category] => Wearable
77        )
78)
79*/

PHP 8のarray_intersect_key関数は、複数の配列間で共通して存在するキーを持つ要素を抽出するために使用されます。第一引数には基となる配列を、第二引数以降には比較対象となる配列を複数指定できます。この関数は、最初の配列のキーが、引数として渡された全ての比較対象配列にも存在する場合に、最初の配列からそのキーと値のペアを保持した新しい配列を返します。

サンプルコードでは、全ての商品情報を持つ多次元配列$allProductsと、在庫がある商品のIDリストを表す$inStockProductsを比較しています。array_intersect_key($allProducts, $inStockProducts)を実行すると、$allProductsの最上位のキー（商品ID）が$inStockProductsにも存在するかをチェックします。その結果、PROD_A001とPROD_C003という商品IDは両方の配列に共通して存在するため、$allProductsからこれらの商品データが抽出され、$availableProductsに格納されます。PROD_B002とPROD_D004は$inStockProductsにキーが存在しないため結果から除外され、PROD_E005は$allProductsに存在しないため、そもそも比較対象とならず結果には含まれません。このように、多次元配列の特定の階層のキーに基づいてデータを効率的にフィルタリングできる便利な関数です。

Copy
1<?php
2
3/**
4 * array_intersect_keyの基本的な使用方法を示すサンプルコード。
5 * 複数の配列のキーを比較し、最初の配列に存在し、かつ他のすべての配列にも存在するキーを持つ要素を返します。
6 * 返される配列の要素は、最初の配列の値が使用されます。
7 */
8
9// 最初の基準となる配列
10$array1 = [
11    'fruit' => 'apple',
12    'vegetable' => 'carrot',
13    'meat' => 'beef',
14    'dairy' => 'milk',
15];
16
17// 比較対象の配列1: 'fruit'と'meat'のキーが存在
18$array2 = [
19    'fruit' => 'orange',
20    'spice' => 'pepper',
21    'meat' => 'pork',
22    'liquid' => 'water',
23];
24
25// 比較対象の配列2: 'fruit'と'dairy'のキーが存在
26$array3 = [
27    'fruit' => 'banana',
28    'grain' => 'rice',
29    'dairy' => 'cheese',
30    'vegetable' => 'onion',
31];
32
33echo "--- 元の配列 ---" . PHP_EOL;
34echo "配列1: " . print_r($array1, true);
35echo "配列2: " . print_r($array2, true);
36echo "配列3: " . print_r($array3, true);
37
38// array_intersect_key を使用して、すべての配列に共通するキーを持つ要素を抽出
39// 返される配列は$array1の値を使用します
40$commonKeysWithValues = array_intersect_key($array1, $array2, $array3);
41
42echo "--- array_intersect_keyの結果 ---" . PHP_EOL;
43echo "すべての配列に共通するキーと、最初の配列(array1)からの値を持つ要素:" . PHP_EOL;
44print_r($commonKeysWithValues);
45
46// この例では、'fruit'のみがすべての配列に共通するキーです。
47// したがって、結果は ['fruit' => 'apple'] となります。
48// 'vegetable'はarray1とarray3にありますがarray2にはありません。
49// 'meat'はarray1とarray2にありますがarray3にはありません。
50// 'dairy'はarray1とarray3にありますがarray2にはありません。
51
52?>

array_intersect_keyは、PHPで複数の配列のキーを比較し、すべての配列に共通して存在するキーを持つ要素を抽出する関数です。

引数には、最初に基準となる配列を一つ指定し、その後に比較対象となる配列を複数指定します。この関数は、最初の基準配列のキーと、それに続くすべての比較対象配列のキーを照合します。

戻り値は新しい配列で、すべての入力配列に共通するキーを持つ要素のみが含まれます。このとき、返される配列の要素が持つ値は、常に最初の引数として渡された基準配列から取得されます。

サンプルコードでは、$array1、$array2、$array3の3つの配列を比較しています。これらの配列すべてに共通して存在するキーは'fruit'だけです。そのため、array_intersect_key($array1, $array2, $array3)の実行結果は、キーが'fruit'で、値が最初の配列$array1から取得された'apple'となる配列になります。このように、複数のデータセットから共通の識別子（キー）を持つ項目を効率的に見つけ出す際に利用されます。