PHP マニュアル: キーを基準にし、コールバック関数を用いて配列の差を計算する

説明

array array_diff_ukey(array $array, array ...$arrays, callable $key_compare_func)

array のキーを arrays のキーと比較し、その差を返します。この関数は array_diff に似ていますが、値ではなくキーを用いて比較するという点が異なります。

array_diff_key とは異なり、内部関数ではなくユーザーが指定したコールバック関数を用いて添字を比較します。

パラメータ

array: 比較元の配列。
arrays: 比較する対象となる配列。
key_compare_func: 比較関数は、最初の引数と二番目の引数の比較結果を返します。最初の引数のほうが二番目の引数より大きい場合は正の整数を、二番目の引数と等しい場合はゼロを、そして二番目の引数より小さい場合は負の整数を返す必要があります。

int callback(mixed $a, mixed $b)

警告
float のような 非整数 を比較関数が返すと、その返り値を内部的に int にキャストして使います。つまり、0.99 や 0.1 といった値は整数値 0 にキャストされ、値が等しいとみなされます。

戻り値

array の要素のうち、その他の配列のいずれにも含まれないものだけを残した配列を返します。

例

例1 array_diff_ukey の例

<?php
function key_compare_func($key1, $key2)
{
    if ($key1 == $key2)
        return 0;
    else if ($key1 > $key2)
        return 1;
    else
        return -1;
}

$array1 = array('blue'  => 1, 'red'  => 2, 'green'  => 3, 'purple' => 4);
$array2 = array('green' => 5, 'blue' => 6, 'yellow' => 7, 'cyan'   => 8);

var_dump(array_diff_ukey($array1, $array2, 'key_compare_func'));
?>

上の例の出力は以下となります。

array(2) {
  ["red"]=>
  int(2)
  ["purple"]=>
  int(4)
}

注意

注意:
この関数は n 次元配列の一つの次元しかチェックしません。もちろん、array_diff_ukey($array1[0], $array2[0], 'callback_func'); のようにすることでより深い次元でのチェックもできます。

参考

array_diff
array_udiff
array_diff_assoc
array_diff_uassoc
array_udiff_assoc
array_udiff_uassoc
array_diff_key
array_intersect
array_intersect_assoc
array_intersect_uassoc
array_intersect_key
array_intersect_ukey