PHPUnit\Framework\Constraint\ArrayHasKey Class Reference

Inheritance diagram for PHPUnit\Framework\Constraint\ArrayHasKey:

Collaboration diagram for PHPUnit\Framework\Constraint\ArrayHasKey:

Public Member Functions
	__construct ($key)
	toString ()
Public Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	evaluate ($other, $description='', $returnResult=false)
	count ()

Protected Member Functions
	matches ($other)
	failureDescription ($other)
Protected Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	fail ($other, $description, ComparisonFailure $comparisonFailure=null)
	additionalFailureDescription ($other)

Protected Attributes
	$key
Protected Attributes inherited from PHPUnit\Framework\Constraint\Constraint
	$exporter

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.

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\Constraint\ArrayHasKey::__construct

(

$key

)

Parameters

int | string

$key

Member Function Documentation

failureDescription()

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.

Returns

string

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

matches()

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.

Returns

bool

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

toString()

PHPUnit\Framework\Constraint\ArrayHasKey::toString

(

)

Returns a string representation of the constraint.

Returns

string

Implements PHPUnit\Framework\SelfDescribing.

---

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

• vendor/phpunit/phpunit/src/Framework/Constraint/ArrayHasKey.php