class JsonMatches

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

Expanded class hierarchy of JsonMatches

1 file declares its use of JsonMatches

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

File

vendor/phpunit/phpunit/src/Framework/Constraint/JsonMatches.php, line 22

Namespace

PHPUnit\Framework\Constraint

View source

final class JsonMatches extends Constraint {
    private readonly string $value;
    public function __construct(string $value) {
        $this->value = $value;
    }
    
    /**
     * Returns a string representation of the object.
     */
    public function toString() : string {
        return sprintf('matches JSON string "%s"', $this->value);
    }
    
    /**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     *
     * This method can be overridden to implement the evaluation algorithm.
     */
    protected function matches(mixed $other) : bool {
        [
            $error,
            $recodedOther,
        ] = Json::canonicalize($other);
        if ($error) {
            return false;
        }
        [
            $error,
            $recodedValue,
        ] = Json::canonicalize($this->value);
        if ($error) {
            return false;
        }
        return $recodedOther == $recodedValue;
    }
    
    /**
     * Throws an exception for the given compared value and test description.
     *
     * @throws ExpectationFailedException
     * @throws InvalidJsonException
     */
    protected function fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null) : never {
        if ($comparisonFailure === null) {
            [
                $error,
                $recodedOther,
            ] = Json::canonicalize($other);
            if ($error) {
                parent::fail($other, $description);
            }
            [
                $error,
                $recodedValue,
            ] = Json::canonicalize($this->value);
            if ($error) {
                parent::fail($other, $description);
            }
            $comparisonFailure = new ComparisonFailure(json_decode($this->value), json_decode($other), Json::prettify($recodedValue), Json::prettify($recodedOther), 'Failed asserting that two json values are equal.');
        }
        parent::fail($other, $description, $comparisonFailure);
    }

}

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::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::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
JsonMatches::$value	private	property
JsonMatches::fail	protected	function	Throws an exception for the given compared value and test description.	Overrides Constraint::fail
JsonMatches::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.	Overrides Constraint::matches
JsonMatches::toString	public	function	Returns a string representation of the object.	Overrides SelfDescribing::toString
JsonMatches::__construct	public	function