ClassLengthSniff::process() - Code Metrics - bmitch/Codor - Measure and Improve Code Quality continuously with Scrutinizer

ClassLengthSniff::process() A
last analyzed 2022-06-17 20:33 UTC

↳ Parent: ClassLengthSniff

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	7
c	1
b	0
f	0
dl	0
loc	12
rs	10
cc	2
nc	2
nop	2

<?php declare(strict_types = 1);

namespace Codor\Sniffs\Classes;

use PHP_CodeSniffer\Sniffs\Sniff as PHP_CodeSniffer_Sniff;
use PHP_CodeSniffer\Files\File as PHP_CodeSniffer_File;

class ClassLengthSniff implements PHP_CodeSniffer_Sniff
{

    /**
     * The maximum number of lines a class
     * should have.
     * @var integer
     */
    public $maxLength = 200;

    /**
     * Returns the token types that this sniff is interested in.
     * @return array
     */
    public function register(): array
    {
        return [T_CLASS];
    }

    /**
     * Processes the tokens that this sniff is interested in.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
     * @param int                  $stackPtr  The position in the stack where
     *                                        the token was found.
     * @return void
     */
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        $token = $tokens[$stackPtr];
        
        $openParenthesis = $tokens[$token['scope_opener']];
        $closedParenthesis = $tokens[$token['scope_closer']];

        $length = $closedParenthesis['line'] - $openParenthesis['line'];

        if ($length > $this->maxLength) {
            $phpcsFile->addError("Class is {$length} lines. Must be {$this->maxLength} lines or fewer.", $stackPtr, __CLASS__);
        }
    }
}


1			<?php declare(strict_types = 1);
2
3			namespace Codor\Sniffs\Classes;
4
5			use PHP_CodeSniffer\Sniffs\Sniff as PHP_CodeSniffer_Sniff;
6			use PHP_CodeSniffer\Files\File as PHP_CodeSniffer_File;
7
8			class ClassLengthSniff implements PHP_CodeSniffer_Sniff
9			{
10
11			/**
12			* The maximum number of lines a class
13			* should have.
14			* @var integer
15			*/
16			public $maxLength = 200;
17
18			/**
19			* Returns the token types that this sniff is interested in.
20			* @return array
21			*/
22			public function register(): array
23			{
24			return [T_CLASS];
25			}
26
27			/**
28			* Processes the tokens that this sniff is interested in.
29			*
30			* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
31			* @param int $stackPtr The position in the stack where
32			* the token was found.
33			* @return void
34			*/
35			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
36			{
37			$tokens = $phpcsFile->getTokens();
38			$token = $tokens[$stackPtr];
39
40			$openParenthesis = $tokens[$token['scope_opener']];
41			$closedParenthesis = $tokens[$token['scope_closer']];
42
43			$length = $closedParenthesis['line'] - $openParenthesis['line'];
44
45			if ($length > $this->maxLength) {
46			$phpcsFile->addError("Class is {$length} lines. Must be {$this->maxLength} lines or fewer.", $stackPtr, __CLASS__);
47			}
48			}
49			}
50

bmitch / Codor

ClassLengthSniff::process() A last analyzed 2022-06-17 20:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ClassLengthSniff::process() A
last analyzed 2022-06-17 20:33 UTC