ZenifyCodingStandard\Sniffs\Commenting\VarPropertyCommentSniff

Complexity

Total Complexity

8

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

86.36%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	processMemberVar()	0	10	2
A	processVariable()	0	3	1
A	processVariableInString()	0	3	1
B	getPropertyComment()	0	22	4

<?php

declare(strict_types = 1);

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

namespace ZenifyCodingStandard\Sniffs\Commenting;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Standards_AbstractVariableSniff;


/**
 * Rules:
 * - Property should have docblock comment (except for {@inheritdoc}).
 *
 * @see PHP_CodeSniffer_Standards_AbstractVariableSniff is used, because it's very difficult to
 * separate properties from variables (in args, method etc.). This class does is for us.
 */
final class VarPropertyCommentSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff
{

	/**
	 * @var string
	 */
	const NAME = 'ZenifyCodingStandard.Commenting.VarPropertyComment';

	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 */
	protected function processMemberVar(PHP_CodeSniffer_File $file, $position)
	{
		$commentString = $this->getPropertyComment($file, $position);

		if (strpos($commentString, '@var') !== FALSE) {
			return;
		}

		$file->addError('Property should have docblock comment.', $position);
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 */
	protected function processVariable(PHP_CodeSniffer_File $file, $position)
	{
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 */
	protected function processVariableInString(PHP_CodeSniffer_File $file, $position)
	{
	}


	private function getPropertyComment(PHP_CodeSniffer_File $file, int $position) : string
	{
		$commentEnd = $file->findPrevious([T_DOC_COMMENT_CLOSE_TAG], $position);
		if ($commentEnd === FALSE) {
			return '';
		}

		$tokens = $file->getTokens();
		if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG) {
			return '';

		} else {
			// Make sure the comment we have found belongs to us.
			$commentFor = $file->findNext(T_VARIABLE, $commentEnd + 1);
			if ($commentFor !== $position) {
				return '';
			}
		}

		$commentStart = $file->findPrevious(T_DOC_COMMENT_OPEN_TAG, $position);
		return $file->getTokensAsString($commentStart, $commentEnd - $commentStart + 1);

It seems like $commentStart defined by $file->findPrevious(T_DOC_COMMENT_OPEN_TAG, $position) on line 84 can also be of type boolean; however, PHP_CodeSniffer_File::getTokensAsString() does only seem to accept integer, maybe add an additional type check?

	}

}