Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\General\ClassNameSniff
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\General;
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 classes without namespaces are properly prefixed with the module
Chris@0:  * name.
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 ClassNameSniff implements Sniff
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(
Chris@0:                 T_CLASS,
Chris@0:                 T_INTERFACE,
Chris@0:                );
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 function
Chris@17:      *                                               name in the stack.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         // If there is a PHP 5.3 namespace declaration in the file we return
Chris@0:         // immediately as classes can be named arbitrary within a namespace.
Chris@0:         $namespace = $phpcsFile->findPrevious(T_NAMESPACE, ($stackPtr - 1));
Chris@0:         if ($namespace !== false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@17:         $moduleName = Project::getName($phpcsFile);
Chris@0:         if ($moduleName === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $className = $phpcsFile->findNext(T_STRING, $stackPtr);
Chris@0:         $name      = trim($tokens[$className]['content']);
Chris@0: 
Chris@0:         // Underscores are omitted in class names. Also convert all characters
Chris@0:         // to lower case to compare them later.
Chris@0:         $classPrefix = strtolower(str_replace('_', '', $moduleName));
Chris@0:         // Views classes might have underscores in the name, which is also fine.
Chris@0:         $viewsPrefix = strtolower($moduleName);
Chris@0:         $name        = strtolower($name);
Chris@0: 
Chris@0:         if (strpos($name, $classPrefix) !== 0 && strpos($name, $viewsPrefix) !== 0) {
Chris@0:             $warning   = '%s name must be prefixed with the project name "%s"';
Chris@0:             $nameParts = explode('_', $moduleName);
Chris@0:             $camelName = '';
Chris@0:             foreach ($nameParts as &$part) {
Chris@0:                 $camelName .= ucfirst($part);
Chris@0:             }
Chris@0: 
Chris@0:             $errorData = array(
Chris@0:                           ucfirst($tokens[$stackPtr]['content']),
Chris@0:                           $camelName,
Chris@0:                          );
Chris@0:             $phpcsFile->addWarning($warning, $className, 'ClassPrefix', $errorData);
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class