SYNCERのロゴ
アイキャッチ画像

array_diff_ukey - ユーザー定義のアルゴリズムで、配列のキーの差異を確認する

array_diff_ukeyは、配列のキーの差異を調べる関数です。ユーザーが定義したコールバック関数で差異を判定できます。

構文

array array_diff_ukey ( array $array1 , array $array2 [, array $... ], callable $key_compare_func )

パラメータ

$array1

基本の配列。

$array2

比較対象となる配列。

$...

3つ以上の配列を比較したい場合、第3引数、第4引数、と指定できる。

$key_compare_func

int callback ( mixed $a, mixed $b )

差異を判定するための比較関数を最後の引数として指定する。このコールバック関数は比較対象の2つの値を受け取る。関数が0を返した時に同じ、正の数を返した時に第1引数の方が大きい、負の数を返した時に第1引数の方が小さい、と判定される。

返り値

array

第1引数の配列にはあって、第2引数以降に指定した配列にはないキーの要素を集めた配列。

サンプルコード

<?php
	$array1 = [
		"a" => "red",
		"b" => "green",
		"c" => "purple",
	] ;

	$array2 = [
		"d" => "red",
		"b" => "green",
		"f" => "purple",
	] ;

	function key_compare_func( $a, $b ) {
		return 0 ;
	}

	$response = array_diff_ukey( $array1, $array2, "key_compare_func" ) ;

デモ

コールバック関数には、"a""d""a""e"、といったように比較対象の2つのキーが渡され、結果を出すのに必要なだけ、関数が実行されます。関数が0を返すと、2つのキーは同じだと判定されます。物は試しに、必ず0を返す関数を指定してみます。すると、結果(違うキー)はなしだと判定されます。

<?php
/*** このコードは編集できます。 ***/

	$array1 = [
		"a" => "red",
		"b" => "green",
		"c" => "purple",
	] ;

	$array2 = [
		"d" => "red",
		"b" => "green",
		"f" => "purple",
	] ;

	function key_compare_func( $a, $b ) {
		return 0 ;
	}

	$response = array_diff_ukey( $array1, $array2, "key_compare_func" ) ;

	var_dump( $response ) ;
array(0) {
}

今度は必ず0以外を返してみます。すると、全てのキーは同じじゃない、と判定されます。

<?php
/*** このコードは編集できます。 ***/

	$array1 = [
		"a" => "red",
		"b" => "green",
		"c" => "purple",
	] ;

	$array2 = [
		"d" => "red",
		"b" => "green",
		"f" => "purple",
	] ;

	function key_compare_func( $a, $b ) {
		return 1 ;
	}

	$response = array_diff_ukey( $array1, $array2, "key_compare_func" ) ;

	var_dump( $response ) ;
array(3) {
  ["a"]=>
  string(3) "red"
  ["b"]=>
  string(5) "green"
  ["c"]=>
  string(6) "purple"
}

"a""d"を同じものだと判定する関数にしてみましょう。すると、"a""d"は違うキーなのに、結果には含まれません。このように、独自のルールで差異を判定したい時に便利です。

<?php
/*** このコードは編集できます。 ***/

	$array1 = [
		"a" => "red",
		"b" => "green",
		"c" => "purple",
	] ;

	$array2 = [
		"d" => "red",
		"b" => "green",
		"f" => "purple",
	] ;

	function key_compare_func( $a, $b ) {
		// "a"は"d"と同じ扱い
		if( $a == "a" ) $a = "d" ;
		if( $b == "a" ) $b = "d" ;

		// 他は自然な処理
		if( $a == $b ) {
			return 0 ;
		} else {
			return $a > $b ? 1 : -1 ;
		}
	}

	$response = array_diff_ukey( $array1, $array2, "key_compare_func" ) ;

	var_dump( $response ) ;
array(1) {
  ["c"]=>
  string(6) "purple"
}
  • Twitterでシェア
  • Facebookでシェア
  • Google+でシェア
  • はてなブックマークでシェア
  • pocketに保存
  • LINEでシェア
更新履歴
2017年6月21日 (水)
コンテンツを公開しました。