Admin Control Panel v2.0

✎ Editing: DeprecationTriggered.php ← Back

<?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\Event\Test;

use const PHP_EOL;
use function sprintf;
use PHPUnit\Event\Code\Test;
use PHPUnit\Event\Event;
use PHPUnit\Event\Telemetry;

/**
 * @psalm-immutable
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 */
final class DeprecationTriggered implements Event
{
    private readonly Telemetry\Info $telemetryInfo;
    private readonly Test $test;

/**
     * @psalm-var non-empty-string
     */
    private readonly string $message;

/**
     * @psalm-var non-empty-string
     */
    private readonly string $file;

/**
     * @psalm-var positive-int
     */
    private readonly int $line;
    private readonly bool $suppressed;
    private readonly bool $ignoredByBaseline;
    private readonly bool $ignoredByTest;

/**
     * @psalm-param non-empty-string $message
     * @psalm-param non-empty-string $file
     * @psalm-param positive-int $line
     */
    public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest)
    {
        $this->telemetryInfo     = $telemetryInfo;
        $this->test              = $test;
        $this->message           = $message;
        $this->file              = $file;
        $this->line              = $line;
        $this->suppressed        = $suppressed;
        $this->ignoredByBaseline = $ignoredByBaseline;
        $this->ignoredByTest     = $ignoredByTest;
    }

public function telemetryInfo(): Telemetry\Info
    {
        return $this->telemetryInfo;
    }

public function test(): Test
    {
        return $this->test;
    }

/**
     * @psalm-return non-empty-string
     */
    public function message(): string
    {
        return $this->message;
    }

/**
     * @psalm-return non-empty-string
     */
    public function file(): string
    {
        return $this->file;
    }

/**
     * @psalm-return positive-int
     */
    public function line(): int
    {
        return $this->line;
    }

public function wasSuppressed(): bool
    {
        return $this->suppressed;
    }

public function ignoredByBaseline(): bool
    {
        return $this->ignoredByBaseline;
    }

public function ignoredByTest(): bool
    {
        return $this->ignoredByTest;
    }

public function asString(): string
    {
        $message = $this->message;

if (!empty($message)) {
            $message = PHP_EOL . $message;
        }

$status = '';

if ($this->ignoredByTest) {
            $status = 'Test-Ignored ';
        } elseif ($this->ignoredByBaseline) {
            $status = 'Baseline-Ignored ';
        } elseif ($this->suppressed) {
            $status = 'Suppressed ';
        }

return sprintf(
            'Test Triggered %sDeprecation (%s) in %s:%d%s',
            $status,
            $this->test->id(),
            $this->file,
            $this->line,
            $message,
        );
    }
}

Cancel