class IsEqual

@no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

Hierarchy

class \PHPUnit\Framework\Constraint\Constraint implements \Countable, \PHPUnit\Framework\SelfDescribing
- class \PHPUnit\Framework\Constraint\IsEqual extends \PHPUnit\Framework\Constraint\Constraint

Expanded class hierarchy of IsEqual

3 files declare their use of IsEqual

Assert.php in vendor/phpunit/phpunit/src/Framework/Assert.php
Functions.php in vendor/phpunit/phpunit/src/Framework/Assert/Functions.php
Parameters.php in vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/Parameters.php

File

vendor/phpunit/phpunit/src/Framework/Constraint/Equality/IsEqual.php, line 24

Namespace

PHPUnit\Framework\Constraint

View source

final class IsEqual extends Constraint {
    private readonly mixed $value;
    private readonly float $delta;
    private readonly bool $canonicalize;
    private readonly bool $ignoreCase;
    public function __construct(mixed $value, float $delta = 0.0, bool $canonicalize = false, bool $ignoreCase = false) {
        $this->value = $value;
        $this->delta = $delta;
        $this->canonicalize = $canonicalize;
        $this->ignoreCase = $ignoreCase;
    }
    
    /**
     * 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.
     *
     * @throws ExpectationFailedException
     */
    public function evaluate(mixed $other, string $description = '', bool $returnResult = false) : ?bool {
        // If $this->value and $other are identical, they are also equal.
        // This is the most common path and will allow us to skip
        // initialization of all the comparators.
        if ($this->value === $other) {
            return true;
        }
        $comparatorFactory = ComparatorFactory::getInstance();
        try {
            $comparator = $comparatorFactory->getComparatorFor($this->value, $other);
            $comparator->assertEquals($this->value, $other, $this->delta, $this->canonicalize, $this->ignoreCase);
        } catch (ComparisonFailure $f) {
            if ($returnResult) {
                return false;
            }
            throw new ExpectationFailedException(trim($description . "\n" . $f->getMessage()), $f);
        }
        return true;
    }
    
    /**
     * Returns a string representation of the constraint.
     */
    public function toString(bool $exportObjects = false) : string {
        $delta = '';
        if (is_string($this->value)) {
            if (str_contains($this->value, "\n")) {
                return 'is equal to <text>';
            }
            return sprintf("is equal to '%s'", $this->value);
        }
        if ($this->delta != 0) {
            $delta = sprintf(' with delta <%F>', $this->delta);
        }
        return sprintf('is equal to %s%s', Exporter::export($this->value, $exportObjects), $delta);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Constraint::additionalFailureDescription	protected	function	Return additional failure description where needed.		7
Constraint::count	public	function	Counts the number of constraint elements.		3
Constraint::exporter	protected	function
Constraint::fail	protected	function	Throws an exception for the given compared value and test description.		1
Constraint::failureDescription	protected	function	Returns the description of the failure.		51
Constraint::failureDescriptionInContext	protected	function	Returns the description of the failure when this constraint appears in context of an $operator expression.
Constraint::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.		70
Constraint::reduce	protected	function	Reduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.		2
Constraint::toStringInContext	protected	function	Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
Constraint::valueToTypeStringFragment	protected	function	@psalm-return non-empty-string
IsEqual::$canonicalize	private	property
IsEqual::$delta	private	property
IsEqual::$ignoreCase	private	property
IsEqual::$value	private	property
IsEqual::evaluate	public	function	Evaluates the constraint for parameter $other.	Overrides Constraint::evaluate
IsEqual::toString	public	function	Returns a string representation of the constraint.	Overrides SelfDescribing::toString
IsEqual::__construct	public	function