annotate vendor/sebastian/comparator/src/DOMNodeComparator.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /*
Chris@14 3 * This file is part of sebastian/comparator.
Chris@0 4 *
Chris@0 5 * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0 6 *
Chris@0 7 * For the full copyright and license information, please view the LICENSE
Chris@0 8 * file that was distributed with this source code.
Chris@0 9 */
Chris@0 10
Chris@0 11 namespace SebastianBergmann\Comparator;
Chris@0 12
Chris@0 13 use DOMDocument;
Chris@0 14 use DOMNode;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * Compares DOMNode instances for equality.
Chris@0 18 */
Chris@0 19 class DOMNodeComparator extends ObjectComparator
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * Returns whether the comparator can compare two values.
Chris@0 23 *
Chris@14 24 * @param mixed $expected The first value to compare
Chris@14 25 * @param mixed $actual The second value to compare
Chris@14 26 *
Chris@0 27 * @return bool
Chris@0 28 */
Chris@0 29 public function accepts($expected, $actual)
Chris@0 30 {
Chris@0 31 return $expected instanceof DOMNode && $actual instanceof DOMNode;
Chris@0 32 }
Chris@0 33
Chris@0 34 /**
Chris@0 35 * Asserts that two values are equal.
Chris@0 36 *
Chris@0 37 * @param mixed $expected First value to compare
Chris@0 38 * @param mixed $actual Second value to compare
Chris@0 39 * @param float $delta Allowed numerical distance between two values to consider them equal
Chris@0 40 * @param bool $canonicalize Arrays are sorted before comparison when set to true
Chris@0 41 * @param bool $ignoreCase Case is ignored when set to true
Chris@0 42 * @param array $processed List of already processed elements (used to prevent infinite recursion)
Chris@0 43 *
Chris@0 44 * @throws ComparisonFailure
Chris@0 45 */
Chris@14 46 public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false, array &$processed = [])
Chris@0 47 {
Chris@0 48 $expectedAsString = $this->nodeToText($expected, true, $ignoreCase);
Chris@0 49 $actualAsString = $this->nodeToText($actual, true, $ignoreCase);
Chris@0 50
Chris@0 51 if ($expectedAsString !== $actualAsString) {
Chris@14 52 $type = $expected instanceof DOMDocument ? 'documents' : 'nodes';
Chris@0 53
Chris@0 54 throw new ComparisonFailure(
Chris@0 55 $expected,
Chris@0 56 $actual,
Chris@0 57 $expectedAsString,
Chris@0 58 $actualAsString,
Chris@0 59 false,
Chris@14 60 \sprintf("Failed asserting that two DOM %s are equal.\n", $type)
Chris@0 61 );
Chris@0 62 }
Chris@0 63 }
Chris@0 64
Chris@0 65 /**
Chris@0 66 * Returns the normalized, whitespace-cleaned, and indented textual
Chris@0 67 * representation of a DOMNode.
Chris@0 68 */
Chris@14 69 private function nodeToText(DOMNode $node, bool $canonicalize, bool $ignoreCase): string
Chris@0 70 {
Chris@0 71 if ($canonicalize) {
Chris@0 72 $document = new DOMDocument;
Chris@14 73 @$document->loadXML($node->C14N());
Chris@0 74
Chris@0 75 $node = $document;
Chris@0 76 }
Chris@0 77
Chris@14 78 $document = $node instanceof DOMDocument ? $node : $node->ownerDocument;
Chris@0 79
Chris@0 80 $document->formatOutput = true;
Chris@0 81 $document->normalizeDocument();
Chris@0 82
Chris@14 83 $text = $node instanceof DOMDocument ? $node->saveXML() : $document->saveXML($node);
Chris@0 84
Chris@14 85 return $ignoreCase ? $text : \strtolower($text);
Chris@0 86 }
Chris@0 87 }