Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
"symplify/easy-coding-standard": "^10.0.6",
"nikic/php-parser": "^4.0"
},
"autoload": {
"psr-4": {
"JumpTwentyFour\\PhpCodingStandards\\": "src"
}
},
"prefer-stable": true,
"minimum-stability": "dev",
"config": {
Expand Down
2 changes: 2 additions & 0 deletions ecs.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

declare(strict_types=1);

use JumpTwentyFour\PhpCodingStandards\Sniffs\FinalControllerSniff;
use PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis\UnusedFunctionParameterSniff;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterCastSniff;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterNotSniff;
Expand Down Expand Up @@ -152,5 +153,6 @@
$services->set(MethodSpacingSniff::class);
$services->set(BackedEnumTypeSpacingSniff::class);
$services->set(UnusedFunctionParameterSniff::class);
$services->set(FinalControllerSniff::class);
$services->set(ValidVariableNameSniff::class);
};
60 changes: 60 additions & 0 deletions src/Sniffs/FinalControllerSniff.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php

declare(strict_types=1);

namespace JumpTwentyFour\PhpCodingStandards\Sniffs;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\TokenHelper;

class FinalControllerSniff implements Sniff
{
public const CONTROLLER_NOT_FINAL = 'ControllerNotFinal';

public function register(): array
{
return [
T_CLASS,
];
}

public function process(File $phpcsFile, $classPointer): void
{
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $classPointer - 1);

$tokens = $phpcsFile->getTokens();

$className = $phpcsFile->getDeclarationName($classPointer);

if ($className === 'Controller') {
return;
}

if (str_contains($className, 'Test')) {
return;
}

if (str_contains($className, 'Controller') === false) {
return;
}

if ($tokens[$previousPointer]['code'] === T_FINAL) {
return;
}

$fix = $phpcsFile->addFixableError(
'All controllers should be declared using "final" keyword.',
$classPointer - 1,
self::CONTROLLER_NOT_FINAL
);

if ($fix === false) {
return;
}

$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->addContent($classPointer - 1, 'final ');
$phpcsFile->fixer->endChangeset();
}
}