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