AbstractClassNameSniff::getClassName() - Code Metrics - Zenify/CodingStandard - Measure and Improve Code Quality continuously with Scrutinizer

AbstractClassNameSniff::getClassName() A
last analyzed 2016-12-30 16:03 UTC

↳ Parent: AbstractClassNameSniff

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	9
Ratio	100 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

Metric	Value
dl	9
loc	9
ccs	4
cts	5
cp	0.8
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	2.032

<?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:
 * - Abstract class should have prefix "Abstract"
 */
final class AbstractClassNameSniff implements PHP_CodeSniffer_Sniff
{

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

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

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


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


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

		if ( ! $this->isClassAbstract()) {
			return;
		}

		if (strpos($this->getClassName(), 'Abstract') === 0) {
			return;
		}

		$file->addError('Abstract class should have prefix "Abstract".', $position);
	}


	private function isClassAbstract() : bool
	{
		$classProperties = $this->file->getClassProperties($this->position);
		return $classProperties['is_abstract'];
	}


	/**
	 * @return string|FALSE
	 */
	private function getClassName()
	{
		$namePosition = $this->file->findNext(T_STRING, $this->position);
		if ( ! $namePosition) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			return FALSE;
		}

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

}


1			<?php
2
3			declare(strict_types = 1);
4
5			/*
6			* This file is part of Zenify
7			* Copyright (c) 2012 Tomas Votruba (http://tomasvotruba.cz)
8			*/
9
10			namespace ZenifyCodingStandard\Sniffs\Naming;
11
12			use PHP_CodeSniffer_File;
13			use PHP_CodeSniffer_Sniff;
14
15
16			/**
17			* Rules:
18			* - Abstract class should have prefix "Abstract"
19			*/
20			final class AbstractClassNameSniff implements PHP_CodeSniffer_Sniff
21			{
22
23			/**
24			* @var string
25			*/
26			const NAME = 'ZenifyCodingStandard.Naming.AbstractClassName';
27
28			/**
29			* @var PHP_CodeSniffer_File
30			*/
31			private $file;
32
33			/**
34			* @var int
35			*/
36			private $position;
37
38
39			/**
40			* @return int[]
41			*/
42	1		public function register() : array
43			{
44	1		return [T_CLASS];
45			}
46
47
48			/**
49			* @param PHP_CodeSniffer_File $file
50			* @param int $position
51			*/
52	1		public function process(PHP_CodeSniffer_File $file, $position)
53			{
54	1		$this->file = $file;
55	1		$this->position = $position;
56
57	1		if ( ! $this->isClassAbstract()) {
58	1		return;
59			}
60
61	1		if (strpos($this->getClassName(), 'Abstract') === 0) {
62	1		return;
63			}
64
65	1		$file->addError('Abstract class should have prefix "Abstract".', $position);
66	1		}
67
68
69	1		private function isClassAbstract() : bool
70			{
71	1		$classProperties = $this->file->getClassProperties($this->position);
72	1		return $classProperties['is_abstract'];
73			}
74
75
76			/**
77			* @return string\|FALSE
78			*/
79	1	View Code Duplication	private function getClassName()
80			{
81	1		$namePosition = $this->file->findNext(T_STRING, $this->position);
82	1		if ( ! $namePosition) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-23 15:53 UTC by Report Bug Copy Issue Report 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. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
83			return FALSE;
84			}
85
86	1		return $this->file->getTokens()[$namePosition]['content'];
87			}
88
89			}
90

Zenify / CodingStandard

AbstractClassNameSniff::getClassName() A last analyzed 2016-12-30 16:03 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AbstractClassNameSniff::getClassName() A
last analyzed 2016-12-30 16:03 UTC