DataProviderDeclarationRule.php

<?php declare(strict_types = 1);

namespace PHPStan\Rules\PHPUnit;

use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use PHPStan\Type\FileTypeMapper;
use PHPUnit\Framework\TestCase;
use function array_merge;

/**
 * @implements Rule<Node\Stmt\ClassMethod>
 */
class DataProviderDeclarationRule implements Rule
{

	/**
	 * Data provider helper.
	 *
	 * @var DataProviderHelper
	 */
	private $dataProviderHelper;

	/**
	 * The file type mapper.
	 *
	 * @var FileTypeMapper
	 */
	private $fileTypeMapper;

	/**
	 * When set to true, it reports data provider method with incorrect name case.
	 *
	 * @var bool
	 */
	private $checkFunctionNameCase;

	/**
	 * When phpstan-deprecation-rules is installed, it reports deprecated usages.
	 *
	 * @var bool
	 */
	private $deprecationRulesInstalled;

	public function __construct(
		DataProviderHelper $dataProviderHelper,
		FileTypeMapper $fileTypeMapper,
		bool $checkFunctionNameCase,
		bool $deprecationRulesInstalled
	)
	{
		$this->dataProviderHelper = $dataProviderHelper;
		$this->fileTypeMapper = $fileTypeMapper;
		$this->checkFunctionNameCase = $checkFunctionNameCase;
		$this->deprecationRulesInstalled = $deprecationRulesInstalled;
	}

	public function getNodeType(): string
	{
		return Node\Stmt\ClassMethod::class;
	}

	public function processNode(Node $node, Scope $scope): array
	{
		$classReflection = $scope->getClassReflection();

		if ($classReflection === null || !$classReflection->isSubclassOf(TestCase::class)) {
			return [];
		}

		$docComment = $node->getDocComment();
		if ($docComment === null) {
			return [];
		}

		$methodPhpDoc = $this->fileTypeMapper->getResolvedPhpDoc(
			$scope->getFile(),
			$classReflection->getName(),
			$scope->isInTrait() ? $scope->getTraitReflection()->getName() : null,
			$node->name->toString(),
			$docComment->getText()
		);

		$annotations = $this->dataProviderHelper->getDataProviderAnnotations($methodPhpDoc);

		$testMethodReflection = null;
		if ($classReflection->hasMethod($node->name->toString())) {
			$testMethodReflection = $classReflection->getMethod($node->name->toString(), $scope);
		}

		$errors = [];

		foreach ($annotations as $annotation) {
			$errors = array_merge(
				$errors,
				$this->dataProviderHelper->processDataProvider(
					$scope,
					$annotation,
					$this->checkFunctionNameCase,
					$this->deprecationRulesInstalled,
					$testMethodReflection
				)
			);
		}

		return $errors;
	}

}