function CoversHelper::processCovers

*

Return value

list<IdentifierRuleError> errors

File

vendor/phpstan/phpstan-phpunit/src/Rules/PHPUnit/CoversHelper.php, line 66

Class

CoversHelper

Namespace

PHPStan\Rules\PHPUnit

Code

public function processCovers(Node $node, PhpDocTagNode $phpDocTag, ?PhpDocTagNode $coversDefaultClass) : array {
    $errors = [];
    $covers = (string) $phpDocTag->value;
    if ($covers === '') {
        $errors[] = RuleErrorBuilder::message('@covers value does not specify anything.')->identifier('phpunit.covers')
            ->build();
        return $errors;
    }
    $isMethod = strpos($covers, '::') !== false;
    $fullName = $covers;
    if ($isMethod) {
        [
            $className,
            $method,
        ] = explode('::', $covers);
    }
    else {
        $className = $covers;
    }
    if ($className === '' && $node instanceof Node\Stmt\ClassMethod && $coversDefaultClass !== null) {
        $className = (string) $coversDefaultClass->value;
        $fullName = $className . $covers;
    }
    if ($this->reflectionProvider
        ->hasClass($className)) {
        $class = $this->reflectionProvider
            ->getClass($className);
        if ($class->isInterface()) {
            $errors[] = RuleErrorBuilder::message(sprintf('@covers value %s references an interface.', $fullName))->identifier('phpunit.coversInterface')
                ->build();
        }
        if (isset($method) && $method !== '' && !$class->hasMethod($method)) {
            $errors[] = RuleErrorBuilder::message(sprintf('@covers value %s references an invalid method.', $fullName))->identifier('phpunit.coversMethod')
                ->build();
        }
    }
    elseif (isset($method) && $this->reflectionProvider
        ->hasFunction(new Name($method, []), null)) {
        return $errors;
    }
    elseif (!isset($method) && $this->reflectionProvider
        ->hasFunction(new Name($className, []), null)) {
        return $errors;
    }
    else {
        $error = RuleErrorBuilder::message(sprintf('@covers value %s references an invalid %s.', $fullName, $isMethod ? 'method' : 'class or function'))->identifier(sprintf('phpunit.covers%s', $isMethod ? 'Method' : ''));
        if (strpos($className, '\\') === false) {
            $error->tip('The @covers annotation requires a fully qualified name.');
        }
        $errors[] = $error->build();
    }
    return $errors;
}