PHPのarray_diff_assoc!キーを含めて配列の差を確認する

PHPのarray_diff_assoc関数は、複数の配列の差を確認して、最初の配列に存在し、他の配列には存在しない要素を返します。
array_diff関数と似ていますが、array_diff_assoc関数はキーも比較対象に含まれます。

この関数を使うと、キーと値の両方を考慮した差分を簡単に取得できます。

array_diff_assoc関数の基本的な使い方

array_diff_assoc関数は、複数の配列の差を確認して、最初の配列に存在し、他の配列には存在しない要素を返します。
基本的な構文は以下のとおりです。

array_diff_assoc(array $array1, array ...$arrays): array
  • $array1: 比較元の配列。
    • 連想配列を指定します。
  • $arrays: 比較対象の配列(複数指定可能)。
    • 連想配列を複数指定できます。

array_diff_assoc関数の戻り値

array_diff_assoc関数の戻り値は、最初の配列に存在して、他の配列には存在しない要素を含む配列です。
すべての要素が他の配列に存在する場合、空の配列を返します。

2つの配列の差を確認する

2つの配列の差をキーも含めて確認します。

<?php
$array1 = ['apple' => 'red', 'banana' => 'yellow', 'orange' => 'orange'];
$array2 = ['apple' => 'green', 'banana' => 'yellow', 'kiwi' => 'brown'];

$result = array_diff_assoc($array1, $array2);

print_r($result);
// 結果:Array ( [apple] => red [orange] => orange )
?>

最初に$array1$array2という連想配列を作成しています。
そしてarray_diff_assoc関数を使って、$array1$array2の差を確認しています。

$array1に存在し、$array2には存在しない要素はappleorangeなので、これらの要素が返されます。
bananaはキーと値が両方とも一致するため、差分としては検出されません。

このようにキーも含めて、違う場合に差分として配列が返ってきます。

3つ以上の配列の差を確認する

3つの配列の差をキーも含めて確認します。 

<?php
$array1 = ['apple' => 'red', 'banana' => 'yellow', 'orange' => 'orange'];
$array2 = ['apple' => 'green', 'banana' => 'yellow', 'kiwi' => 'brown'];
$array3 = ['apple' => 'red', 'banana' => 'white', 'melon' => 'green'];

$result = array_diff_assoc($array1, $array2, $array3);

print_r($result);
// 結果:Array ( [orange] => orange )
?>

array_diff_assoc関数を使って、$array1$array2$array3の差を確認しています。
$array1に存在し、$array2$array3には存在しない要素はorangeのみなので、orangeが返されます。

array_diff_assoc関数を使うメリット

array_diff_assoc関数を使う主なメリットは以下のとおりです。

  • キーと値の両方を考慮した差分を取得: キーと値の両方を考慮した差分を簡単に取得できます。
  • コードの簡潔化: ループ処理を記述する必要がなく、コードが簡潔になります。
  • 可読性の向上: コードの意図が明確になり、可読性が向上します。

PHPのarray_diff_assoc関数の使い方まとめ

今回はPHPのarray_diff_assoc関数の使い方について解説しました。
この記事の内容をまとめます。

・`array_diff_assoc(array $array1, array …$arrays): array`で複数の配列の差を計算する(キーも比較対象)。
・`$array1`は比較元の配列。
・`$arrays`は比較対象の配列(複数指定可能)。
・最初の配列に存在し、他の配列には存在しない要素(キーも比較)を含む配列を返す。
・キーと値の両方を考慮した差分を簡単に取得する場合に便利。
PHP

コメント