PHPUnit | assertArrayHasKey() function

19 Jul, 2019
The assertArrayHasKey() function is a builtin function in PHPUnit and is used to assert an array having a particular key or not.This assertion will return true in the case if the array has the provided key else return false and in case of true the asserted test case got passed else test case got failed.
Syntax:
assertArrayHasKey(mixed $key, array $array[, string $message = ''])

Parameters: This function accepts three parameters as shown in the above syntax. The parameters are described below:
$key: This parameter represents name of the key to be contained by array..$array: This parameter is an array for whom the key is to be searched.$message: This parameter takes string value. When the testcase got failed this string message got displayed as error message.
$key: This parameter represents name of the key to be contained by array..
$array: This parameter is an array for whom the key is to be searched.
$message: This parameter takes string value. When the testcase got failed this string message got displayed as error message.
Below programs illustrate the assertArrayHasKey() function:
Program 1:
<?phpuse PHPUnit\Framework\TestCase;  class GeeksPhpunitTestCase extends TestCase{    public function testNegativeTestcaseForArrayHasKey()    {        // array to be tested        $array  = array('geek' => 'geeksForgeeks', );        // assert function to test whether 'geek' is a key of array        $this->assertArrayHasKey('geeks', $array, "Array doesn't contains 'geeks' as key");    }}  ?>
Output:
PHPUnit 6.5.5 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 108 ms, Memory: 4.00MB

There was 1 failure:

1) GeeksPhpunitTestCase::testNegativeTestcaseForArrayHasKey
Array doesn't contains 'geeks' as key
Failed asserting that an array has the key 'geeks'.

/home/shivam/Documents/geeks/phpunit/abc.php:9

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.
Program 2:
<?phpuse PHPUnit\Framework\TestCase;  class GeeksPhpunitTestCase extends TestCase{    public function testPositiveTestcaseForArrayHasKey()    {        // array to be tested        $array  = array('geeks' => 'geeksForgeeks', );        // assert function to test whether 'geeks' is a key of array        $this->assertArrayHasKey('geeks', $array, "Array doesn't contains 'geeks' as key");    }}  ?>
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.
PHP-PHPUnit
PHP
PHP
Writing code in comment?
Please use ide.geeksforgeeks.org,
generate link and share the link here.
How to Insert Form Data into Database using PHP ?
How to convert array to string in PHP ?
How to Upload Image into Database and Display it using PHP ?
How to check whether an array is empty using PHP?
PHP | Converting string to Date and DateTime
Comparing two dates in PHP
How to receive JSON POST with PHP ?
Split a comma delimited string into an array in PHP
Download file from URL using PHP
Removing Array Element and Re-Indexing in PHP