class ComparisonFailure in Zircon Profile 8

Thrown when an assertion for string equality failed.

Hierarchy

• class \SebastianBergmann\Comparator\ComparisonFailure extends \SebastianBergmann\Comparator\RuntimeException

4 files declare their use of ComparisonFailure

ClosureComparator.php in vendor/phpspec/prophecy/src/Prophecy/Comparator/ClosureComparator.php

ExactValueToken.php in vendor/phpspec/prophecy/src/Prophecy/Argument/Token/ExactValueToken.php

ObjectProphecy.php in vendor/phpspec/prophecy/src/Prophecy/Prophecy/ObjectProphecy.php

ObjectStateToken.php in vendor/phpspec/prophecy/src/Prophecy/Argument/Token/ObjectStateToken.php

File

vendor/sebastian/comparator/src/ComparisonFailure.php, line 18

Namespace

SebastianBergmann\Comparator

class ComparisonFailure extends \RuntimeException {

  /**
   * 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 bool
   */
  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 bool   $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() {
    if (!$this->actualAsString && !$this->expectedAsString) {
      return '';
    }
    $differ = new Differ("\n--- Expected\n+++ Actual\n");
    return $differ
      ->diff($this->expectedAsString, $this->actualAsString);
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ComparisonFailure::$actual	protected	property	Actually retrieved value which does not match $expected.
ComparisonFailure::$actualAsString	protected	property	The string representation of the actual value
ComparisonFailure::$expected	protected	property	Expected value of the retrieval which does not match $actual.
ComparisonFailure::$expectedAsString	protected	property	The string representation of the expected value
ComparisonFailure::$identical	protected	property
ComparisonFailure::$message	protected	property	Optional message which is placed in front of the first line returned by toString().
ComparisonFailure::getActual	public	function
ComparisonFailure::getActualAsString	public	function
ComparisonFailure::getDiff	public	function
ComparisonFailure::getExpected	public	function
ComparisonFailure::getExpectedAsString	public	function
ComparisonFailure::toString	public	function
ComparisonFailure::__construct	public	function	Initialises with the expected value and the actual value.