StringEqualsStringIgnoringLineEndings.php

<?php

declare (strict_types=1);

/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\Framework\Constraint;

use function sprintf;
use function strtr;

/**
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 */
final class StringEqualsStringIgnoringLineEndings extends Constraint {
    private readonly string $string;
    public function __construct(string $string) {
        $this->string = $this->normalizeLineEndings($string);
    }
    
    /**
     * Returns a string representation of the constraint.
     */
    public function toString() : string {
        return sprintf('is equal to "%s" ignoring line endings', $this->string);
    }
    
    /**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     */
    protected function matches(mixed $other) : bool {
        return $this->string === $this->normalizeLineEndings((string) $other);
    }
    private function normalizeLineEndings(string $string) : string {
        return strtr($string, [
            "\r\n" => "\n",
            "\r" => "\n",
        ]);
    }

}