tests/PHPUnit/PHPUnit/Framework/Comparator.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  * Abstract base class 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 abstract class PHPUnit_Framework_Comparator
  59 {
  60     /**
  61      * @var PHPUnit_Framework_ComparatorFactory
  62      */
  63     protected $factory;
  64
  65     /**
  66      * @param PHPUnit_Framework_ComparatorFactory $factory
  67      */
  68     public function setFactory(PHPUnit_Framework_ComparatorFactory $factory)
  69     {
  70         $this->factory = $factory;
  71     }
  72
  73     /**
  74      * Returns whether the comparator can compare two values.
  75      *
  76      * @param  mixed $expected The first value to compare
  77      * @param  mixed $actual The second value to compare
  78      * @return boolean
  79      */
  80     abstract public function accepts($expected, $actual);
  81
  82     /**
  83      * Asserts that two values are equal.
  84      *
  85      * @param  mixed $expected The first value to compare
  86      * @param  mixed $actual The second value to compare
  87      * @param  float $delta The allowed numerical distance between two values to
  88      *                      consider them equal
  89      * @param  bool  $canonicalize If set to TRUE, arrays are sorted before
  90      *                             comparison
  91      * @param  bool  $ignoreCase If set to TRUE, upper- and lowercasing is
  92      *                           ignored when comparing string values
  93      * @throws PHPUnit_Framework_ComparisonFailure Thrown when the comparison
  94      *                           fails. Contains information about the
  95      *                           specific errors that lead to the failure.
  96      */
  97     abstract public function assertEquals($expected, $actual, $delta = 0, $canonicalize = FALSE, $ignoreCase = FALSE);
  98 }