class DOMNodeComparator in Zircon Profile 8

Compares DOMNode instances for equality.

Hierarchy

• class \SebastianBergmann\Comparator\Comparator
  • class \SebastianBergmann\Comparator\ArrayComparator
    • class \SebastianBergmann\Comparator\ObjectComparator
      • class \SebastianBergmann\Comparator\DOMNodeComparator

File

vendor/sebastian/comparator/src/DOMNodeComparator.php, line 19

Namespace

SebastianBergmann\Comparator

class DOMNodeComparator extends ObjectComparator {

  /**
   * Returns whether the comparator can compare two values.
   *
   * @param  mixed $expected The first value to compare
   * @param  mixed $actual   The second value to compare
   * @return bool
   */
  public function accepts($expected, $actual) {
    return $expected instanceof DOMNode && $actual instanceof DOMNode;
  }

  /**
   * Asserts that two values are equal.
   *
   * @param  mixed             $expected     The first value to compare
   * @param  mixed             $actual       The second value to compare
   * @param  float             $delta        The allowed numerical distance between two values to
   *                                         consider them equal
   * @param  bool              $canonicalize If set to TRUE, arrays are sorted before
   *                                         comparison
   * @param  bool              $ignoreCase   If set to TRUE, upper- and lowercasing is
   *                                         ignored when comparing string values
   * @throws ComparisonFailure Thrown when the comparison
   *                                        fails. Contains information about the
   *                                        specific errors that lead to the failure.
   */
  public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false) {
    $expectedAsString = $this
      ->nodeToText($expected, true, $ignoreCase);
    $actualAsString = $this
      ->nodeToText($actual, true, $ignoreCase);
    if ($expectedAsString !== $actualAsString) {
      if ($expected instanceof DOMDocument) {
        $type = 'documents';
      }
      else {
        $type = 'nodes';
      }
      throw new ComparisonFailure($expected, $actual, $expectedAsString, $actualAsString, false, sprintf("Failed asserting that two DOM %s are equal.\n", $type));
    }
  }

  /**
   * Returns the normalized, whitespace-cleaned, and indented textual
   * representation of a DOMNode.
   *
   * @param  DOMNode $node
   * @param  bool    $canonicalize
   * @param  bool    $ignoreCase
   * @return string
   */
  private function nodeToText(DOMNode $node, $canonicalize, $ignoreCase) {
    if ($canonicalize) {
      $document = new DOMDocument();
      $document
        ->loadXML($node
        ->C14N());
      $node = $document;
    }
    if ($node instanceof DOMDocument) {
      $document = $node;
    }
    else {
      $document = $node->ownerDocument;
    }
    $document->formatOutput = true;
    $document
      ->normalizeDocument();
    if ($node instanceof DOMDocument) {
      $text = $node
        ->saveXML();
    }
    else {
      $text = $document
        ->saveXML($node);
    }
    if ($ignoreCase) {
      $text = strtolower($text);
    }
    return $text;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayComparator::indent	protected	function
Comparator::$exporter	protected	property
Comparator::$factory	protected	property
Comparator::setFactory	public	function
Comparator::__construct	public	function
DOMNodeComparator::accepts	public	function	Returns whether the comparator can compare two values. Overrides ObjectComparator::accepts
DOMNodeComparator::assertEquals	public	function	Asserts that two values are equal. Overrides ObjectComparator::assertEquals
DOMNodeComparator::nodeToText	private	function	Returns the normalized, whitespace-cleaned, and indented textual representation of a DOMNode.
ObjectComparator::toArray	protected	function	Converts an object to an array containing all of its private, protected and public properties.	2