ZenifyCodingStandard\Helper\Commenting\MethodDocBlock

Complexity

Total Complexity

5

Size/Duplication

Total Lines	34
Duplicated Lines	50 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

93.75%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	hasMethodDocBlock()	17	17	3
A	getMethodDocBlock()	0	10	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);

It seems like $commentStart defined by $file->findPrevious(T_DOC_COMMENT_OPEN_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?

	}

}