class PHPUnit_Framework_Constraint_ArrayHasKey in Zircon Profile 8

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 evaluation fails.

The array key is passed in the constructor.

@since Class available since Release 3.0.0

Hierarchy

• class \PHPUnit_Framework_Constraint implements \Countable, PHPUnit_Framework_SelfDescribing
  • class \PHPUnit_Framework_Constraint_ArrayHasKey

File

vendor/phpunit/phpunit/src/Framework/Constraint/ArrayHasKey.php, line 21

class PHPUnit_Framework_Constraint_ArrayHasKey extends PHPUnit_Framework_Constraint {

  /**
   * @var int|string
   */
  protected $key;

  /**
   * @param int|string $key
   */
  public function __construct($key) {
    parent::__construct();
    $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) {
    if (is_array($other)) {
      return array_key_exists($this->key, $other);
    }
    if ($other instanceof ArrayAccess) {
      return $other
        ->offsetExists($this->key);
    }
    return false;
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'has the key ' . $this->exporter
      ->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();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPUnit_Framework_Constraint::$exporter	protected	property
PHPUnit_Framework_Constraint::additionalFailureDescription	protected	function	Return additional failure description where needed	1
PHPUnit_Framework_Constraint::count	public	function	Counts the number of constraint elements.	6
PHPUnit_Framework_Constraint::evaluate	public	function	Evaluates the constraint for parameter $other	9
PHPUnit_Framework_Constraint::fail	protected	function	Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint_ArrayHasKey::$key	protected	property
PHPUnit_Framework_Constraint_ArrayHasKey::failureDescription	protected	function	Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_ArrayHasKey::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise. Overrides PHPUnit_Framework_Constraint::matches
PHPUnit_Framework_Constraint_ArrayHasKey::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_ArrayHasKey::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct