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

MethodDocBlock::getMethodDocBlock() A
last analyzed 2016-12-30 16:03 UTC

↳ Parent: MethodDocBlock

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	2
crap	2

<?php

declare(strict_types = 1);

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

namespace ZenifyCodingStandard\Helper\Commenting;

use PHP_CodeSniffer_File;


final class MethodDocBlock
{

	public static function hasMethodDocBlock(PHP_CodeSniffer_File $file, int $position) : bool
	{
		$tokens = $file->getTokens();
		$currentToken = $tokens[$position];
		$docBlockClosePosition = $file->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $position);

		if ($docBlockClosePosition === FALSE) {
			return FALSE;
		}

		$docBlockCloseToken = $tokens[$docBlockClosePosition];
		if ($docBlockCloseToken['line'] === ($currentToken['line'] - 1)) {
			return TRUE;
		}

		return FALSE;
	}


	public static function getMethodDocBlock(PHP_CodeSniffer_File $file, int $position) : string
	{
		if ( ! self::hasMethodDocBlock($file, $position)) {
			return '';
		}

		$commentStart = $file->findPrevious(T_DOC_COMMENT_OPEN_TAG, $position - 1);
		$commentEnd = $file->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $position - 1);
		return $file->getTokensAsString($commentStart, $commentEnd - $commentStart + 1);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
	}

}


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\Helper\Commenting;
11
12			use PHP_CodeSniffer_File;
13
14
15			final class MethodDocBlock
16			{
17
18	1	View Code Duplication	public static function hasMethodDocBlock(PHP_CodeSniffer_File $file, int $position) : bool
19			{
20	1		$tokens = $file->getTokens();
21	1		$currentToken = $tokens[$position];
22	1		$docBlockClosePosition = $file->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $position);
23
24	1		if ($docBlockClosePosition === FALSE) {
25	1		return FALSE;
26			}
27
28	1		$docBlockCloseToken = $tokens[$docBlockClosePosition];
29	1		if ($docBlockCloseToken['line'] === ($currentToken['line'] - 1)) {
30	1		return TRUE;
31			}
32
33			return FALSE;
34			}
35
36
37	1		public static function getMethodDocBlock(PHP_CodeSniffer_File $file, int $position) : string
38			{
39	1		if ( ! self::hasMethodDocBlock($file, $position)) {
40	1		return '';
41			}
42
43	1		$commentStart = $file->findPrevious(T_DOC_COMMENT_OPEN_TAG, $position - 1);
44	1		$commentEnd = $file->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $position - 1);
45	1		return $file->getTokensAsString($commentStart, $commentEnd - $commentStart + 1);
			0 ignored issues – show Bug introduced 2016-10-31 23:52 UTC by Report Bug Copy Issue Report It seems like `$commentStart` defined by `$file->findPrevious(T_DO...PEN_TAG, $position - 1)` on line `43` can also be of type `boolean`; however, `PHP_CodeSniffer_File::getTokensAsString()` does only seem to accept `integer`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
46			}
47
48			}
49

Zenify / CodingStandard

MethodDocBlock::getMethodDocBlock() A last analyzed 2016-12-30 16:03 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

MethodDocBlock::getMethodDocBlock() A
last analyzed 2016-12-30 16:03 UTC