PipeOperatorRule

Author: ondrejmirtes

src/Rules/Operators/PipeOperatorRule.php

@@ -0,0 +1,66 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Operators;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\RegisteredRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Rules\RuleLevelHelper;
+use PHPStan\Type\ErrorType;
+use PHPStan\Type\Type;
+use function sprintf;
+
+/**
+ * @implements Rule<Node\Expr\BinaryOp\Pipe>
+ */
+#[RegisteredRule(level: 0)]
+final class PipeOperatorRule implements Rule
+{
+
+	public function __construct(private RuleLevelHelper $ruleLevelHelper)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Expr\BinaryOp\Pipe::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$rightType = $this->ruleLevelHelper->findTypeToCheck(
+			$scope,
+			$node->right,
+			'',
+			static fn (Type $type) => $type->isCallable()->yes(),
+		)->getType();
+		if ($rightType instanceof ErrorType) {
+			return [];
+		}
+		if (!$rightType->isCallable()->yes()) {
+			return [];
+		}
+
+		$acceptors = $rightType->getCallableParametersAcceptors($scope);
+		foreach ($acceptors as $acceptor) {
+			foreach ($acceptor->getParameters() as $parameter) {
+				if ($parameter->passedByReference()->no()) {
+					break;
+				}
+
+				return [
+					RuleErrorBuilder::message(sprintf(
+						'Parameter #1%s of callable on the right side of pipe operator is passed by reference.',
+						$parameter->getName() !== '' ? ' $' . $parameter->getName() : '',
+					))->identifier('pipe.parameterPassedByReference')
+						->build(),
+				];
+			}
+		}
+
+		return [];
+	}
+
+}

tests/PHPStan/Rules/Operators/PipeOperatorRuleTest.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Operators;
+
+use PHPStan\Rules\Rule as TRule;
+use PHPStan\Rules\RuleLevelHelper;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\RequiresPhp;
+
+/**
+ * @extends RuleTestCase<PipeOperatorRule>
+ */
+class PipeOperatorRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): TRule
+	{
+		return new PipeOperatorRule(
+			new RuleLevelHelper(self::createReflectionProvider(), true, false, true, true, true, false, true),
+		);
+	}
+
+	#[RequiresPhp('>= 8.5')]
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/pipe-operator.php'], [
+			[
+				'Parameter #1 of callable on the right side of pipe operator is passed by reference.',
+				14,
+			],
+			[
+				'Parameter #1 $s of callable on the right side of pipe operator is passed by reference.',
+				16,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Operators/data/pipe-operator.php

@@ -0,0 +1,24 @@
+<?php // lint >= 8.5
+
+namespace PipeOperator;
+
+class Foo
+{
+
+	/**
+	 * @param callable(string &): void $cb
+	 */
+	public function doFoo(callable $cb): void
+	{
+		$a = 'hello';
+		$a |> $cb;
+
+		$a |> self::doBar(...);
+	}
+
+	public static function doBar(string &$s): void
+	{
+
+	}
+
+}