ComparisonFailure.php

<?php

/**
 * PHPUnit
 *
 * Copyright (c) 2001-2013, Sebastian Bergmann <sebastian@phpunit.de>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Sebastian Bergmann nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    PHPUnit
 * @subpackage Framework
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @author     Bernhard Schussek <bschussek@2bepublished.at>
 * @copyright  2001-2013 Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://www.phpunit.de/
 * @since      File available since Release 2.0.0
 */

/**
 * Thrown when an assertion for string equality failed.
 *
 * @package    PHPUnit
 * @subpackage Framework
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @author     Bernhard Schussek <bschussek@2bepublished.at>
 * @copyright  2001-2013 Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://www.phpunit.de/
 * @since      Class available since Release 2.0.0
 */
class PHPUnit_Framework_ComparisonFailure extends PHPUnit_Framework_AssertionFailedError {

  /**
   * Expected value of the retrieval which does not match $actual.
   * @var mixed
   */
  protected $expected;

  /**
   * Actually retrieved value which does not match $expected.
   * @var mixed
   */
  protected $actual;

  /**
   * The string representation of the expected value
   * @var string
   */
  protected $expectedAsString;

  /**
   * The string representation of the actual value
   * @var string
   */
  protected $actualAsString;

  /**
   * @var boolean
   */
  protected $identical;

  /**
   * Optional message which is placed in front of the first line
   * returned by toString().
   * @var string
   */
  protected $message;

  /**
   * Initialises with the expected value and the actual value.
   *
   * @param mixed $expected Expected value retrieved.
   * @param mixed $actual Actual value retrieved.
   * @param string $expectedAsString
   * @param string $actualAsString
   * @param boolean $identical
   * @param string $message A string which is prefixed on all returned lines
   *                        in the difference output.
   */
  public function __construct($expected, $actual, $expectedAsString, $actualAsString, $identical = FALSE, $message = '') {
    $this->expected = $expected;
    $this->actual = $actual;
    $this->expectedAsString = $expectedAsString;
    $this->actualAsString = $actualAsString;
    $this->message = $message;
  }

  /**
   * @return mixed
   */
  public function getActual() {
    return $this->actual;
  }

  /**
   * @return mixed
   */
  public function getExpected() {
    return $this->expected;
  }

  /**
   * @return string
   */
  public function getActualAsString() {
    return $this->actualAsString;
  }

  /**
   * @return string
   */
  public function getExpectedAsString() {
    return $this->expectedAsString;
  }

  /**
   * @return string
   */
  public function getDiff() {
    return $this->actualAsString || $this->expectedAsString ? PHPUnit_Util_Diff::diff($this->expectedAsString, $this->actualAsString) : '';
  }

  /**
   * @return string
   */
  public function toString() {
    return $this->message . $this
      ->getDiff();
  }

}