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

<?php

/**
 * array_diff_assoc() は、最初の配列に存在するが、
 * 他の配列にはキーと値の両方が完全に一致する要素が存在しないエントリを返します。
 * これは、キーも値も両方が一致しないと「差分」と見なされることを意味します。
 * キーの型も比較対象となります。
 */

// 最初の配列を定義します。
// 各要素はキーと値のペアを持ちます。
$array1 = [
    "fruit_a" => "apple",
    "fruit_b" => "banana",
    "fruit_c" => "cherry",
    "color_a" => "red",
    0          => "grape", // 数値キーの例
    "1"        => "lemon", // 文字列キーの例
];

// 比較対象の2番目の配列を定義します。
// array1との違いに注目してください。
$array2 = [
    "fruit_a" => "apple",    // キーと値がarray1と一致するため、差分ではない
    "fruit_b" => "grape",    // キーは同じだが値が異なるため、差分である
    "fruit_d" => "date",     // array1には存在しないキーなので、差分ではない
    "color_a" => "blue",     // キーは同じだが値が異なるため、差分である
    0          => "grape",    // キーと値がarray1と一致するため、差分ではない
    1          => "lemon",    // キーの型がarray1と異なるため、差分である (array1は文字列"1"、array2は数値1)
];

// array_diff_assoc() を使用して、
// array1に存在するが、array2にはキーと値が完全に一致する要素がないエントリを見つけます。
$diffResult = array_diff_assoc($array1, $array2);

echo "array_diff_assoc の結果:\n";
print_r($diffResult);

/*
実行結果の解説:
Array
(
    [fruit_b] => banana
    [fruit_c] => cherry
    [color_a] => red
    [1] => lemon
)

- "fruit_a" => "apple": array1とarray2で完全に一致するため、結果には含まれません。
- "fruit_b" => "banana": array1では"banana"ですが、array2ではキー"fruit_b"の値が"grape"です。
  値が異なるため、array1のこの要素はarray2に存在しないと判断され、結果に含まれます。
- "fruit_c" => "cherry": array1には存在しますが、array2にはキー"fruit_c"が存在しないため、結果に含まれます。
- "color_a" => "red": array1では"red"ですが、array2ではキー"color_a"の値が"blue"です。
  値が異なるため、array1のこの要素はarray2に存在しないと判断され、結果に含まれます。
- 0 => "grape": array1とarray2で完全に一致するため、結果には含まれません。
- "1" => "lemon": array1ではキーが文字列"1"ですが、array2ではキーが数値1です。
  キーの型が異なるため、array1のこの要素はarray2に存在しないと判断され、結果に含まれます。
*/

PHPのarray_diff_assoc関数は、複数の配列を比較し、最初の配列に存在する要素のうち、比較対象となる他のどの配列にもキーと値の両方が完全に一致する要素がないものを抽出して新しい配列として返します。この関数は、引数として最初の配列（基準となる配列）と、比較したい1つ以上の配列を受け取ります。戻り値は、差分と判断された要素のみを含む新しい配列です。

この関数では、要素が「差分」とみなされる条件は、キーと値のペアが完全に一致しない場合です。特に重要なのは、キーの値だけでなく、キーのデータ型も厳密に比較の対象となる点です。例えば、文字列のキー"1"と数値のキー1は異なるものとして扱われます。

サンプルコードでは、$array1と$array2を比較しています。$array1の"fruit_b" => "banana"は、$array2に同じキー"fruit_b"が存在しますが値が"grape"と異なるため、差分として抽出されます。また、$array1の"fruit_c" => "cherry"は、$array2にキー自体が存在しないため、差分となります。さらに、$array1の"1" => "lemon"は、$array2には数値キーの1 => "lemon"として存在しますが、キーの型が異なるため、$array1の要素が差分として結果に含まれます。このように、array_diff_assocは厳密な比較を行うため、期待する結果を得るためにはキーと値、そしてキーの型の両方に注意が必要です。

<?php

/**
 * array_diff_key関数の使用例を示します。
 * この関数は、最初の配列とそれ以降の配列のキーを比較し、
 * 最初の配列にのみ存在するキーとその値からなる配列を返します。
 *
 * @return void
 */
