Inheritance diagram for PHPUnit\Framework\Constraint\ArrayHasKey:

Detailed Description

Constraint that asserts that the array it is evaluated for has a given key.

Uses array_key_exists() to check if the key is found in the input array, if not found the evaluation fails.

The array key is passed in the constructor.

Public Member Functions
	__construct ($key)

	toString ()

Public Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	evaluate ($other, string $description='', bool $returnResult=false)

	count ()

Protected Member Functions
	matches ($other)

	failureDescription ($other)

Protected Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	exporter ()

	fail ($other, $description, ComparisonFailure $comparisonFailure=null)

	additionalFailureDescription ($other)

Constructor & Destructor Documentation

PHPUnit\Framework\Constraint\ArrayHasKey::__construct ( $key )

Parameters

int | string $key

PHPUnit\Framework\Constraint\ArrayHasKey::failureDescription ( $other )

protected

Returns the description of the failure

The beginning of failure messages is "Failed asserting that" in most cases. This method should return the second part of that sentence.

Parameters

mixed $other evaluated value or object

Exceptions

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

PHPUnit\Framework\Constraint\ArrayHasKey::matches ( $other )

protected

Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.

Parameters

mixed $other value or object to evaluate

PHPUnit\Framework\Constraint\ArrayHasKey::toString ( )

Returns a string representation of the constraint.

Exceptions

Implements PHPUnit\Framework\SelfDescribing.

The documentation for this class was generated from the following file: