You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
78 lines
1.9 KiB
78 lines
1.9 KiB
<?php declare(strict_types=1);
|
|
/*
|
|
* This file is part of PHPUnit.
|
|
*
|
|
* (c) Sebastian Bergmann <sebastian@phpunit.de>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
namespace PHPUnit\Framework\Constraint;
|
|
|
|
use function array_key_exists;
|
|
use function is_array;
|
|
use ArrayAccess;
|
|
|
|
/**
|
|
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
|
|
*/
|
|
final class ArrayHasKey extends Constraint
|
|
{
|
|
/**
|
|
* @var int|string
|
|
*/
|
|
private $key;
|
|
|
|
/**
|
|
* @param int|string $key
|
|
*/
|
|
public function __construct($key)
|
|
{
|
|
$this->key = $key;
|
|
}
|
|
|
|
/**
|
|
* Returns a string representation of the constraint.
|
|
*
|
|
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
|
|
*/
|
|
public function toString(): string
|
|
{
|
|
return 'has the key ' . $this->exporter()->export($this->key);
|
|
}
|
|
|
|
/**
|
|
* Evaluates the constraint for parameter $other. Returns true if the
|
|
* constraint is met, false otherwise.
|
|
*
|
|
* @param mixed $other value or object to evaluate
|
|
*/
|
|
protected function matches($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.
|
|
*
|
|
* @param mixed $other evaluated value or object
|
|
*
|
|
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
|
|
*/
|
|
protected function failureDescription($other): string
|
|
{
|
|
return 'an array ' . $this->toString();
|
|
}
|
|
}
|