| 1 |
lars |
1 |
<?php
|
|
|
2 |
/**
|
|
|
3 |
* Squiz_Sniffs_Classes_ValidClassNameSniff.
|
|
|
4 |
*
|
|
|
5 |
* PHP version 5
|
|
|
6 |
*
|
|
|
7 |
* @category PHP
|
|
|
8 |
* @package PHP_CodeSniffer
|
|
|
9 |
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
|
10 |
* @author Marc McIntyre <mmcintyre@squiz.net>
|
|
|
11 |
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
|
12 |
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
|
|
13 |
* @version CVS: $Id: ValidClassNameSniff.php 259960 2008-05-19 05:59:25Z squiz $
|
|
|
14 |
* @link http://pear.php.net/package/PHP_CodeSniffer
|
|
|
15 |
*/
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* Squiz_Sniffs_Classes_ValidClassNameSniff.
|
|
|
19 |
*
|
|
|
20 |
* Ensures classes are in camel caps, and the first letter is capitalised
|
|
|
21 |
*
|
|
|
22 |
* @category PHP
|
|
|
23 |
* @package PHP_CodeSniffer
|
|
|
24 |
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
|
25 |
* @author Marc McIntyre <mmcintyre@squiz.net>
|
|
|
26 |
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
|
27 |
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
|
|
28 |
* @version Release: 1.2.1
|
|
|
29 |
* @link http://pear.php.net/package/PHP_CodeSniffer
|
|
|
30 |
*/
|
|
|
31 |
class Squiz_Sniffs_Classes_ValidClassNameSniff implements PHP_CodeSniffer_Sniff
|
|
|
32 |
{
|
|
|
33 |
|
|
|
34 |
|
|
|
35 |
/**
|
|
|
36 |
* Returns an array of tokens this test wants to listen for.
|
|
|
37 |
*
|
|
|
38 |
* @return array
|
|
|
39 |
*/
|
|
|
40 |
public function register()
|
|
|
41 |
{
|
|
|
42 |
return array(
|
|
|
43 |
T_CLASS,
|
|
|
44 |
T_INTERFACE,
|
|
|
45 |
);
|
|
|
46 |
|
|
|
47 |
}//end register()
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Processes this test, when one of its tokens is encountered.
|
|
|
52 |
*
|
|
|
53 |
* @param PHP_CodeSniffer_File $phpcsFile The current file being processed.
|
|
|
54 |
* @param int $stackPtr The position of the current token in the
|
|
|
55 |
* stack passed in $tokens.
|
|
|
56 |
*
|
|
|
57 |
* @return void
|
|
|
58 |
*/
|
|
|
59 |
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
|
|
60 |
{
|
|
|
61 |
$tokens = $phpcsFile->getTokens();
|
|
|
62 |
|
|
|
63 |
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
|
|
64 |
$error = 'Possible parse error: ';
|
|
|
65 |
$error .= $tokens[$stackPtr]['content'];
|
|
|
66 |
$error .= ' missing opening or closing brace';
|
|
|
67 |
$phpcsFile->addWarning($error, $stackPtr);
|
|
|
68 |
return;
|
|
|
69 |
}
|
|
|
70 |
|
|
|
71 |
// Determine the name of the class or interface. Note that we cannot
|
|
|
72 |
// simply look for the first T_STRING because a class name
|
|
|
73 |
// starting with the number will be multiple tokens.
|
|
|
74 |
$opener = $tokens[$stackPtr]['scope_opener'];
|
|
|
75 |
$nameStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), $opener, true);
|
|
|
76 |
$nameEnd = $phpcsFile->findNext(T_WHITESPACE, $nameStart, $opener);
|
|
|
77 |
$name = trim($phpcsFile->getTokensAsString($nameStart, ($nameEnd - $nameStart)));
|
|
|
78 |
|
|
|
79 |
// Check for camel caps format.
|
|
|
80 |
$valid = PHP_CodeSniffer::isCamelCaps($name, true, true, false);
|
|
|
81 |
if ($valid === false) {
|
|
|
82 |
$type = ucfirst($tokens[$stackPtr]['content']);
|
|
|
83 |
$error = "$type name \"$name\" is not in camel caps format";
|
|
|
84 |
$phpcsFile->addError($error, $stackPtr);
|
|
|
85 |
}
|
|
|
86 |
|
|
|
87 |
}//end process()
|
|
|
88 |
|
|
|
89 |
|
|
|
90 |
}//end class
|
|
|
91 |
|
|
|
92 |
|
|
|
93 |
?>
|