SlevomatCodingStandard.Classes.ForbiddenPublicProperty: New option "checkPromoted" to enable check of promoted properties

Author: kukulich

README.md

@@ -187,6 +187,10 @@ Disallows late static binding for constants.
 
 Disallows using public properties.
 
+This sniff provides the following setting:
+
+* `checkPromoted`: will check promoted properties too.
+
 #### SlevomatCodingStandard.Classes.RequireAbstractOrFinal 🔧
 
 Requires the class to be declared either as abstract or as final.

SlevomatCodingStandard/Sniffs/Classes/ForbiddenPublicPropertySniff.php

@@ -20,6 +20,9 @@ final class ForbiddenPublicPropertySniff implements Sniff
 
 	public const CODE_FORBIDDEN_PUBLIC_PROPERTY = 'ForbiddenPublicProperty';
 
+	/** @var bool */
+	public $checkPromoted = false;
+
 	/**
 	 * @return array<int, (int|string)>
 	 */
@@ -34,7 +37,7 @@ public function register(): array
 	 */
 	public function process(File $file, $variablePointer): void
 	{
-		if (!PropertyHelper::isProperty($file, $variablePointer)) {
+		if (!PropertyHelper::isProperty($file, $variablePointer, $this->checkPromoted)) {
 			return;
 		}
 

tests/Sniffs/Classes/ForbiddenPublicPropertySniffTest.php

@@ -24,4 +24,25 @@ public function testErrors(): void
 		self::assertSniffError($report, 7, ForbiddenPublicPropertySniff::CODE_FORBIDDEN_PUBLIC_PROPERTY);
 	}
 
+	public function testPromotedNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/forbiddenPublicPropertyPromotedNoErrors.php', [
+			'checkPromoted' => true,
+		]);
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testPromotedErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/forbiddenPublicPropertyPromotedErrors.php', [
+			'checkPromoted' => true,
+		]);
+
+		self::assertSame(4, $report->getErrorCount());
+
+		self::assertSniffError($report, 5, ForbiddenPublicPropertySniff::CODE_FORBIDDEN_PUBLIC_PROPERTY);
+		self::assertSniffError($report, 13, ForbiddenPublicPropertySniff::CODE_FORBIDDEN_PUBLIC_PROPERTY);
+		self::assertSniffError($report, 14, ForbiddenPublicPropertySniff::CODE_FORBIDDEN_PUBLIC_PROPERTY);
+	}
+
 }

tests/Sniffs/Classes/data/forbiddenPublicPropertyNoErrors.php

@@ -1,4 +1,4 @@
-<?php
+<?php // lint >= 8.1
 
 function add(int $a, int $b)
 {
@@ -8,6 +8,10 @@ function add(int $a, int $b)
 class Test
 {
 	private $one, $two;
+
+	public function __construct(public int $promoted)
+	{
+	}
 }
 
 class TestSniff

tests/Sniffs/Classes/data/forbiddenPublicPropertyPromotedErrors.php

@@ -0,0 +1,18 @@
+<?php // lint >= 8.1
+
+class Test
+{
+	public function __construct(public int $promoted1, readonly public string $promoted2)
+	{
+	}
+}
+
+class Test2
+{
+	public function __construct(
+		public int $promoted3,
+		readonly public string $promoted4,
+	)
+	{
+	}
+}

tests/Sniffs/Classes/data/forbiddenPublicPropertyPromotedNoErrors.php

@@ -0,0 +1,8 @@
+<?php // lint >= 8.1
+
+class Test
+{
+	public function __construct(protected int $promoted1, readonly private string $promoted2)
+	{
+	}
+}