PHP 8.1.0 Released!

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::filter(callable $callback = ?): Ds\Set

Creates a new set using a callable to determine which values to include.

Parameters

callback

callback(mixed $value): bool

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([12345]);

var_dump($set->filter(function($value) {
    return 
$value == 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([01'a'truefalse]);

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)
}
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top