MutableMap::filterWithKey

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

Description

public function filterWithKey(
  (function(Tk,Tv):bool) $fn,
): MutableMap<Tk,Tv>

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

Only keys and values that meet a certain criteria are affected by a call to filterWithKey(), while all values are affected by a call to mapWithKey().

The keys associated with the current MutableMap remain unchanged in the returned MutableMap; the keys will be used in the filtering process only.

Parameters

  • (function(Tk,Tv):bool) $fn - The callback containing the condition to apply to the current MutableMap keys and values.

Return Values