PHPUnit\Framework\Constraint\ArraySubset Class Reference

Inheritance diagram for PHPUnit\Framework\Constraint\ArraySubset:

Collaboration diagram for PHPUnit\Framework\Constraint\ArraySubset:

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

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

Protected Attributes
	$subset
	$strict
Protected Attributes inherited from PHPUnit\Framework\Constraint\Constraint
	$exporter

Detailed Description

Constraint that asserts that the array it is evaluated for has a specified subset.

Uses array_replace_recursive() to check if a key value subset is part of the subject array.

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\Constraint\ArraySubset::__construct	(		$subset,
			$strict = false
	)

Parameters

array | \Traversable	$subset
bool	$strict	Check for object identity

Member Function Documentation

evaluate()

PHPUnit\Framework\Constraint\ArraySubset::evaluate	(		$other,
			$description = '',
			$returnResult = false
	)

Evaluates the constraint for parameter $other

If $returnResult is set to false (the default), an exception is thrown in case of a failure. null is returned otherwise.

If $returnResult is true, the result of the evaluation is returned as a boolean value instead: true in case of success, false in case of a failure.

Parameters

mixed	$other	Value or object to evaluate.
string	$description	Additional information about the test
bool	$returnResult	Whether to return a result or throw an exception

Returns

mixed

Exceptions

ExpectationFailedException

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

failureDescription()

PHPUnit\Framework\Constraint\ArraySubset::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.

toString()

PHPUnit\Framework\Constraint\ArraySubset::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/ArraySubset.php