class ObjectEquals

@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\ObjectEquals extends \PHPUnit\Framework\Constraint\Constraint

Expanded class hierarchy of ObjectEquals

2 files declare their use of ObjectEquals

Assert.php in vendor/phpunit/phpunit/src/Framework/Assert.php
Functions.php in vendor/phpunit/phpunit/src/Framework/Assert/Functions.php

File

vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectEquals.php, line 25

Namespace

PHPUnit\Framework\Constraint

View source

final class ObjectEquals extends Constraint {
    private readonly object $expected;
    private readonly string $method;
    public function __construct(object $object, string $method = 'equals') {
        $this->expected = $object;
        $this->method = $method;
    }
    public function toString() : string {
        return 'two objects are equal';
    }
    
    /**
     * @throws ActualValueIsNotAnObjectException
     * @throws ComparisonMethodDoesNotAcceptParameterTypeException
     * @throws ComparisonMethodDoesNotDeclareBoolReturnTypeException
     * @throws ComparisonMethodDoesNotDeclareExactlyOneParameterException
     * @throws ComparisonMethodDoesNotDeclareParameterTypeException
     * @throws ComparisonMethodDoesNotExistException
     */
    protected function matches(mixed $other) : bool {
        if (!is_object($other)) {
            throw new ActualValueIsNotAnObjectException();
        }
        $object = new ReflectionObject($other);
        if (!$object->hasMethod($this->method)) {
            throw new ComparisonMethodDoesNotExistException($other::class, $this->method);
        }
        $method = $object->getMethod($this->method);
        if (!$method->hasReturnType()) {
            throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException($other::class, $this->method);
        }
        $returnType = $method->getReturnType();
        if (!$returnType instanceof ReflectionNamedType) {
            throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException($other::class, $this->method);
        }
        if ($returnType->allowsNull()) {
            throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException($other::class, $this->method);
        }
        if ($returnType->getName() !== 'bool') {
            throw new ComparisonMethodDoesNotDeclareBoolReturnTypeException($other::class, $this->method);
        }
        if ($method->getNumberOfParameters() !== 1 || $method->getNumberOfRequiredParameters() !== 1) {
            throw new ComparisonMethodDoesNotDeclareExactlyOneParameterException($other::class, $this->method);
        }
        $parameter = $method->getParameters()[0];
        if (!$parameter->hasType()) {
            throw new ComparisonMethodDoesNotDeclareParameterTypeException($other::class, $this->method);
        }
        $type = $parameter->getType();
        if (!$type instanceof ReflectionNamedType) {
            throw new ComparisonMethodDoesNotDeclareParameterTypeException($other::class, $this->method);
        }
        $typeName = $type->getName();
        if ($typeName === 'self') {
            $typeName = $other::class;
        }
        if (!$this->expected instanceof $typeName) {
            throw new ComparisonMethodDoesNotAcceptParameterTypeException($other::class, $this->method, $this->expected::class);
        }
        return $other->{$this->method}($this->expected);
    }
    protected function failureDescription(mixed $other) : string {
        return $this->toString(true);
    }

}

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::evaluate	public	function	Evaluates the constraint for parameter $other.		7
Constraint::exporter	protected	function
Constraint::fail	protected	function	Throws an exception for the given compared value and test description.		1
Constraint::failureDescriptionInContext	protected	function	Returns the description of the failure when this constraint appears in context of an $operator expression.
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
ObjectEquals::$expected	private	property
ObjectEquals::$method	private	property
ObjectEquals::failureDescription	protected	function	Returns the description of the failure.	Overrides Constraint::failureDescription
ObjectEquals::matches	protected	function		Overrides Constraint::matches
ObjectEquals::toString	public	function	Returns a string representation of the object.	Overrides SelfDescribing::toString
ObjectEquals::__construct	public	function