Ds\Set::filter
Ds\Set::filter
(PECL ds >= 1.0.0)
Ds\Set::filter — Creates a new set using a callable to determine which values to include.
Description
public Ds\Set Ds\Set::filter ([ callable $callback ] )
Creates a new set using a callable to determine which values to include.
Parameters
-
callback
-
bool callback ( mixed $value )
Optional callable which returns
TRUE
if the value should be included,FALSE
otherwise.If a callback is not provided, only values which are
TRUE
(see converting to boolean) will be included.
Return Values
A new set containing all the values for which either the callback
returned TRUE
, or all values that convert to TRUE
if a callback
was not provided.
Examples
Example #1 Ds\Set::filter() example using callback function
<?php $set = new \Ds\Set([1, 2, 3, 4, 5]); var_dump($set->filter(function($value) { return $value % 2 == 0; })); ?>
The above example will output something similar to:
object(Ds\Set)#3 (2) { [0]=> int(2) [1]=> int(4) }
Example #2 Ds\Set::filter() example without a callback function
<?php $set = new \Ds\Set([0, 1, 'a', true, false]); var_dump($set->filter()); ?>
The above example will output something similar to:
object(Ds\Set)#2 (3) { [0]=> int(1) [1]=> string(1) "a" [2]=> bool(true) }
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/ds-set.filter.php