function demonstrateArrayDiffKey(): void
{
    // 例1: 2つの配列のキーを比較
    echo "--- 例1: 2つの配列のキーを比較 ---" . PHP_EOL;

    // 最初の配列を定義します
    $array1 = [
        'apple'  => 1,
        'banana' => 2,
        'cherry' => 3,
        'date'   => 4,
    ];
    echo "最初の配列 (\$array1):" . PHP_EOL;
    print_r($array1);

    // 比較対象の配列を定義します
    $array2 = [
        'banana' => 20, // キー 'banana' は array1 にも存在する
        'date'   => 40,   // キー 'date' は array1 にも存在する
        'elder'  => 50,   // キー 'elder' は array1 に存在しない
    ];
    echo "比較対象の配列 (\$array2):" . PHP_EOL;
    print_r($array2);

    // array_diff_keyを使用して、array1にのみ存在するキーの要素を抽出します。
    // 'apple' と 'cherry' のキーは array2 に存在しないため、これらの要素が結果に含まれます。
    $result1 = array_diff_key($array1, $array2);
    echo "array_diff_keyの結果 (最初の配列にのみ存在するキーの要素):" . PHP_EOL;
    print_r($result1);
    echo PHP_EOL;

    // 例2: 複数の配列のキーを比較
    echo "--- 例2: 複数の配列のキーを比較 ---" . PHP_EOL;

    // 最初の配列
    $arrayA = [
        'color'    => 'red',
        'size'     => 'M',
        'material' => 'cotton',
        'brand'    => 'XYZ',
    ];
    echo "最初の配列 (\$arrayA):" . PHP_EOL;
    print_r($arrayA);

    // 比較対象の配列1
    $arrayB = [
        'size'     => 'L',
        'material' => 'silk',
        'pattern'  => 'striped',
    ];
    echo "比較対象の配列1 (\$arrayB):" . PHP_EOL;
    print_r($arrayB);

    // 比較対象の配列2
    $arrayC = [
        'color' => 'blue',
        'price' => 100,
    ];
    echo "比較対象の配列2 (\$arrayC):" . PHP_EOL;
    print_r($arrayC);

    // array_diff_keyは、arrayAのキーのうち、arrayBにもarrayCにも存在しないキーを持つ要素を返します。
    // - 'color' は arrayC に存在する
    // - 'size' は arrayB に存在する
    // - 'material' は arrayB に存在する
    // - 'brand' は arrayB と arrayC のどちらにも存在しない
    // よって、結果は 'brand' の要素のみとなります。
    $result2 = array_diff_key($arrayA, $arrayB, $arrayC);
    echo "array_diff_keyの結果 (最初の配列にのみ存在するキーの要素):" . PHP_EOL;
    print_r($result2);
    echo PHP_EOL;
}

// demonstrateArrayDiffKey関数の使用例を実行します
demonstrateArrayDiffKey();

?>

PHP 8で利用できるarray_diff_key関数は、複数の配列のキーを比較し、最初の配列にのみ存在するキーを持つ要素を抽出する際に使用します。この関数は、最初の引数に指定された配列を基準とし、その後に続く引数で渡された一つ以上の配列と比較を行います。戻り値として、最初の配列のキーのうち、比較対象となる他のどの配列にも存在しないキーとその値からなる新しい配列を返します。

引数$arrayは比較の基準となる最初の配列であり、...$arraysは最初の配列と比較したい一つ以上の配列です。この関数は、要素の値自体ではなく、キーの存在のみを比較の対象とします。

例えば、サンプルコードの例1では、$array1と$array2のキーを比較しています。array_diff_key($array1, $array2)を実行すると、$array1に存在するキーのうち、$array2には存在しないキーである'apple'と'cherry'を持つ要素が結果として得られます。

また、この関数は複数の配列を同時に比較することも可能です。例2のようにarray_diff_key($arrayA, $arrayB, $arrayC)と指定した場合、$arrayAのキーのうち、$arrayBと$arrayCのどちらにも存在しないキーを持つ要素のみが抽出されます。これにより、ある配列にだけ存在するユニークなキーを持つ要素を簡単に特定できます。