array_intersect_ukey

キーを基準にし、コールバック関数を用いて配列の共通項を計算する

説明

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

array_intersect_ukey は、他の全ての引数に存在する array の値を全て有する配列を返します。

パラメータ

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

int callback(mixed $a, mixed $b)

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

戻り値

array の値のうち、すべての引数に存在するキーのものを含む連想配列を返します。

例

例1 array_intersect_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_intersect_ukey($array1, $array2, 'key_compare_func'));
?>

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

array(2) {
  ["blue"]=>
  int(1)
  ["green"]=>
  int(3)
}

この例では、両方の配列に存在するキーが 'blue' と 'green' だけであり、それが返されていることがわかります。また、ふたつの配列の間で 'blue' と 'green' に対応する値が違うことにも注意しましょう。それでも一致していると判定されるのは、ただキーだけがチェックされているからです。返される値は array のものです。

参考

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