class ArrayHasKey

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

Expanded class hierarchy of ArrayHasKey

2 files declare their use of ArrayHasKey

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/Traversable/ArrayHasKey.php, line 20

Namespace

PHPUnit\Framework\Constraint

View source

final class ArrayHasKey extends Constraint {
    private readonly int|string $key;
    public function __construct(int|string $key) {
        $this->key = $key;
    }
    
    /**
     * Returns a string representation of the constraint.
     */
    public function toString() : string {
        return 'has the key ' . Exporter::export($this->key);
    }
    
    /**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     */
    protected function matches(mixed $other) : bool {
        if (is_array($other)) {
            return array_key_exists($this->key, $other);
        }
        if ($other instanceof ArrayAccess) {
            return $other->offsetExists($this->key);
        }
        return false;
    }
    
    /**
     * 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.
     */
    protected function failureDescription(mixed $other) : string {
        return 'an array ' . $this->toString(true);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
ArrayHasKey::$key	private	property
ArrayHasKey::failureDescription	protected	function	Returns the description of the failure.	Overrides Constraint::failureDescription
ArrayHasKey::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.	Overrides Constraint::matches
ArrayHasKey::toString	public	function	Returns a string representation of the constraint.	Overrides SelfDescribing::toString
ArrayHasKey::__construct	public	function
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