ZenifyCodingStandard\Sniffs\Scope\MethodScopeSniff

Complexity

Total Complexity

7

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

95.24%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	processTokenWithinScope()	0	29	6

<?php

/**
 * This file is part of Zenify
 * Copyright (c) 2012 Tomas Votruba (http://tomasvotruba.cz)
 */

namespace ZenifyCodingStandard\Sniffs\Scope;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Standards_AbstractScopeSniff;
use PHP_CodeSniffer_Tokens;


/**
 * Rules:
 * - Function "%s" should have scope modifier.
 * - Interface function "%s" should not have scope modifier.
 */
class MethodScopeSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
{

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


	/**
	 * {@inheritdoc}
	 */
	protected function processTokenWithinScope(PHP_CodeSniffer_File $file, $position, $currScope)
	{
		$tokens = $file->getTokens();

		$isClass = $tokens[$currScope]['code'] === T_CLASS;

		$methodName = $file->getDeclarationName($position);
		if ($methodName === NULL) {
			return;
		}

		$pCurly = $file->findPrevious(T_CLOSE_CURLY_BRACKET, $position);
		$modifier = $file->findPrevious(PHP_CodeSniffer_Tokens::$scopeModifiers, $position, max($currScope, $pCurly));

It seems like max($currScope, $pCurly) targeting max() can also be of type boolean; however, PHP_CodeSniffer_File::findPrevious() does only seem to accept integer|null, maybe add an additional type check?

		if ($isClass) {
			if (($modifier === FALSE) || ($tokens[$modifier]['line'] !== $tokens[$position]['line'])) {
				$error = 'Function "%s" should have scope modifier.';
				$data = [$methodName];
				$file->addError($error, $position, '', $data);
			}

		} else {
			if ($modifier !== FALSE) {
				$error = 'Interface function "%s" should not have scope modifier.';
				$data = [$methodName];
				$file->addError($error, $position, '', $data);
			}
		}
	}

}