PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Source for file DisallowNewWidgetSniff.php

Documentation is available at DisallowNewWidgetSniff.php

  1. <?php
  2. /**
  3.  * Ensures that widgets are not manually created.
  4.  *
  5.  * @author    Greg Sherwood <gsherwood@squiz.net>
  6.  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Objects;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14.  
  15. class DisallowNewWidgetSniff implements Sniff
  16. {
  17.  
  18.  
  19.     /**
  20.      * Returns an array of tokens this test wants to listen for.
  21.      *
  22.      * @return array 
  23.      */
  24.     public function register()
  25.     {
  26.         return array(T_NEW);
  27.  
  28.     }//end register()
  29.  
  30.  
  31.     /**
  32.      * Processes this test, when one of its tokens is encountered.
  33.      *
  34.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  35.      * @param int                         $stackPtr  The position of the current token
  36.      *                                                in the stack passed in $tokens.
  37.      *
  38.      * @return void 
  39.      */
  40.     public function process(File $phpcsFile$stackPtr)
  41.     {
  42.         $tokens $phpcsFile->getTokens();
  43.  
  44.         $className $phpcsFile->findNext(T_WHITESPACE($stackPtr + 1)nulltrue);
  45.         if ($tokens[$className]['code'!== T_STRING{
  46.             return;
  47.         }
  48.  
  49.         if (substr(strtolower($tokens[$className]['content'])-10=== 'widgettype'{
  50.             $widgetType substr($tokens[$className]['content']0-10);
  51.             $error      'Manual creation of widget objects is banned; use Widget::getWidget(\'%s\'); instead';
  52.             $data       = array($widgetType);
  53.             $phpcsFile->addError($error$stackPtr'Found'$data);
  54.         }
  55.  
  56.     }//end process()
  57.  
  58.  
  59. }//end class

Documentation generated on Mon, 11 Mar 2019 15:27:23 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.