tests/PHPUnit/PHPUnit/Framework/Constraint/ArrayHasKey.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit
  38  * @subpackage Framework_Constraint
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 3.0.0
  44  */
  45
  46 /**
  47  * Constraint that asserts that the array it is evaluated for has a given key.
  48  *
  49  * Uses array_key_exists() to check if the key is found in the input array, if
  50  * not found the evaluaton fails.
  51  *
  52  * The array key is passed in the constructor.
  53  *
  54  * @package    PHPUnit
  55  * @subpackage Framework_Constraint
  56  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  57  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  58  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  59  * @version    Release: 3.5.13
  60  * @link       http://www.phpunit.de/
  61  * @since      Class available since Release 3.0.0
  62  */
  63 class PHPUnit_Framework_Constraint_ArrayHasKey extends PHPUnit_Framework_Constraint
  64 {
  65     /**
  66      * @var integer|string
  67      */
  68     protected $key;
  69
  70     /**
  71      * @param integer|string $key
  72      */
  73     public function __construct($key)
  74     {
  75         $this->key = $key;
  76     }
  77
  78     /**
  79      * Evaluates the constraint for parameter $other. Returns TRUE if the
  80      * constraint is met, FALSE otherwise.
  81      *
  82      * @param mixed $other Value or object to evaluate.
  83      * @return bool
  84      */
  85     public function evaluate($other)
  86     {
  87         return array_key_exists($this->key, $other);
  88     }
  89
  90     /**
  91      * Returns a string representation of the constraint.
  92      *
  93      * @return string
  94      */
  95     public function toString()
  96     {
  97         return 'has the key ' . PHPUnit_Util_Type::toString($this->key);
  98     }
  99
 100     /**
 101      * @param mixed   $other
 102      * @param string  $description
 103      * @param boolean $not
 104      */
 105     protected function customFailureDescription($other, $description, $not)
 106     {
 107         return sprintf(
 108           'Failed asserting that an array %s.',
 109
 110            $this->toString()
 111         );
 112     }
 113 }