tests/PHPUnit/PHPUnit/Framework/ComparatorFactory.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
  39  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  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.6.0
  44  */
  45
  46 /**
  47  * Factory for comparators which compare values for equality.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework
  51  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.6.3
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.6.0
  57  */
  58 class PHPUnit_Framework_ComparatorFactory
  59 {
  60     /**
  61      * @var array
  62      */
  63     protected $comparators = array();
  64
  65     /**
  66      * @var PHPUnit_Framework_ComparatorFactory
  67      */
  68     private static $defaultInstance = NULL;
  69
  70     /**
  71      * Constructs a new factory.
  72      */
  73     public function __construct()
  74     {
  75         $this->register(new PHPUnit_Framework_Comparator_Type);
  76         $this->register(new PHPUnit_Framework_Comparator_Scalar);
  77         $this->register(new PHPUnit_Framework_Comparator_Numeric);
  78         $this->register(new PHPUnit_Framework_Comparator_Double);
  79         $this->register(new PHPUnit_Framework_Comparator_Array);
  80         $this->register(new PHPUnit_Framework_Comparator_Resource);
  81         $this->register(new PHPUnit_Framework_Comparator_Object);
  82         $this->register(new PHPUnit_Framework_Comparator_Exception);
  83         $this->register(new PHPUnit_Framework_Comparator_SplObjectStorage);
  84         $this->register(new PHPUnit_Framework_Comparator_DOMDocument);
  85         $this->register(new PHPUnit_Framework_Comparator_MockObject);
  86     }
  87
  88     /**
  89      * Returns the default instance.
  90      *
  91      * @return PHPUnit_Framework_ComparatorFactory
  92      */
  93     public static function getDefaultInstance()
  94     {
  95         if (self::$defaultInstance === NULL) {
  96             self::$defaultInstance = new PHPUnit_Framework_ComparatorFactory;
  97         }
  98
  99         return self::$defaultInstance;
 100     }
 101
 102     /**
 103      * Returns the correct comparator for comparing two values.
 104      *
 105      * @param  mixed $expected The first value to compare
 106      * @param  mixed $actual The second value to compare
 107      * @return PHPUnit_Framework_Comparator
 108      */
 109     public function getComparatorFor($expected, $actual)
 110     {
 111         foreach ($this->comparators as $comparator) {
 112             if ($comparator->accepts($expected, $actual)) {
 113                 return $comparator;
 114             }
 115         }
 116
 117         throw new InvalidArgumentException(
 118           sprintf(
 119             'No comparator is registered for comparing the types "%s" and "%s"',
 120             gettype($expected), gettype($actual)
 121           )
 122         );
 123     }
 124
 125     /**
 126      * Registers a new comparator.
 127      *
 128      * This comparator will be returned by getInstance() if its accept() method
 129      * returns TRUE for the compared values. It has higher priority than the
 130      * existing comparators, meaning that its accept() method will be tested
 131      * before those of the other comparators.
 132      *
 133      * @param  PHPUnit_Framework_Comparator $comparator The registered comparator
 134      */
 135     public function register(PHPUnit_Framework_Comparator $comparator)
 136     {
 137         array_unshift($this->comparators, $comparator);
 138         $comparator->setFactory($this);
 139     }
 140
 141     /**
 142      * Unregisters a comparator.
 143      *
 144      * This comparator will no longer be returned by getInstance().
 145      *
 146      * @param  PHPUnit_Framework_Comparator $comparator The unregistered comparator
 147      */
 148     public function unregister(PHPUnit_Framework_Comparator $comparator)
 149     {
 150         foreach ($this->comparators as $key => $_comparator) {
 151             if ($comparator === $_comparator) {
 152                 unset($this->comparators[$key]);
 153             }
 154         }
 155     }
 156 }