ZenifyCodingStandard\Sniffs\Naming\InterfaceNameSniff

Complexity

Total Complexity

5

Size/Duplication

Total Lines	60
Duplicated Lines	15 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

93.33%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
A	process()	0	12	2
A	getInterfaceName()	9	9	2

<?php

declare(strict_types = 1);

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

namespace ZenifyCodingStandard\Sniffs\Naming;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Sniff;


/**
 * Rules:
 * - Interface should have suffix "Interface"
 */
final class InterfaceNameSniff implements PHP_CodeSniffer_Sniff
{

	/**
	 * @var string
	 */
	const NAME = 'ZenifyCodingStandard.Naming.InterfaceName';

	/**
	 * @var PHP_CodeSniffer_File
	 */
	private $file;

	/**
	 * @var int
	 */
	private $position;


	/**
	 * @return int[]
	 */
	public function register() : array
	{
		return [T_INTERFACE];
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 */
	public function process(PHP_CodeSniffer_File $file, $position)
	{
		$this->file = $file;
		$this->position = $position;

		$interfaceName = $this->getInterfaceName();
		if ((strlen($interfaceName) - strlen('Interface')) === strrpos($interfaceName, 'Interface')) {
			return;
		}

		$file->addError('Interface should have suffix "Interface".', $position);
	}


	/**
	 * @return string|FALSE
	 */
	private function getInterfaceName()
	{
		$namePosition = $this->file->findNext(T_STRING, $this->position);
		if ( ! $namePosition) {

The expression $namePosition of type integer|false is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

			return FALSE;
		}

		return $this->file->getTokens()[$namePosition]['content'];
	}

}