UnusedPrivateElementsSniff - configurable always-used properties

Author: ondrejmirtes

README.md

@@ -33,6 +33,8 @@ Although PHP_CodeSniffer is not suitable for static analysis because it is limit
 
 This is very useful during refactoring to clean up dead code and injected dependencies.
 
+This sniff supports `alwaysUsedPropertiesAnnotations` setting to mark certain properties as always used, for example the ones with `@ORM\Column` annotations. Also, `alwaysUsedPropertiesSuffixes` can be set to mark properties with name ending with a certain string to be always marked as used.
+
 ### SlevomatCodingStandard.Arrays.TrailingArrayComma 🔧
 
 Commas after last element in an array make adding a new element easier and result in a cleaner versioning diff.

SlevomatCodingStandard/Sniffs/Classes/UnusedPrivateElementsSniff.php

@@ -15,6 +15,12 @@ class UnusedPrivateElementsSniff implements \PHP_CodeSniffer_Sniff
 
 	const CODE_UNUSED_METHOD = 'unusedMethod';
 
+	/** @var string[] */
+	public $alwaysUsedPropertiesAnnotations = [];
+
+	/** @var string[] */
+	public $alwaysUsedPropertiesSuffixes = [];
+
 	/**
 	 * @return integer[]
 	 */
@@ -173,19 +179,18 @@ private function getProperties(PHP_CodeSniffer_File $phpcsFile, array $tokens, a
 			$findPropertiesStartTokenPointer = $propertyTokenPointer + 1;
 			$phpDocTags = $this->getPhpDocTags($phpcsFile, $tokens, $visibilityModifiedTokenPointer);
 			foreach ($phpDocTags as $tag) {
-				if (in_array(substr($tag, 0, 4), ['@get', '@set'], true)) {
+				if (in_array(substr($tag, 0, 4), $this->alwaysUsedPropertiesAnnotations, true)) {
 					continue 2;
 				}
 			}
 
 			$propertyToken = $tokens[$propertyTokenPointer];
 			$name = substr($propertyToken['content'], 1);
 
-			if (StringHelper::endsWith($name, 'Value')) {
-				continue;
-			}
-			if (StringHelper::endsWith($name, 'Timestamp')) {
-				continue;
+			foreach ($this->alwaysUsedPropertiesSuffixes as $prefix) {
+				if (StringHelper::endsWith($name, $prefix)) {
+					continue 2;
+				}
 			}
 
 			$reportedProperties[$name] = $propertyTokenPointer;

tests/Sniffs/Classes/UnusedPrivateElementsSniffTest.php

@@ -7,7 +7,16 @@ class UnusedPrivateElementsSniffTest extends \SlevomatCodingStandard\Sniffs\Test
 
 	public function testCheckFile()
 	{
-		$resultFile = $this->checkFile(__DIR__ . '/data/ClassWithSomeUnusedProperties.php');
+		$resultFile = $this->checkFile(__DIR__ . '/data/ClassWithSomeUnusedProperties.php', [
+			'alwaysUsedPropertiesAnnotations' => [
+				'@get',
+				'@set',
+			],
+			'alwaysUsedPropertiesSuffixes' => [
+				'Value',
+				'Timestamp',
+			],
+		]);
 		$this->assertNoSniffError($resultFile, 6);
 		$this->assertNoSniffError($resultFile, 8);
 		$this->assertNoSniffError($resultFile, 10);