ValidVariableNameSniff::process() - Code Metrics - Inspection of "2.0.0 Upgrade to 3.0 version of PHPCS" - mediact/coding-standard - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Retried Inspection

Pull Request — master (#2)

by Ashoka

created 2017-11-02 11:46 UTC

ValidVariableNameSniff::process() A

↳ Parent: ValidVariableNameSniff

Complexity

Conditions	3
Paths	2

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	8
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	12
rs	9.4285

<?php
/**
 * Copyright MediaCT. All rights reserved.
 * https://www.mediact.nl
 */

namespace Mediact\CodingStandard\MediactCommon\Sniffs\NamingConventions;

use PHP_CodeSniffer\Files\File;
filter:
    dependency_paths: ["lib/*"]
use PHP_CodeSniffer\Sniffs\Sniff;
filter:
    dependency_paths: ["lib/*"]

class ValidVariableNameSniff implements Sniff
{
    /** @var array  */
    public $allowedNames = [
        '_GET',
        '_POST',
        '_COOKIE',
        '_FILES',
        '_REQUEST',
        '_SERVER',
        '_SESSION'
    ];

    /**
     * Listen to variable name tokens.
     *
     * @return int[]
     */
    public function register()
    {
        return [T_VARIABLE];
    }

    /**
     * Check variable names to make sure no underscores are used.
     *
     * @param File $phpcsFile
     * @param int  $stackPtr
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $tokens  = $phpcsFile->getTokens();
        $varName = ltrim($tokens[$stackPtr]['content'], '$');

        if (!in_array($varName, $this->allowedNames)
            && preg_match('/^_/', $varName)
        ) {
            $phpcsFile->addWarning(
                'Variable names may not start with an underscore',
                $stackPtr,
                'IllegalVariableNameUnderscore'
            );
        }
    }
}


1			<?php
2			/**
3			* Copyright MediaCT. All rights reserved.
4			* https://www.mediact.nl
5			*/
6
7			namespace Mediact\CodingStandard\MediactCommon\Sniffs\NamingConventions;
8
9			use PHP_CodeSniffer\Files\File;
			0 ignored issues – show Bug introduced 2017-11-02 11:49 UTC by Report Bug Copy Issue Report The type `PHP_CodeSniffer\Files\File` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use PHP_CodeSniffer\Sniffs\Sniff;
			0 ignored issues – show Bug introduced 2017-11-02 11:49 UTC by Report Bug Copy Issue Report The type `PHP_CodeSniffer\Sniffs\Sniff` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11
12			class ValidVariableNameSniff implements Sniff
13			{
14			/** @var array */
15			public $allowedNames = [
16			'_GET',
17			'_POST',
18			'_COOKIE',
19			'_FILES',
20			'_REQUEST',
21			'_SERVER',
22			'_SESSION'
23			];
24
25			/**
26			* Listen to variable name tokens.
27			*
28			* @return int[]
29			*/
30			public function register()
31			{
32			return [T_VARIABLE];
33			}
34
35			/**
36			* Check variable names to make sure no underscores are used.
37			*
38			* @param File $phpcsFile
39			* @param int $stackPtr
40			*
41			* @return void
42			*/
43			public function process(File $phpcsFile, $stackPtr)
44			{
45			$tokens = $phpcsFile->getTokens();
46			$varName = ltrim($tokens[$stackPtr]['content'], '$');
47
48			if (!in_array($varName, $this->allowedNames)
49			&& preg_match('/^_/', $varName)
50			) {
51			$phpcsFile->addWarning(
52			'Variable names may not start with an underscore',
53			$stackPtr,
54			'IllegalVariableNameUnderscore'
55			);
56			}
57			}
58			}
59

mediact / coding-standard

Pull Request — master (#2)

ValidVariableNameSniff::process() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like