PSR2R\Sniffs\Methods\MethodDeclarationSniff

Complexity

Total Complexity

21

Size/Duplication

Total Lines	105
Duplicated Lines	52.38 %

Coupling/Cohesion

Components	0
Dependencies	4

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
F	processTokenWithinScope()	55	91	20

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 37 and the first side effect is on line 23.

/**
 * PSR2_Sniffs_Methods_MethodDeclarationSniff.
 *
 * PHP version 5
 *
 * @category  PHP
 * @package   PHP_CodeSniffer
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 */

namespace PSR2R\Sniffs\Methods;

use PHP_CodeSniffer_Exception;
use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Standards_AbstractScopeSniff;
use PHP_CodeSniffer_Tokens;

if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
	throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found');
}

/**
 * PSR2_Sniffs_Methods_MethodDeclarationSniff.
 *
 * Checks that the method declaration is correct.
 *
 * @author Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 * @version Release: @package_version@
 * @link http://pear.php.net/package/PHP_CodeSniffer
 */
class MethodDeclarationSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff {

	/**
	 * @inheritDoc
	 */
	public function __construct() {
		parent::__construct([T_CLASS, T_INTERFACE], [T_FUNCTION]);
	}

	/**
	 * @inheritDoc
	 */
	protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) {
		$tokens = $phpcsFile->getTokens();

		$methodName = $phpcsFile->getDeclarationName($stackPtr);
		if ($methodName === null) {
			// Ignore closures.
			return;
		}

		$visibility = 0;
		$static = 0;
		$abstract = 0;
		$final = 0;

		$find = PHP_CodeSniffer_Tokens::$methodPrefixes;
		$find[] = T_WHITESPACE;
		$prev = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);

		$prefix = $stackPtr;
		while (($prefix = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$methodPrefixes, ($prefix - 1), $prev)) !== false) {

It seems like $prev defined by $phpcsFile->findPrevious($find, $stackPtr - 1, null, true) on line 65 can also be of type boolean; however, PHP_CodeSniffer_File::findPrevious() does only seem to accept integer|null, maybe add an additional type check?

This code seems to be duplicated across your project.

			switch ($tokens[$prefix]['code']) {
				case T_STATIC:
					$static = $prefix;
					break;
				case T_ABSTRACT:
					$abstract = $prefix;
					break;
				case T_FINAL:
					$final = $prefix;
					break;
				default:
					$visibility = $prefix;
					break;
			}
		}

		$fixes = [];

		if ($visibility !== 0 && $final > $visibility) {

This code seems to be duplicated across your project.

			$error = 'The final declaration must precede the visibility declaration';
			$fix = $phpcsFile->addFixableError($error, $final, 'FinalAfterVisibility');

It seems like $final defined by $prefix on line 77 can also be of type boolean; however, PHP_CodeSniffer_File::addFixableError() does only seem to accept integer, maybe add an additional type check?

			if ($fix === true) {
				$fixes[$final] = '';
				$fixes[($final + 1)] = '';
				if (isset($fixes[$visibility]) === true) {
					$fixes[$visibility] = 'final ' . $fixes[$visibility];
				} else {
					$fixes[$visibility] = 'final ' . $tokens[$visibility]['content'];
				}
			}
		}

		if ($visibility !== 0 && $abstract > $visibility) {

This code seems to be duplicated across your project.

			$error = 'The abstract declaration must precede the visibility declaration';
			$fix = $phpcsFile->addFixableError($error, $abstract, 'AbstractAfterVisibility');

It seems like $abstract defined by $prefix on line 74 can also be of type boolean; however, PHP_CodeSniffer_File::addFixableError() does only seem to accept integer, maybe add an additional type check?

			if ($fix === true) {
				$fixes[$abstract] = '';
				$fixes[($abstract + 1)] = '';
				if (isset($fixes[$visibility]) === true) {
					$fixes[$visibility] = 'abstract ' . $fixes[$visibility];
				} else {
					$fixes[$visibility] = 'abstract ' . $tokens[$visibility]['content'];
				}
			}
		}

		if ($static !== 0 && $static < $visibility) {

This code seems to be duplicated across your project.

			$error = 'The static declaration must come after the visibility declaration';
			$fix = $phpcsFile->addFixableError($error, $static, 'StaticBeforeVisibility');

It seems like $static defined by $prefix on line 71 can also be of type boolean; however, PHP_CodeSniffer_File::addFixableError() does only seem to accept integer, maybe add an additional type check?

			if ($fix === true) {
				$fixes[$static] = '';
				$fixes[($static + 1)] = '';
				if (isset($fixes[$visibility]) === true) {
					$fixes[$visibility] = $fixes[$visibility] . ' static';
				} else {
					$fixes[$visibility] = $tokens[$visibility]['content'] . ' static';
				}
			}
		}

		// Batch all the fixes together to reduce the possibility of conflicts.
		if (empty($fixes) === false) {
			$phpcsFile->fixer->beginChangeset();
			foreach ($fixes as $stackPtr => $content) {
				$phpcsFile->fixer->replaceToken($stackPtr, $content);
			}

			$phpcsFile->fixer->endChangeset();
		}

	}

}