<?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 preg_match;
use function sprintf;
use Exception;
use PHPUnit\Util\Exporter;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ExceptionMessageMatchesRegularExpression extends Constraint
{
private readonly string $regularExpression;
public function __construct(string $regularExpression)
{
$this->regularExpression = $regularExpression;
}
public function toString(): string
{
return 'exception message matches ' . Exporter::export($this->regularExpression);
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*
* @throws \PHPUnit\Framework\Exception
* @throws Exception
*/
protected function matches(mixed $other): bool
{
$match = @preg_match($this->regularExpression, (string) $other);
if ($match === false) {
throw new \PHPUnit\Framework\Exception(
sprintf(
'Invalid expected exception message regular expression given: %s',
$this->regularExpression,
),
);
}
return $match === 1;
}
/**
* Returns the description of the failure.
*
* The beginning of failure messages is "Failed asserting that" in most
* cases. This method should return the second part of that sentence.
*/
protected function failureDescription(mixed $other): string
{
return sprintf(
"exception message '%s' matches '%s'",
$other,
$this->regularExpression,
);
}
}