tests/PHPUnit/PHPUnit/Framework/Constraint/Count.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  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  41  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.6.0
  45  */
  46
  47 /**
  48  *
  49  *
  50  * @package    PHPUnit
  51  * @subpackage Framework_Constraint
  52  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  53  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  54  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  55  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  56  * @version    Release: 3.6.3
  57  * @link       http://www.phpunit.de/
  58  * @since      Class available since Release 3.6.0
  59  */
  60 class PHPUnit_Framework_Constraint_Count extends PHPUnit_Framework_Constraint
  61 {
  62     /**
  63      * @var integer
  64      */
  65     protected $expectedCount = 0;
  66
  67     /**
  68      * @param integer $expected
  69      */
  70     public function __construct($expected)
  71     {
  72         $this->expectedCount = $expected;
  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
  80      * @return boolean
  81      */
  82     protected function matches($other)
  83     {
  84         return $this->expectedCount === $this->getCountOf($other);
  85     }
  86
  87     /**
  88      * @param mixed $other
  89      * @return boolean
  90      */
  91     protected function getCountOf($other)
  92     {
  93         if ($other instanceof Countable || is_array($other)) {
  94             return count($other);
  95         }
  96
  97         else if ($other instanceof Iterator) {
  98             return iterator_count($other);
  99         }
 100     }
 101
 102
 103     /**
 104      * Returns the description of the failure
 105      *
 106      * The beginning of failure messages is "Failed asserting that" in most
 107      * cases. This method should return the second part of that sentence.
 108      *
 109      * @param  mixed $other Evaluated value or object.
 110      * @return string
 111      */
 112     protected function failureDescription($other)
 113     {
 114         return sprintf(
 115           'actual size %d matches expected size %d',
 116
 117           $this->getCountOf($other),
 118           $this->expectedCount
 119         );
 120     }
 121
 122     /**
 123      * @return string
 124      */
 125     public function toString()
 126     {
 127         return 'count matches ';
 128     }
 129 }