array_filter()中的回调函数只传递数组的值,而不是键。

如果我有:

$my_array = array("foo" => 1, "hello" => "world");

$allowed = array("foo", "bar");

删除$my_array中不在$allowed数组中的所有键的最佳方法是什么?

期望的输出:

$my_array = array("foo" => 1);

当前回答

基于@sepiariver,我在PHP 8.0.3上做了一些类似的测试:

$arr = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => 7, 'h' => 8];
$filter = ['a', 'e', 'h'];


$filtered = [];
$time = microtime(true);
$i = 1000000;
while($i) {
  $filtered = array_intersect_key($arr, array_flip($filter));
  $i--;
}
print_r($filtered);
echo microtime(true) - $time . " using array_intersect_key\n\n";


$filtered = [];
$time = microtime(true);
$i = 1000000;
while($i) {
  $filtered = array_filter(
    $arr,
    function ($key) use ($filter){return in_array($key, $filter);},
    ARRAY_FILTER_USE_KEY
  );
  $i--;
}
print_r($filtered);
echo microtime(true) - $time . " using array_filter\n\n";

$filtered = [];
$time = microtime(true);
$i = 1000000;
while($i) {
  foreach ($filter as $key)
    if(array_key_exists($key, $arr))
      $filtered[$key] = $arr[$key];
  $i--;
}
print_r($filtered);
echo microtime(true) - $time . " using foreach + array_key_exists\n\n";

0.28603601455688使用array_intersect_key 1.3096671104431 using array_filter 0.19402384757996使用foreach + array_key_exists

array_filter的“问题”是它将遍历$arr的所有元素,而array_intersect_key和foreach只遍历$filter。后者更有效,假设$filter小于$arr。

其他回答

当使用array_filter时,如何获得数组的当前键

不管我多么喜欢Vincent对maek问题的解决方案,它实际上并没有使用array_filter。如果你从一个搜索引擎来到这里,在array_filter的回调中寻找一种访问当前迭代的键的方法,你可能会寻找这样的东西(PHP >= 5.3):

$my_array = ["foo" => 1, "hello" => "world"];

$allowed = ["foo", "bar"];

reset($my_array ); // Unnecessary in this case, as we just defined the array, but
                   // make sure your array is reset (see below for further explanation).

$my_array = array_filter($my_array, function($value) use (&$my_array, $allowed) {
  $key = key($my_array); // request key of current internal array pointer
  next($my_array); // advance internal array pointer

  return isset($allowed[$key]);
});

// $my_array now equals ['foo' => 1]

它将筛选的数组作为回调的引用传递。由于array_filter并不通过增加数组的公共内部指针来迭代数组,所以你必须自己提高它。

这里重要的是,你需要确保你的数组被重置,否则你可能会从它的中间开始(因为内部数组指针被之前执行的一些代码留在那里)。

我使用了一个小的“Utils”类,其中我添加了两个过滤器静态函数来使用denylist或allowlist来过滤数组。

<?php

class Utils {
 
  /**
   * Filter an array based on a allowlist of keys
   *
   * @param array $array
   * @param array $allowlist
   *
   * @return array
   */
  public static function array_keys_allowlist( array $array, array $allowlist ): array {
    return array_intersect_key( $array, array_flip( $allowlist ) );
  }


  /**
   * Filter an array based on a denylist of keys
   *
   * @param array $array
   * @param array $denylist
   *
   * @return array
   */
  public static function array_keys_denylist( array $array, array $denylist ): array {
    return array_diff_key($array,array_flip($denylist));
  }

}

然后你可以像这样使用它

<?php

$my_array = array("foo" => 1, "hello" => "world");
$allowed = array("foo", "bar");

$my_array = Utils::array_keys_allowlist($my_array,  $allowed)

PHP 5.6为array_filter()引入了第三个参数flag,你可以将它设置为ARRAY_FILTER_USE_KEY来按键而不是按值进行过滤:

$my_array = ['foo' => 1, 'hello' => 'world'];
$allowed  = ['foo', 'bar'];
$filtered = array_filter(
    $my_array,
    function ($key) use ($allowed) {
        // N.b. in_array() is notorious for being slow 
        return in_array($key, $allowed);
    },
    ARRAY_FILTER_USE_KEY
);

由于PHP 7.4引入了箭头函数,我们可以让它更简洁:

$my_array = ['foo' => 1, 'hello' => 'world'];
$allowed  = ['foo', 'bar'];
$filtered = array_filter(
    $my_array,
    fn ($key) => in_array($key, $allowed),
    ARRAY_FILTER_USE_KEY
);

显然,这没有array_intersect_key($my_array, array_flip($allowed))那么优雅,但它确实提供了额外的灵活性,可以对键执行任意测试,例如,$allowed可以包含正则表达式模式,而不是普通字符串。

还可以使用ARRAY_FILTER_USE_BOTH将值和键同时传递给筛选函数。下面是一个基于第一个例子的例子,但是注意,我不建议使用$允许这种方式编码过滤规则:

$my_array = ['foo' => 1, 'bar' => 'baz', 'hello' => 'wld'];
$allowed  = ['foo' => true, 'bar' => true, 'hello' => 'world'];
$filtered = array_filter(
    $my_array,
    fn ($val, $key) => isset($allowed[$key]) && (
        $allowed[$key] === true || $allowed[$key] === $val
    ),
    ARRAY_FILTER_USE_BOTH
); // ['foo' => 1, 'bar' => 'baz']

如果只需要一次,可能会有些多余,但您可以使用YaLinqo库*来筛选集合(并执行任何其他转换)。这个库允许以流畅的语法对对象执行类似sql的查询。在这里,函数接受带有两个参数的回调:一个值和一个键。例如:

$filtered = from($array)
    ->where(function ($v, $k) use ($allowed) {
        return in_array($k, $allowed);
    })
    ->toArray();

(where函数返回一个迭代器,所以如果你只需要在结果序列上用foreach迭代一次,->toArray()可以被删除。)

*由我开发

从PHP 5.6开始,你可以在array_filter中使用ARRAY_FILTER_USE_KEY标志:

$result = array_filter($my_array, function ($k) use ($allowed) {
    return in_array($k, $allowed);
}, ARRAY_FILTER_USE_KEY);

否则,你可以使用这个函数(来自TestDummy):

function filter_array_keys(array $array, $callback)
{
    $matchedKeys = array_filter(array_keys($array), $callback);

    return array_intersect_key($array, array_flip($matchedKeys));
}

$result = filter_array_keys($my_array, function ($k) use ($allowed) {
    return in_array($k, $allowed);
});

这是我的一个增强版,它接受一个回调或者直接输入键:

function filter_array_keys(array $array, $keys)
{
    if (is_callable($keys)) {
        $keys = array_filter(array_keys($array), $keys);
    }

    return array_intersect_key($array, array_flip($keys));
}

// using a callback, like array_filter:
$result = filter_array_keys($my_array, function ($k) use ($allowed) {
    return in_array($k, $allowed);
});

// or, if you already have the keys:
$result = filter_array_keys($my_array, $allowed));

最后,你也可以使用简单的foreach:

$result = [];
foreach ($my_array as $key => $value) {
    if (in_array($key, $allowed)) {
        $result[$key] = $value;
    }
}