HH\ImmVector::filterWithKey

Returns an ImmVector containing the values of the current ImmVector that meet a supplied condition applied to its keys and values.

Description

public function filterWithKey(
  (function(int,Tv):bool) $callback,
): ImmVector<Tv>

Returns an ImmVector containing the values of the current ImmVector that meet a supplied condition applied to its keys and values.

filterWithKey()'s result contains only values whose key/value pairs satisfy the provided criterion; unlike mapWithKey(), which contains results derived from every key/value pair in the original ImmVector.

Parameters

  • (function(int,Tv):bool) $callback - The callback containing the condition to apply to the ImmVector's key/value pairs. For each key/value pair, the key is passed as the first parameter to the callback, and the value is passed as the second parameter.

Return Values

  • ImmVector<Tv> - An ImmVector containing the values of the current ImmVector for which a user-specified test condition returns true when applied to the corresponding key/value pairs.

Examples

See Vector::filterWithKey for usage examples.