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

Breadcrumb

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

class DisallowNewWidgetSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\MySource\Sniffs\Objects\DisallowNewWidgetSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of DisallowNewWidgetSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php, line 17

Namespace

PHP_CodeSniffer\Standards\MySource\Sniffs\Objects
View source
class DisallowNewWidgetSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_NEW,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @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();
        $className = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
        if ($tokens[$className]['code'] !== T_STRING) {
            return;
        }
        if (substr(strtolower($tokens[$className]['content']), -10) === 'widgettype') {
            $widgetType = substr($tokens[$className]['content'], 0, -10);
            $error = 'Manual creation of widget objects is banned; use Widget::getWidget(\'%s\'); instead';
            $data = [
                $widgetType,
            ];
            $phpcsFile->addError($error, $stackPtr, 'Found', $data);
        }
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DisallowNewWidgetSniff::process public function Processes this test, when one of its tokens is encountered. Overrides Sniff::process
DisallowNewWidgetSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal