tests/PHPUnit/PHPUnit/Framework/Constraint/TraversableContains.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 Traversable it is applied to contains
  48  * a given value.
  49  *
  50  * @package    PHPUnit
  51  * @subpackage Framework_Constraint
  52  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  53  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  54  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  55  * @version    Release: 3.5.13
  56  * @link       http://www.phpunit.de/
  57  * @since      Class available since Release 3.0.0
  58  */
  59 class PHPUnit_Framework_Constraint_TraversableContains extends PHPUnit_Framework_Constraint
  60 {
  61     /**
  62      * @var mixed
  63      */
  64     protected $value;
  65
  66     /**
  67      * @param mixed $value
  68      */
  69     public function __construct($value)
  70     {
  71         $this->value = $value;
  72     }
  73
  74     /**
  75      * Evaluates the constraint for parameter $other. Returns TRUE if the
  76      * constraint is met, FALSE otherwise.
  77      *
  78      * @param mixed $other Value or object to evaluate.
  79      * @return bool
  80      */
  81     public function evaluate($other)
  82     {
  83         if ($other instanceof SplObjectStorage) {
  84             return $other->contains($this->value);
  85         }
  86
  87         if (is_object($this->value)) {
  88             foreach ($other as $element) {
  89                 if ($element === $this->value) {
  90                     return TRUE;
  91                 }
  92             }
  93         } else {
  94             foreach ($other as $element) {
  95                 if ($element == $this->value) {
  96                     return TRUE;
  97                 }
  98             }
  99         }
 100
 101         return FALSE;
 102     }
 103
 104     /**
 105      * Returns a string representation of the constraint.
 106      *
 107      * @return string
 108      */
 109     public function toString()
 110     {
 111         if (is_string($this->value) && strpos($this->value, "\n") !== FALSE) {
 112             return 'contains "' . $this->value . '"';
 113         } else {
 114             return 'contains ' . PHPUnit_Util_Type::toString($this->value);
 115         }
 116     }
 117
 118     protected function customFailureDescription($other, $description, $not)
 119     {
 120         return sprintf(
 121           'Failed asserting that an %s %s.',
 122
 123            is_array($other) ? 'array' : 'iterator',
 124            $this->toString()
 125         );
 126     }
 127 }