Chris@0: <?php
Chris@0: /**
Chris@0:  * Verifies that class/interface/trait methods have scope modifiers.
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 Drupal\Sniffs\Scope;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\AbstractScopeSniff;
Chris@17: use PHP_CodeSniffer\Util\Tokens;
Chris@17: 
Chris@0: /**
Chris@0:  * Verifies that class/interface/trait methods have scope modifiers.
Chris@0:  *
Chris@17:  * Laregely copied from
Chris@17:  * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff to work on
Chris@17:  * traits and have a fixer.
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 MethodScopeSniff extends AbstractScopeSniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@17:      * Constructs a
Chris@17:      * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff.
Chris@0:      */
Chris@0:     public function __construct()
Chris@0:     {
Chris@0:         parent::__construct(array(T_CLASS, T_INTERFACE, T_TRAIT), array(T_FUNCTION));
Chris@0: 
Chris@0:     }//end __construct()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes the function tokens within the class.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
Chris@17:      * @param int                         $stackPtr  The position where the token was found.
Chris@17:      * @param int                         $currScope The current scope opener token.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $methodName = $phpcsFile->getDeclarationName($stackPtr);
Chris@0:         if ($methodName === null) {
Chris@0:             // Ignore closures.
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         if ($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true) {
Chris@0:             // Ignore nested functions.
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $modifier = null;
Chris@0:         for ($i = ($stackPtr - 1); $i > 0; $i--) {
Chris@0:             if ($tokens[$i]['line'] < $tokens[$stackPtr]['line']) {
Chris@0:                 break;
Chris@17:             } else if (isset(Tokens::$scopeModifiers[$tokens[$i]['code']]) === true) {
Chris@0:                 $modifier = $i;
Chris@0:                 break;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if ($modifier === null) {
Chris@0:             $error = 'Visibility must be declared on method "%s"';
Chris@0:             $data  = array($methodName);
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Missing', $data);
Chris@0: 
Chris@0:             if ($fix === true) {
Chris@0:                 // No scope modifier means the method is public in PHP, fix that
Chris@0:                 // to be explicitly public.
Chris@0:                 $phpcsFile->fixer->addContentBefore($stackPtr, 'public ');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end processTokenWithinScope()
Chris@0: 
Chris@0: 
Chris@17:     /**
Chris@17:      * Processes a token that is found outside the scope that this test is
Chris@17:      * listening to.
Chris@17:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
Chris@17:      * @param int                         $stackPtr  The position in the stack where this
Chris@17:      *                                               token was found.
Chris@17:      *
Chris@17:      * @return void
Chris@17:      */
Chris@17:     protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
Chris@17:     {
Chris@17: 
Chris@17:     }//end processTokenOutsideScope()
Chris@17: 
Chris@17: 
Chris@0: }//end class