Constraint that asserts that the Traversable it is applied to contains a given value.
@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_TraversableContains
class PHPUnit_Framework_Constraint_TraversableContains extends PHPUnit_Framework_Constraint {
/**
* @var boolean
*/
protected $checkForObjectIdentity;
/**
* @var mixed
*/
protected $value;
/**
* @param boolean $value
* @param mixed $checkForObjectIdentity
* @throws PHPUnit_Framework_Exception
*/
public function __construct($value, $checkForObjectIdentity = TRUE) {
if (!is_bool($checkForObjectIdentity)) {
throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'boolean');
}
$this->checkForObjectIdentity = $checkForObjectIdentity;
$this->value = $value;
}
/**
* 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 ($other instanceof SplObjectStorage) {
return $other
->contains($this->value);
}
if (is_object($this->value)) {
foreach ($other as $element) {
if ($this->checkForObjectIdentity && $element === $this->value || !$this->checkForObjectIdentity && $element == $this->value) {
return TRUE;
}
}
}
else {
foreach ($other as $element) {
if ($element == $this->value) {
return TRUE;
}
}
}
return FALSE;
}
/**
* Returns a string representation of the constraint.
*
* @return string
*/
public function toString() {
if (is_string($this->value) && strpos($this->value, "\n") !== FALSE) {
return 'contains "' . $this->value . '"';
}
else {
return 'contains ' . PHPUnit_Util_Type::export($this->value);
}
}
/**
* 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 sprintf('an %s %s', is_array($other) ? 'array' : 'iterator', $this
->toString());
}
}