tests/PHPUnit/Framework/Constraint/ArrayHasKey.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Jan Borsodi <jb@ez.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.0.0
  46  */
  47
  48 require_once 'PHPUnit/Framework.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50 require_once 'PHPUnit/Util/Type.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Constraint that asserts that the array it is evaluated for has a given key.
  56  *
  57  * Uses array_key_exists() to check if the key is found in the input array, if not
  58  * found the evaluaton fails.
  59  *
  60  * The array key is passed in the constructor.
  61  *
  62  * @category   Testing
  63  * @package    PHPUnit
  64  * @author     Jan Borsodi <jb@ez.no>
  65  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  66  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  67  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  68  * @version    Release: 3.3.17
  69  * @link       http://www.phpunit.de/
  70  * @since      Class available since Release 3.0.0
  71  */
  72 class PHPUnit_Framework_Constraint_ArrayHasKey extends PHPUnit_Framework_Constraint
  73 {
  74     protected $key;
  75
  76     public function __construct($key)
  77     {
  78         $this->key = $key;
  79     }
  80
  81     /**
  82      * Evaluates the constraint for parameter $other. Returns TRUE if the
  83      * constraint is met, FALSE otherwise.
  84      *
  85      * @param mixed $other Value or object to evaluate.
  86      * @return bool
  87      */
  88     public function evaluate($other)
  89     {
  90         return array_key_exists($this->key, $other);
  91     }
  92
  93     /**
  94      * Returns a string representation of the constraint.
  95      *
  96      * @return string
  97      */
  98     public function toString()
  99     {
 100         return 'has the key ' . PHPUnit_Util_Type::toString($this->key);
 101     }
 102
 103     protected function customFailureDescription($other, $description, $not)
 104     {
 105         return sprintf(
 106           'Failed asserting that an array %s.',
 107
 108            $this->toString()
 109         );
 110     }
 111 }
 112 ?>