array_intersect_assoc
Here's a variation on array_intersect_key() that intersects the first (master) array's keys with the values of other arrays. It can also be used to intersect an array with an arbitrary list of keys (à la compact(), but using a source array instead of current variables):
<?php
function array_intersect_keylist(array $source)
{
$final = $source;
// Loop through all arguments passed
foreach(func_get_args() as $cx=> $keylist) if ($cx)
{
if (!is_array($keylist)) $keylist = Array((string)$keylist);
// Intersect
$final = array_intersect_key($final, array_fill_keys($keylist, ''));
}
return $final;
}
// Example usage
$test = Array('foo' => 'something', 'bar' => 'whatever');
// Returns Array('foo' => 'something')
array_intersect_keylist($test, Array('foo', 'baz') );
// Also returns Array('foo' => 'something')
array_intersect_keylist($test, 'foo', 'baz');
// Equivalent to...
array_intersect_key($test, Array('foo' => '', 'baz' => ''));
?>
array_intersect_key
(PHP 5 >= 5.1.0)
array_intersect_key — キーを基準にして配列の共通項を計算する
説明
array array_intersect_key
( array $array1
, array $array2
[, array $ ...
] )
array_intersect_key() は、 array1 の値のうち、 その他のすべての引数の中に共通して存在するキーと一致するキーの値からなる配列を返します。
パラメータ
- array1
-
値を調べるもととなる配列。
- array2
-
値を比較する対象となる配列。
- array
-
さらにそれ以外の配列。
返り値
array1 の値のうち、 すべての引数に存在するキーのものを含む連想配列を返します。
例
例1 array_intersect_key() の例
<?php
$array1 = array('blue' => 1, 'red' => 2, 'green' => 3, 'purple' => 4);
$array2 = array('green' => 5, 'blue' => 6, 'yellow' => 7, 'cyan' => 8);
var_dump(array_intersect_key($array1, $array2));
?>
上の例の出力は以下となります。
array(2) {
["blue"]=>
int(1)
["green"]=>
int(3)
}
この例では、両方の配列に存在するキーが 'blue' と 'green' だけであり、それが返されていることが わかります。また、ふたつの配列の間で 'blue' と 'green' に対応する値が違うことにも注意しましょう。 それでも一致していると判定されるのは、ただキーだけがチェックされているからです。 返される値は array1 のものです。
二つの要素は、 (string) $elem1 === (string) $elem2 の場合のみ等しいとみなされます。言い換えると、 文字列表現が同じ場合となります。
参考
- 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_ukey() - キーを基準にし、コールバック関数を用いて 配列の共通項を計算する
add a note
User Contributed Notesarray_intersect_key
Anonymous
07-Nov-2009 03:24
07-Nov-2009 03:24
php at keithtylerdotcom
03-Nov-2009 10:03
03-Nov-2009 10:03
A Q&D way to grab a specific entry from an assoc array returned from a function as a one liner:
Normally when a function returns an array, and you only want part of that array, you have to do:
<?php
$a=func();
$z=$a["desired"];
// ... use $z
?>
However, using an immediate array as the second argument to array_intersect_key allows you to skip this explicit assignment step:
<?php
$z=array_intersect_key(func(),Array("desired"=>""));
// ... use $z
?>
This may be appreciated by those who have been spoiled by the ability of e.g. Python to do:
<?python
z = func()["desired"]
?>
markus dot kappe at dix dot at
24-Sep-2009 08:43
24-Sep-2009 08:43
<?php
/**
* calculates intersection of two arrays like array_intersect_key but recursive
*
* @param array/mixed master array
* @param array array that has the keys which should be kept in the master array
* @return array/mixed cleand master array
*/
function myIntersect($master, $mask) {
if (!is_array($master)) { return $master; }
foreach ($master as $k=>$v) {
if (!isset($mask[$k])) { unset ($master[$k]); continue; } // remove value from $master if the key is not present in $mask
if (is_array($mask[$k])) { $master[$k] = $this->myIntersect($master[$k], $mask[$k]); } // recurse when mask is an array
// else simply keep value
}
return $master;
}
?>
pdemaziere at gmail dot com
24-Feb-2009 12:52
24-Feb-2009 12:52
Just a simple script if you want to use one array, which contains only zeros and ones, as mask for another one (both arrays must have the same size of course). $outcome is an array that contains only those values from $source where $mask is equal to 1.
<?php
$outcome = array_values(array_intersect_key( array_values($source), array_filter(array_values($mask)) ));
?>
PS: the array_values() function is necessary to ensure that both arrays have the same numbering/keys, otherwise your masking does not behave as you expect.
Enjoy!
CBWhiz at gmail dot com
05-Jan-2008 07:04
05-Jan-2008 07:04
I have found the following helpful:
<?PHP
function array_merge_default($default, $data) {
$intersect = array_intersect_key($data, $default); //Get data for which a default exists
$diff = array_diff_key($default, $data); //Get defaults which are not present in data
return $diff + $intersect; //Arrays have different keys, return the union of the two
}
?>
It's use is like both of the functions it uses, but keeps defaults and _only_ defaults. It's designed for key arrays, and i'm not sure how it will work on numeric indexed arrays.
Example:
<?PHP
$default = array(
"one" => 1,
"two" => 2
);
$untrusted = array(
"one" => 42,
"three" => 3
);
var_dump(array_merge_default($default, $untrusted));
array(2) {
["two"]=>
int(2)
["one"]=>
int(42)
}
?>
Rod Byrnes
06-May-2007 01:10
06-May-2007 01:10
Here is a faster version than those shown below, with optimisation for the case when only two arrays are passed. In my tests with a 10000 item first array and a 5000 item second array (run 20 times) this function ran in 1.89 seconds compared with 2.66 for the version posted by dak. For a three array case, same as above but with the third array containing 3333 values, the timing is 3.25 for this version compared with 3.7 for dak's version.
<?php
if (!function_exists('array_intersect_key'))
{
function array_intersect_key($isec, $keys)
{
$argc = func_num_args();
if ($argc > 2)
{
for ($i = 1; !empty($isec) && $i < $argc; $i++)
{
$arr = func_get_arg($i);
foreach (array_keys($isec) as $key)
{
if (!isset($arr[$key]))
{
unset($isec[$key]);
}
}
}
return $isec;
}
else
{
$res = array();
foreach (array_keys($isec) as $key)
{
if (isset($keys[$key]))
{
$res[$key] = $isec[$key];
}
}
return $res;
}
}
}
?>
17-Jul-2006 09:31
Here it is a more obvious way to implement the function:
if (!function_exists('array_intersect_key')) {
function array_intersect_key()
{
$arrs = func_get_args();
$result = array_shift($arrs);
foreach ($arrs as $array) {
foreach ($result as $key => $v) {
if (!array_key_exists($key, $array)) {
unset($result[$key]);
}
}
}
return $result;
}
}
Anton Backer
31-Mar-2006 04:49
31-Mar-2006 04:49
Jesse: no, array_intersect_key does not accomplish the same thing as what you posted:
array_flip (array_intersect (array_flip ($a), array_flip ($b)))
because when the array is flipped, values become keys. having duplicate values is not a problem, but having duplicate keys is. array_flip resolves it by keeping only one of the duplicates and discarding the rest. by the time you start intersecting, you've already lost information.
dak
24-Jan-2006 01:31
24-Jan-2006 01:31
A more efficient (and, I think, simpler) compatibility implementation:
<?php
if (!function_exists('array_intersect_key'))
{
function array_intersect_key ($isec, $arr2)
{
$argc = func_num_args();
for ($i = 1; !empty($isec) && $i < $argc; $i++)
{
$arr = func_get_arg($i);
foreach ($isec as $k =>& $v)
if (!isset($arr[$k]))
unset($isec[$k]);
}
return $isec;
}
}
?>
Silvio Ginter
23-Sep-2005 09:17
23-Sep-2005 09:17
Based on the code posted by gaylord dot aulke at 100days.de
i wrote this one. This should implement this function in all versions equal or greater than PHP 4.0
function array_intersect_key($arr1, $arr2) {
$res = array();
foreach($arr1 as $key=>$value) {
$push = true;
for ($i = 1; $i < func_num_args(); $i++) {
$actArray = func_get_arg($i);
if (gettype($actArray) != 'array') return false;
if (!array_key_exists($key, $actArray)) $push = false;
}
if ($push) $res[$key] = $arr1[$key];
}
return $res;
}
gaylord dot aulke at 100days.de
04-Jul-2005 08:04
04-Jul-2005 08:04
I tried to use this function with PHP 5.0.4 under windows but the function does not seem to be implemented.
(Fatal error: Call to undefined function array_intersect_key())
This works as a workaround for 2 arrays at least:
function array_intersect_key($arr1, $arr2) {
$res = array();
foreach($arr1 as $key=>$value) {
if(array_key_exists($key, $arr2)) $res[$key] = $arr1[$key];
}
return $res;
}
aidan at php dot net
30-May-2005 12:51
30-May-2005 12:51
This functionality is now implemented in the PEAR package PHP_Compat.
More information about using this function without upgrading your version of PHP can be found on the below link:
http://pear.php.net/package/PHP_Compat