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