Inheritance diagram for PHPUnit\Framework\Constraint\IsEqual:

[legend]

Collaboration diagram for PHPUnit\Framework\Constraint\IsEqual:

[legend]

Public Member Functions
	__construct ($value, $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)

	evaluate ($other, $description='', $returnResult=false)

	toString ()

Public Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	count ()

Protected Attributes
	$value

	$delta = 0.0

	$maxDepth = 10

	$canonicalize = false

	$ignoreCase = false

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

Additional Inherited Members
Protected Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	matches ($other)

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

	additionalFailureDescription ($other)

	failureDescription ($other)

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 http://www.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.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

mixed	$value
float	$delta
int	$maxDepth
bool	$canonicalize
bool	$ignoreCase

Exceptions

Member Function Documentation

◆ evaluate()

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