Inheritance diagram for PHPUnit\Framework\Constraint\ArraySubset:

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.

@codeCoverageIgnore

Public Member Functions
	__construct (iterable $subset, bool $strict=false)

	evaluate ($other, string $description='', bool $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
	exporter ()

	matches ($other)

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

	additionalFailureDescription ($other)

Constructor & Destructor Documentation

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

PHPUnit\Framework\Constraint\ArraySubset::evaluate	(		$other,
		string	$description = `''`,
		bool	$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.

Exceptions

ExpectationFailedException

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

Exceptions

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

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

Returns a string representation of the constraint.

Exceptions

Implements PHPUnit\Framework\SelfDescribing.

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