Rule.php

<?php declare(strict_types = 1);

namespace PHPStan\Rules;

use PhpParser\Node;
use PHPStan\Analyser\CollectedDataEmitter;
use PHPStan\Analyser\NodeCallbackInvoker;
use PHPStan\Analyser\Scope;

/**
 * This is the interface custom rules implement. To register it in the configuration file
 * use the `phpstan.rules.rule` service tag:
 *
 * ```
 * services:
 * 	-
 *		class: App\MyRule
 *		tags:
 *			- phpstan.rules.rule
 * ```
 *
 * Learn more: https://phpstan.org/developing-extensions/rules
 *
 * @api
 * @template TNodeType of Node
 */
interface Rule
{

	/**
	 * @return class-string<TNodeType>
	 */
	public function getNodeType(): string;

	/**
	 * @param TNodeType $node
	 * @return list<IdentifierRuleError>
	 */
	public function processNode(Node $node, Scope&NodeCallbackInvoker&CollectedDataEmitter $scope): array;

}