class Issue

Same name in this branch
  1. 11.1.x vendor/phpunit/phpunit/src/Runner/Baseline/Issue.php \PHPUnit\Runner\Baseline\Issue

@no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

@internal This class is not covered by the backward compatibility promise for PHPUnit

Hierarchy

  • class \PHPUnit\TestRunner\TestResult\Issues\Issue

Expanded class hierarchy of Issue

3 files declare their use of Issue
Collector.php in vendor/phpunit/phpunit/src/Runner/TestResult/Collector.php
ResultPrinter.php in vendor/phpunit/phpunit/src/TextUI/Output/Default/ResultPrinter.php
TestResult.php in vendor/phpunit/phpunit/src/Runner/TestResult/TestResult.php
3 string references to 'Issue'
Gitlab::generateFileReport in vendor/micheh/phpcs-gitlab/src/Report/Gitlab.php
@psalm-suppress ImplementedParamTypeMismatch PHP_CodeSniffer has a wrong docblock
Reader::read in vendor/phpunit/phpunit/src/Runner/Baseline/Reader.php
@psalm-param non-empty-string $baselineFile
Writer::write in vendor/phpunit/phpunit/src/Runner/Baseline/Writer.php
@psalm-param non-empty-string $baselineFile

File

vendor/phpunit/phpunit/src/Runner/TestResult/Issue.php, line 19

Namespace

PHPUnit\TestRunner\TestResult\Issues
View source 
final class Issue {
    
    /**
     * @psalm-var non-empty-string
     */
    private readonly string $file;
    
    /**
     * @psalm-var positive-int
     */
    private readonly int $line;
    
    /**
     * @psalm-var non-empty-string
     */
    private readonly string $description;
    
    /**
     * @psalm-var non-empty-array<non-empty-string, array{test: Test, count: int}>
     */
    private array $triggeringTests;
    
    /**
     * @psalm-param non-empty-string $file
     * @psalm-param positive-int $line
     * @psalm-param non-empty-string $description
     */
    public static function from(string $file, int $line, string $description, Test $triggeringTest) : self {
        return new self($file, $line, $description, $triggeringTest);
    }
    
    /**
     * @psalm-param non-empty-string $file
     * @psalm-param positive-int $line
     * @psalm-param non-empty-string $description
     */
    private function __construct(string $file, int $line, string $description, Test $triggeringTest) {
        $this->file = $file;
        $this->line = $line;
        $this->description = $description;
        $this->triggeringTests = [
            $triggeringTest->id() => [
                'test' => $triggeringTest,
                'count' => 1,
            ],
        ];
    }
    public function triggeredBy(Test $test) : void {
        if (isset($this->triggeringTests[$test->id()])) {
            $this->triggeringTests[$test->id()]['count']++;
            return;
        }
        $this->triggeringTests[$test->id()] = [
            'test' => $test,
            'count' => 1,
        ];
    }
    
    /**
     * @psalm-return non-empty-string
     */
    public function file() : string {
        return $this->file;
    }
    
    /**
     * @psalm-return positive-int
     */
    public function line() : int {
        return $this->line;
    }
    
    /**
     * @psalm-return non-empty-string
     */
    public function description() : string {
        return $this->description;
    }
    
    /**
     * @psalm-return non-empty-array<non-empty-string, array{test: Test, count: int}>
     */
    public function triggeringTests() : array {
        return $this->triggeringTests;
    }

}

Members

Title Modifiers Object type Summary
Issue::$description private property @psalm-var non-empty-string
Issue::$file private property @psalm-var non-empty-string
Issue::$line private property @psalm-var positive-int
Issue::$triggeringTests private property @psalm-var non-empty-array&lt;non-empty-string, array{test: Test, count: int}&gt;
Issue::description public function @psalm-return non-empty-string
Issue::file public function @psalm-return non-empty-string
Issue::from public static function @psalm-param non-empty-string $file
@psalm-param positive-int $line
@psalm-param non-empty-string $description
Issue::line public function @psalm-return positive-int
Issue::triggeredBy public function
Issue::triggeringTests public function @psalm-return non-empty-array&lt;non-empty-string, array{test: Test, count: int}&gt;
Issue::__construct private function @psalm-param non-empty-string $file
@psalm-param positive-int $line
@psalm-param non-empty-string $description