Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\Objects\GlobalDrupalSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace DrupalPractice\Sniffs\Objects;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: use DrupalPractice\Project;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that \Drupal::service() and friends is not used in forms, controllers, services.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class GlobalDrupalSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * List of base classes where \Drupal should not be used in an extending class.
Chris@0:      *
Chris@0:      * @var string[]
Chris@0:      */
Chris@0:     public static $baseClasses = array(
Chris@0:                                   'BlockBase',
Chris@0:                                   'ConfigFormBase',
Chris@0:                                   'ContentEntityForm',
Chris@0:                                   'ControllerBase',
Chris@0:                                   'EntityForm',
Chris@0:                                   'EntityReferenceFormatterBase',
Chris@0:                                   'FileFormatterBase',
Chris@0:                                   'FormatterBase',
Chris@0:                                   'FormBase',
Chris@0:                                   'ImageFormatter',
Chris@0:                                   'ImageFormatterBase',
Chris@0:                                   'WidgetBase',
Chris@0:                                  );
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_STRING);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token
Chris@17:      *                                               in the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         // We are only interested in Drupal:: static method calls, not in the global
Chris@0:         // scope.
Chris@0:         if ($tokens[$stackPtr]['content'] !== 'Drupal'
Chris@0:             || $tokens[($stackPtr + 1)]['code'] !== T_DOUBLE_COLON
Chris@0:             || isset($tokens[($stackPtr + 2)]) === false
Chris@0:             || $tokens[($stackPtr + 2)]['code'] !== T_STRING
Chris@0:             || isset($tokens[($stackPtr + 3)]) === false
Chris@0:             || $tokens[($stackPtr + 3)]['code'] !== T_OPEN_PARENTHESIS
Chris@0:             || empty($tokens[$stackPtr]['conditions']) === true
Chris@0:         ) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         // Check that this statement is not in a static function.
Chris@0:         foreach ($tokens[$stackPtr]['conditions'] as $conditionPtr => $conditionCode) {
Chris@0:             if ($conditionCode === T_FUNCTION && $phpcsFile->getMethodProperties($conditionPtr)['is_static'] === true) {
Chris@0:                 return;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         // Check if the class extends another class and get the name of the class
Chris@0:         // that is extended.
Chris@0:         $classPtr    = key($tokens[$stackPtr]['conditions']);
Chris@0:         $extendsName = $phpcsFile->findExtendedClassName($classPtr);
Chris@0: 
Chris@0:         if (($extendsName === false || in_array($extendsName, static::$baseClasses) === false)
Chris@17:             && Project::isServiceClass($phpcsFile, $classPtr) === false
Chris@0:         ) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $warning = '\Drupal calls should be avoided in classes, use dependency injection instead';
Chris@0:         $phpcsFile->addWarning($warning, $stackPtr, 'GlobalDrupal');
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class