Thursday, September 4, 2025
HomeLanguagesPHPUnit | assertContains() function

PHPUnit | assertContains() function

The assertContains() function is a builtin function in PHPUnit and is used to assert an array having a value. This assertion will return true in the case if the array contains the provided value else return false and in case of true the asserted test case got passed else test case got failed.

Syntax:

assertContains(mixed $value, array $array, string $message = ''])

Parameters: This function accepts three parameters as shown in the above syntax. The parameters are described below:

  1. $value: This parameter represents the value to be contained in array.
  2. $array: This parameter is a array for which the assert function will check whether it contains value or not.
  3. $message: This parameter takes string value. When the testcase got failed this string message got displayed as error message.

Below programs illustrate the assertContains() function:

Program 1:




<?php
use PHPUnit\Framework\TestCase;
  
class GeeksPhpunitTestCase extends TestCase
{
    public function testNegativeTestcaseForAssertContains()
    {
        $testArray = array("a"=>"value b", "b" =>"value b");
        $value = "value ba"; 
        // assert function to test whether 'value' is a value of array
        $this->assertContains($value, $testArray, "testArray doesn't contains value as value") ;
    }
}
  
?>


Output:


Program 2:




<?php
use PHPUnit\Framework\TestCase;
  
class GeeksPhpunitTestCase extends TestCase
{
    public function testPositiveTestcaseForAssertContains()
    {
        $testArray = array("a"=>"value ba", "b" =>"value b");
        $value = "value ba"; 
        // assert function to test whether 'value' is a value of array
        $this->assertContains($value, $testArray, "testArray doesn't contains value as value") ;
    }
}
  
?>

Output:

PHPUnit 6.5.5 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 21 ms, Memory: 4.00MB

OK (1 test, 1 assertion)

Note : To run testcases with phpunit follow steps from here.

Dominic
Dominichttp://wardslaus.com
infosec,malicious & dos attacks generator, boot rom exploit philanthropist , wild hacker , game developer,
RELATED ARTICLES

Most Popular

Dominic
32261 POSTS0 COMMENTS
Milvus
81 POSTS0 COMMENTS
Nango Kala
6626 POSTS0 COMMENTS
Nicole Veronica
11795 POSTS0 COMMENTS
Nokonwaba Nkukhwana
11855 POSTS0 COMMENTS
Shaida Kate Naidoo
6747 POSTS0 COMMENTS
Ted Musemwa
7023 POSTS0 COMMENTS
Thapelo Manthata
6695 POSTS0 COMMENTS
Umr Jansen
6714 POSTS0 COMMENTS