PHP - Ds Set::contains() Function

The PHP Ds\Set::contains() function determines whether the current set contains all the specified values. This function returns a boolean value 'true' if the given value is present in this set; 'false' otherwise.

The values of the type object are supported. If an object implements Ds\Hashable, its equals function will determine whether two objects are equal. If an object doesn't implement Ds\Hashable, objects are only equal if they are references to the same instance.

Syntax

Following is the syntax of the PHP Ds\Set::contains() function −

public Ds\Set::contains(mixed ...$values): bool

Parameters

Following is the parameter of this function −

• values − The values need to be checked.

Return value

This function returns 'true' if any of the given values are persent in the set, and 'false' otherwise.

Example 1

The following is the basic example of the PHP Ds\Set::contains() function −

<?php  
   $set = new \Ds\Set([1, 2, 3, 4, 5]);  
   echo "The set elements are: \n"; 
   var_dump($set);
   $val = 5;
   echo "The value need to determine: ". $val;
   #using contains() function
   echo "\nIs set contains value " .$val. "? ";
   var_dump($set->contains($val));
?>

Output

The above program generates the following output −

The set elements are:
object(Ds\Set)#1 (5) {
  [0]=>
  int(1)
  [1]=>
  int(2)
  [2]=>
  int(3)
  [3]=>
  int(4)
  [4]=>
  int(5)
}
The value need to determine: 5
Is set contains value 5? bool(true)

Example 2

The following is another example of the PHP Ds\Set::contains() function. We use this function to check whether this set (["Tutorials", "Point", "India"]) contains the specified elements "Hello" or not −

<?php  
   $set = new \Ds\Set(["Tutorials", "Point", "India"]);  
   echo "The set elements are: \n"; 
   var_dump($set);
   $val = "Hello";
   echo "The value need to determine: ". $val;
   #using contains() function
   echo "\nIs set contains value " .$val. "? ";
   var_dump($set->contains($val));
?>

Output

After executing the above program, it will display the following output −

The set elements are:
object(Ds\Set)#1 (3) {
  [0]=>
  string(9) "Tutorials"
  [1]=>
  string(5) "Point"
  [2]=>
  string(5) "India"
}
The value need to determine: Hello
Is set contains value Hello? bool(false)

Example 3

In the example below, we are using the contains() method to check whether this set (['a', 1, 'b', 2, 'c', 3, 'd', 4, 'e', 5]) contains the specified values "1", "a", "e", "10", and "g" or not −

<?php  
   $set = new \Ds\Set(['a', 1, 'b', 2, 'c', 3, 'd', 4, 'e', 5]); 
   echo "The set elements are: \n"; 
   var_dump($set);
   $val1 = 1;
   $val2 = "a";
   $val3 = "e";
   $val4 = 10;
   $val5 = "g";
   echo "The values need to determine: ". $val1 . ", ". $val2 . ", ". $val3 . ", ". $val4 . ", ". $val5;
   #using contains() function
   echo "\nIs set contains value " .$val1. "? ";
   var_dump($set->contains($val1));
   echo "\nIs set contains value " .$val2. "? ";
   var_dump($set->contains($val2));
   echo "\nIs set contains value " .$val3. "? ";
   var_dump($set->contains($val3));
   echo "\nIs set contains value " .$val4. "? ";
   var_dump($set->contains($val4));
   echo "\nIs set contains value " .$val5. "? ";
   var_dump($set->contains($val5));
?>

Output

On executing the above program, it will display the following output −

The set elements are:
object(Ds\Set)#1 (10) {
  [0]=>
  string(1) "a"
  [1]=>
  int(1)
  [2]=>
  string(1) "b"
  [3]=>
  int(2)
  [4]=>
  string(1) "c"
  [5]=>
  int(3)
  [6]=>
  string(1) "d"
  [7]=>
  int(4)
  [8]=>
  string(1) "e"
  [9]=>
  int(5)
}
The values need to determine: 1, a, e, 10, g
Is set contains value 1? bool(true)

Is set contains value a? bool(true)

Is set contains value e? bool(true)

Is set contains value 10? bool(false)

Is set contains value g? bool(false)