Constraint that asserts that the array it is evaluated for has a given key.
Uses array_key_exists() to check if the key is found in the input array, if not found the evaluaton fails.
The array key is passed in the constructor.
@package PHPUnit @subpackage Framework_Constraint @author Sebastian Bergmann <sebastian@phpunit.de> @author Bernhard Schussek <bschussek@2bepublished.at> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 3.0.0
Expanded class hierarchy of PHPUnit_Framework_Constraint_ArrayHasKey
class PHPUnit_Framework_Constraint_ArrayHasKey extends PHPUnit_Framework_Constraint {
/**
* @var integer|string
*/
protected $key;
/**
* @param integer|string $key
*/
public function __construct($key) {
$this->key = $key;
}
/**
* Evaluates the constraint for parameter $other. Returns TRUE if the
* constraint is met, FALSE otherwise.
*
* @param mixed $other Value or object to evaluate.
* @return bool
*/
protected function matches($other) {
return array_key_exists($this->key, $other);
}
/**
* Returns a string representation of the constraint.
*
* @return string
*/
public function toString() {
return 'has the key ' . PHPUnit_Util_Type::export($this->key);
}
/**
* 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.
* @return string
*/
protected function failureDescription($other) {
return 'an array ' . $this
->toString();
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PHPUnit_Framework_Constraint:: |
protected | function | Return additional failure description where needed | 1 |
PHPUnit_Framework_Constraint:: |
public | function | Counts the number of constraint elements. | 6 |
PHPUnit_Framework_Constraint:: |
public | function | Evaluates the constraint for parameter $other | 9 |
PHPUnit_Framework_Constraint:: |
protected | function | Throws an exception for the given compared value and test description | |
PHPUnit_Framework_Constraint_ArrayHasKey:: |
protected | property | ||
PHPUnit_Framework_Constraint_ArrayHasKey:: |
protected | function |
Returns the description of the failure Overrides PHPUnit_Framework_Constraint:: |
|
PHPUnit_Framework_Constraint_ArrayHasKey:: |
protected | function |
Evaluates the constraint for parameter $other. Returns TRUE if the
constraint is met, FALSE otherwise. Overrides PHPUnit_Framework_Constraint:: |
|
PHPUnit_Framework_Constraint_ArrayHasKey:: |
public | function |
Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing:: |
|
PHPUnit_Framework_Constraint_ArrayHasKey:: |
public | function |