MediactCommon\Sniffs\NamingConventions\ValidVariableNameSniff

Complexity

Total Complexity

4

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	register()	0	3	1

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

namespace Mediact\CodingStandard\MediactCommon\Sniffs\NamingConventions;

use PHP_CodeSniffer\Files\File;

The type PHP_CodeSniffer\Files\File was not found. Maybe you did not declare it correctly or list all dependencies?

use PHP_CodeSniffer\Sniffs\Sniff;

The type PHP_CodeSniffer\Sniffs\Sniff was not found. Maybe you did not declare it correctly or list all dependencies?

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'
            );
        }
    }
}