PHP - Ds Vector::contains() Function

---

---

The PHP Ds\Vector::contains() function is used to determine whether the specified value is present in a vector. This function can check multiple values at a time to see if any of the values are in the vector.

This function returns a boolean value 'true' if the given value is present in the vector ,otherwise, it returns 'false'.

Syntax

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

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

Parameters

Following is the parameter of this function −

• values − A single or multiple values needs to be checked.

Return value

This function returns 'true', if the provided values present in the vector, or 'false', if any one of the provided value not in vector.

Example 1

If the specified value is present in the current vector, the PHP Ds\Vector::contains() function returns 'true' −

<?php 
   $vector = new \Ds\Vector([1, 2, 3, 4, 5]);
   echo "The vector elements are: \n";
   print_r($vector);
   $value = 1;
   echo "The given value is: ".$value;
   echo "\nIs the value ".$value." is present in a vector? ";
   #using contains() function
   var_dump($vector->contains($value));
?>

Output

After executing the above program, the following output will be displayed −

The vector elements are:
Ds\Vector Object
(
    [0] => 1
    [1] => 2
    [2] => 3
    [3] => 4
    [4] => 5
)
The given value is: 1
Is the value 1 is present in a vector? bool(true)

Example 2

If the specified value is not present in the vector, this function returns 'false'.

Following is another example of the PHP Ds\Vector::contains() function. We use this function to determine whether the specified value "Tutorix" is present in a vector −

<?php 
   $vector = new \Ds\Vector(["tutorials", "point", "India"]);
   echo "The vector elements are: \n";
   print_r($vector);
   $value = "Tutorix";
   echo "The value need to check: ".$value;
   echo "\nIs the value ".$value." is present in a vector? ";
   #using contains() function
   var_dump($vector->contains($value));
?>

Output

The above program produces the following output −

The vector elements are:
Ds\Vector Object
(
    [0] => tutorials
    [1] => point
    [2] => India
)
The value need to check: Tutorix
Is the value Tutorix is present in a vector? bool(false)

Example 3

Checking multiple values at a time.

In the example below, we are using the contains() function to determine whether the values 'a', 'b', 'd', 'e' are present in a vector −

<?php 
   $vector = new \Ds\Vector(['a', 'e', 'i', 'o', 'u']);
   echo "The vector elements are: \n";
   print_r($vector);
   $v1 = 'a';
   $v2 = 'b';
   $v3 = 'd';
   $v4 = 'e';
   echo "The given values: ".$v1.", ".$v2.", ".$v3.", ".$v4;
   echo "\nIs all the values are present in a vector? ";
   #using contains() function
   var_dump($vector->contains($v1, $v2, $v3, $v4));
?>

Output

Once the above program is executed, the following output will be displayed −

The vector elements are:
Ds\Vector Object
(
    [0] => a
    [1] => e
    [2] => i
    [3] => o
    [4] => u
)
The given values: a, b, d, e
Is all the values are present in a vector? bool(false)