Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ArrayComparator.php

class ArrayComparator

Arrays are equal if they contain the same key-value pairs. The order of the keys does not matter. The types of key-value pairs do not matter.

Hierarchy

  • class \SebastianBergmann\Comparator\Comparator
    • class \SebastianBergmann\Comparator\ArrayComparator extends \SebastianBergmann\Comparator\Comparator

Expanded class hierarchy of ArrayComparator

File

vendor/sebastian/comparator/src/ArrayComparator.php, line 26

Namespace

SebastianBergmann\Comparator
View source
class ArrayComparator extends Comparator {
    public function accepts(mixed $expected, mixed $actual) : bool {
        return is_array($expected) && is_array($actual);
    }
    
    /**
     * @throws ComparisonFailure
     */
    public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, bool $canonicalize = false, bool $ignoreCase = false, array &$processed = []) : void {
        assert(is_array($expected));
        assert(is_array($actual));
        if ($canonicalize) {
            sort($expected);
            sort($actual);
        }
        $remaining = $actual;
        $actualAsString = "Array (\n";
        $expectedAsString = "Array (\n";
        $equal = true;
        $exporter = new Exporter();
        foreach ($expected as $key => $value) {
            unset($remaining[$key]);
            if (!array_key_exists($key, $actual)) {
                $expectedAsString .= sprintf("    %s => %s\n", $exporter->export($key), $exporter->shortenedExport($value));
                $equal = false;
                continue;
            }
            try {
                $comparator = $this->factory()
                    ->getComparatorFor($value, $actual[$key]);
                $comparator->assertEquals($value, $actual[$key], $delta, $canonicalize, $ignoreCase, $processed);
                $expectedAsString .= sprintf("    %s => %s\n", $exporter->export($key), $exporter->shortenedExport($value));
                $actualAsString .= sprintf("    %s => %s\n", $exporter->export($key), $exporter->shortenedExport($actual[$key]));
            } catch (ComparisonFailure $e) {
                $expectedAsString .= sprintf("    %s => %s\n", $exporter->export($key), $e->getExpectedAsString() ? $this->indent($e->getExpectedAsString()) : $exporter->shortenedExport($e->getExpected()));
                $actualAsString .= sprintf("    %s => %s\n", $exporter->export($key), $e->getActualAsString() ? $this->indent($e->getActualAsString()) : $exporter->shortenedExport($e->getActual()));
                $equal = false;
            }
        }
        foreach ($remaining as $key => $value) {
            $actualAsString .= sprintf("    %s => %s\n", $exporter->export($key), $exporter->shortenedExport($value));
            $equal = false;
        }
        $expectedAsString .= ')';
        $actualAsString .= ')';
        if (!$equal) {
            throw new ComparisonFailure($expected, $actual, $expectedAsString, $actualAsString, 'Failed asserting that two arrays are equal.');
        }
    }
    private function indent(string $lines) : string {
        return trim(str_replace("\n", "\n    ", $lines));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ArrayComparator::accepts public function Overrides Comparator::accepts 1
ArrayComparator::assertEquals public function Overrides Comparator::assertEquals 1
ArrayComparator::indent private function
Comparator::$factory private property
Comparator::factory protected function
Comparator::setFactory public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal