PHPUnit\Framework\Constraint\IsEqual Class Reference

Inheritance diagram for PHPUnit\Framework\Constraint\IsEqual:

Detailed Description

Constraint that checks if one value is equal to another.

Equality is checked with PHP's == operator, the operator is explained in detail at {@url https://php.net/manual/en/types.comparisons.php}. Two values are equal if they have the same value disregarding type.

The expected value is passed in the constructor.

Public Member Functions
	__construct ($value, float $delta=0.0, int $maxDepth=10, bool $canonicalize=false, bool $ignoreCase=false)
	evaluate ($other, string $description='', bool $returnResult=false)
	toString ()
Public Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	count ()

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

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\Constraint\IsEqual::__construct	(		$value,
		float	$delta = 0.0,
		int	$maxDepth = 10,
		bool	$canonicalize = false,
		bool	$ignoreCase = false
	)

Member Function Documentation

evaluate()

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

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

toString()

PHPUnit\Framework\Constraint\IsEqual::toString

(

)

Returns a string representation of the constraint.

Exceptions

Implements PHPUnit\Framework\SelfDescribing.

---

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

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