CODEWITHSUNDEEP
phparrays
marcvangend
marcvangend

Reputation: 5642

PHP: check if nested array values exist in another array, while ignoring additional values

Given the following haystack and needle:

$haystack = array(
  'foo' => array(
    1 => 'one',
    2 => 'two',
    3 => 'three',
  ),
);

$needle = array(
  'foo' => array(
    1 => 'one',
    2 => 'two',
  ),
);

I want to check if all nested key-value pairs of the needle occur in the haystack (like it does in the example above), while ignoring any additional key-value pairs that may exist in the haystack (like $haystack['foo'][3] in the example).

There are many similar questions on SO but I haven't found a solution for this specific use case. Is there a (combination of) standard PHP functions to do this? What is the most elegant solution?

[update]

I didn't make clear yet that the arrays may not always have the same depth. Also, the keys of the elements in the arrays may be different every time.

Upvotes: 0

Views: 352

Answers (2)

John Conde
John Conde

Reputation: 219884

array_intersect() will tell you what values match. Just make sure that matches your $needle.

echo $needle['foo'] === array_intersect($needle['foo'], $haystack['foo']);

Upvotes: 2

marcvangend
marcvangend

Reputation: 5642

This is what I came up with myself. It works, but it seems more complex than it should be...

/**
 * Helper function which recursively checks if the key-value pairs in one array
 * are all present in another array. If all key-value pairs in the needle are
 * present in the haystack, and the haystack also contains additional items,
 * the check wil still pass.
 *
 * @param array $needle
 *   The array with the key-value pairs to look for.
 * @param array $haystack
 *   The array in which to look for the key-value pairs.
 * @return bool
 *   TRUE if all key-value pairs of the needle occur in the haystack. FALSE if
 *   one or more keys or values are missing or different.
 */
function array_contains(array $needle, array $haystack) {
  // First, check if needle and haystack are identical. In that case it's easy.
  if ($needle === $haystack) {
    return TRUE;
  }
  foreach ($needle as $key => $value) {
    // If the key does not occur in the haystack, we're done.
    if (!isset($haystack[$key])) {
      return FALSE;
    }
    // If the value is an array...
    if (is_array($value)) {
      // ...see if the counterpart in $haystack is an array too...
      if (!is_array($haystack[$key])) {
        return FALSE;
      }
      // ...and if so, recurse.
      if (array_contains($value, $haystack[$key]) == FALSE) {
        return FALSE;
      }
    }
    // If the values are not arrays and not the same, the check fails.
    else if ($value != $haystack[$key]) {
      return FALSE;
    }
  }
  // If we still didn't fail, all tests have passed.
  return TRUE;
}

Upvotes: 0

Related Questions