PHPUnit\Framework\Constraint\IsIdentical Class Reference

Inheritance diagram for PHPUnit\Framework\Constraint\IsIdentical:

Detailed Description

Constraint that asserts that one value is identical to another.

Identical check is performed with PHP's === operator, the operator is explained in detail at {@url https://php.net/manual/en/types.comparisons.php}. Two values are identical if they have the same value and are of the same type.

The expected value is passed in the constructor.

Public Member Functions
	__construct ($value)
	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

__construct()

PHPUnit\Framework\Constraint\IsIdentical::__construct

(

$value

)

Member Function Documentation

evaluate()

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

failureDescription()

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

toString()

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