class PropertyDeclarationSniff

Same name in this branch
  1. 11.1.x vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertyDeclarationSniff.php \SlevomatCodingStandard\Sniffs\Classes\PropertyDeclarationSniff
  2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PSR2/Sniffs/Classes/PropertyDeclarationSniff.php \PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\PropertyDeclarationSniff

Largely copied from \PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\PropertyDeclarationSniff to have a fixer for the var keyword.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

Expanded class hierarchy of PropertyDeclarationSniff

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Classes/PropertyDeclarationSniff.php, line 25

Namespace

Drupal\Sniffs\Classes
View source 
class PropertyDeclarationSniff extends AbstractVariableSniff {
    
    /**
     * Processes the function tokens within the class.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
     * @param int                         $stackPtr  The position where the token was found.
     *
     * @return void
     */
    protected function processMemberVar(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$stackPtr]['content'][1] === '_') {
            $error = 'Property name "%s" should not be prefixed with an underscore to indicate visibility';
            $data = [
                $tokens[$stackPtr]['content'],
            ];
            $phpcsFile->addWarning($error, $stackPtr, 'Underscore', $data);
        }
        // Detect multiple properties defined at the same time. Throw an error
        // for this, but also only process the first property in the list so we don't
        // repeat errors.
        $find = Tokens::$scopeModifiers;
        $find = array_merge($find, [
            T_VARIABLE,
            T_VAR,
            T_SEMICOLON,
        ]);
        $prev = $phpcsFile->findPrevious($find, $stackPtr - 1);
        if ($tokens[$prev]['code'] === T_VARIABLE) {
            return;
        }
        if ($tokens[$prev]['code'] === T_VAR) {
            $error = 'The var keyword must not be used to declare a property';
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'VarUsed');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($prev, 'public');
            }
        }
        $next = $phpcsFile->findNext([
            T_VARIABLE,
            T_SEMICOLON,
        ], $stackPtr + 1);
        if ($tokens[$next]['code'] === T_VARIABLE) {
            $error = 'There must not be more than one property declared per statement';
            $phpcsFile->addError($error, $stackPtr, 'Multiple');
        }
        $modifier = $phpcsFile->findPrevious(Tokens::$scopeModifiers, $stackPtr);
        if ($modifier === false || $tokens[$modifier]['line'] !== $tokens[$stackPtr]['line']) {
            $error = 'Visibility must be declared on property "%s"';
            $data = [
                $tokens[$stackPtr]['content'],
            ];
            $phpcsFile->addError($error, $stackPtr, 'ScopeMissing', $data);
        }
    }
    
    //end processMemberVar()
    
    /**
     * Processes normal variables.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
     * @param int                         $stackPtr  The position where the token was found.
     *
     * @return void
     */
    protected function processVariable(File $phpcsFile, $stackPtr) {
        
        /*
            We don't care about normal variables.
        */
    }
    
    //end processVariable()
    
    /**
     * Processes variables in double quoted strings.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
     * @param int                         $stackPtr  The position where the token was found.
     *
     * @return void
     */
    protected function processVariableInString(File $phpcsFile, $stackPtr) {
        
        /*
            We don't care about normal variables.
        */
    }
    
    //end processVariableInString()

}

Members

Title Modifiers Object type Summary Overriden Title
AbstractScopeSniff::$listenOutside private property True if this test should fire on tokens outside of the scope.
AbstractScopeSniff::$scopeTokens private property The type of scope opener tokens that this test wishes to listen to.
AbstractScopeSniff::$tokens private property The token types that this test wishes to listen to within the scope.
AbstractScopeSniff::process final public function Processes the tokens that this test is listening for. Overrides Sniff::process
AbstractScopeSniff::register final public function The method that is called to register the tokens this test wishes to
listen to. 		Overrides Sniff::register
AbstractVariableSniff::$phpReservedVars protected property List of PHP Reserved variables.
AbstractVariableSniff::processTokenOutsideScope final protected function Processes the token outside the scope in the file. Overrides AbstractScopeSniff::processTokenOutsideScope
AbstractVariableSniff::processTokenWithinScope final protected function Processes the token in the specified PHP_CodeSniffer\Files\File. Overrides AbstractScopeSniff::processTokenWithinScope
AbstractVariableSniff::__construct public function Constructs an AbstractVariableTest. Overrides AbstractScopeSniff::__construct
PropertyDeclarationSniff::processMemberVar protected function Processes the function tokens within the class. Overrides AbstractVariableSniff::processMemberVar
PropertyDeclarationSniff::processVariable protected function Processes normal variables. Overrides AbstractVariableSniff::processVariable
PropertyDeclarationSniff::processVariableInString protected function Processes variables in double quoted strings. Overrides AbstractVariableSniff::processVariableInString