データの比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算する

# array_udiff_assoc

(PHP 5, PHP 7, PHP 8)

array_udiff_assoc — データの比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算する

### 説明

function array_udiff_assoc(array `$array`, array `...$arrays`, callable `$value_compare_func`): array

データの比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算します。

> 注意: この関数は n 次元配列の一つの次元しかチェックしないことに注意してください。 もちろん、`array_udiff_assoc($array1[0], $array2[0], "some_comparison_func");` のようにすることでより深い次元でのチェックもできます。

### パラメータ

`array`

  最初の配列。

`arrays`

  比較対象の配列。

`value_compare_func`
  比較関数は、最初の引数と二番目の引数の比較結果を返します。最初の引数のほうが二番目の引数より大きい場合は正の整数を、二番目の引数と等しい場合はゼロを、そして二番目の引数より小さい場合は負の整数を返す必要があります。
  function callback(mixed `$a`, mixed `$b`): int
  警告

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

  警告

  ソートに使うコールバック関数は、任意の配列からの任意の値を、もともとの順番に関係なく、任意の順番で処理できなければいけません。なぜなら、個々の配列は、他の配列と比較する前に最初にソートされるからです。 サンプルコードは、以下のようになります:

      <?php
      $arrayA = ["string", 1];
      $arrayB = [["value" => 1]];
      // $item1 と $item2 は "string", 1, ["value" => 1] のいずれでも構いません
      $compareFunc = static function ($item1, $item2) {
          $value1 = is_string($item1) ? strlen($item1) : (is_array($item1) ? $item1["value"] : $item1);
          $value2 = is_string($item2) ? strlen($item2) : (is_array($item2) ? $item2["value"] : $item2);
          return $value1 <=> $value2;
      };
      ?>

### 戻り値

array_udiff_assoc() は、 `array` から他の引数の配列の中に現れない全ての値を含む array を返します。 array_diff() や array_udiff() と異なり、キーが比較に使用されることに注意してください。 配列のデータの比較は、ユーザーが指定したコールバックを用いて行われます。 この点で、array_diff_assoc() は反対の動作、つまり 内部関数を利用した比較を行います。

### 例

例1 array_udiff_assoc() の例

    <?php
    class cr {
        private $priv_member;
        function __construct($val)
        {
            $this->priv_member = $val;
        }

        static function comp_func_cr($a, $b)
        {
            if ($a->priv_member === $b->priv_member) return 0;
            return ($a->priv_member > $b->priv_member)? 1:-1;
        }
    }

    $a = array("0.1" => new cr(9), "0.5" => new cr(12), 0 => new cr(23), 1=> new cr(4), 2 => new cr(-15),);
    $b = array("0.2" => new cr(9), "0.5" => new cr(22), 0 => new cr(3), 1=> new cr(4), 2 => new cr(-15),);

    $result = array_udiff_assoc($a, $b, array("cr", "comp_func_cr"));
    print_r($result);
    ?>

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

    Array
    (
        [0.1] => cr Object
            (
                [priv_member:private] => 9
            )

        [0.5] => cr Object
            (
                [priv_member:private] => 12
            )

        [0] => cr Object
            (
                [priv_member:private] => 23
            )
    )

上の例で、`"1" => new cr(4)` の組み合わせが両方の配列にあること、 そしてそれが関数の出力に含まれていないことが確認できます。

### 参考

- array_diff() - 配列の差を計算する
- array_diff_assoc() - 追加された添字の確認を含めて配列の差を計算する
- array_diff_uassoc() - ユーザーが指定したコールバック関数を利用し、 追加された添字の確認を含めて配列の差を計算する
- array_udiff() - データの比較にコールバック関数を用い、配列の差を計算する
- array_udiff_uassoc() - データと添字の比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算する
- array_intersect() - 配列の共通項を計算する
- array_intersect_assoc() - 追加された添字の確認も含めて配列の共通項を確認する
- array_uintersect() - データの比較にコールバック関数を用い、配列の共通項を計算する
- array_uintersect_assoc() - データの比較にコールバック関数を用い、 追加された添字の確認も含めて配列の共通項を計算する
- array_uintersect_uassoc() - データと添字の比較に個別のコールバック関数を用い、 追加された添字の確認も含めて配列の共通項を計算する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open