Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DuplicatePropertySniff.php

class DuplicatePropertySniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes\DuplicatePropertySniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of DuplicatePropertySniff

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Classes/DuplicatePropertySniff.php, line 17

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes
View source
class DuplicatePropertySniff implements Sniff {
    
    /**
     * A list of tokenizers this sniff supports.
     *
     * @var array
     */
    public $supportedTokenizers = [
        'JS',
    ];
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_OBJECT,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.
     * @param int                         $stackPtr  The position of the current token in the
     *                                               stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $properties = [];
        $wantedTokens = [
            T_PROPERTY,
            T_OBJECT,
        ];
        $next = $phpcsFile->findNext($wantedTokens, $stackPtr + 1, $tokens[$stackPtr]['bracket_closer']);
        while ($next !== false && $next < $tokens[$stackPtr]['bracket_closer']) {
            if ($tokens[$next]['code'] === T_OBJECT) {
                // Skip nested objects.
                $next = $tokens[$next]['bracket_closer'];
            }
            else {
                $propName = $tokens[$next]['content'];
                if (isset($properties[$propName]) === true) {
                    $error = 'Duplicate property definition found for "%s"; previously defined on line %s';
                    $data = [
                        $propName,
                        $tokens[$properties[$propName]]['line'],
                    ];
                    $phpcsFile->addError($error, $next, 'Found', $data);
                }
                $properties[$propName] = $next;
            }
            
            //end if
            $next = $phpcsFile->findNext($wantedTokens, $next + 1, $tokens[$stackPtr]['bracket_closer']);
        }
        
        //end while
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DuplicatePropertySniff::$supportedTokenizers public property A list of tokenizers this sniff supports.
DuplicatePropertySniff::process public function Processes this test, when one of its tokens is encountered. Overrides Sniff::process
DuplicatePropertySniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal