Codor\Sniffs\Files\FunctionParameterSniff

Complexity

Total Complexity

7

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
B	process()	0	30	6

<?php

namespace Codor\Sniffs\Files;

use PHP_CodeSniffer_Sniff;
use PHP_CodeSniffer_File;

class FunctionParameterSniff implements PHP_CodeSniffer_Sniff
{

    /**
     * The maximum number of parameters a function can have.
     * @var integer
     */
    protected $maxNumberOfParameters = 3;

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

    /**
     * Processes the tokens that this sniff is interested in.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
     * @param integer              $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];

        // Skip function without body.
        if (isset($token['scope_opener']) === false) {
            return;
        }

        $openParenthesisIndex = $token['parenthesis_opener'];
        $closedParenthesisIndex = $token['parenthesis_closer'];

        $numberOfParameters = 0;
        for ($index=$openParenthesisIndex+1; $index <= $closedParenthesisIndex; $index++) {
            if ($tokens[$index]['type'] == 'T_VARIABLE') {
                $numberOfParameters++;
            }
        }

        if ($numberOfParameters > $this->maxNumberOfParameters) {
            $error = "Function has more than {$this->maxNumberOfParameters} parameters. Please reduce.";
            $phpcsFile->addError($error, $stackPtr);
        }

        if ($numberOfParameters == $this->maxNumberOfParameters) {
            $warning = "Function has {$this->maxNumberOfParameters} parameters. Please reduce if possible.";
            $phpcsFile->addWarning($warning, $stackPtr);
        }
    }
}