Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@0
|
3 * Parses and verifies the class doc comment.
|
Chris@0
|
4 *
|
Chris@0
|
5 * @category PHP
|
Chris@0
|
6 * @package PHP_CodeSniffer
|
Chris@0
|
7 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@17
|
10 namespace Drupal\Sniffs\Commenting;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Checks that comment doc blocks exist on classes, interfaces and traits. Largely
|
Chris@17
|
18 * copied from PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\ClassCommentSniff.
|
Chris@0
|
19 *
|
Chris@0
|
20 * @category PHP
|
Chris@0
|
21 * @package PHP_CodeSniffer
|
Chris@0
|
22 * @author Greg Sherwood <gsherwood@squiz.net>
|
Chris@0
|
23 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
|
Chris@0
|
24 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
|
Chris@0
|
25 * @version Release: @package_version@
|
Chris@0
|
26 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
27 */
|
Chris@17
|
28 class ClassCommentSniff implements Sniff
|
Chris@0
|
29 {
|
Chris@0
|
30
|
Chris@0
|
31
|
Chris@0
|
32 /**
|
Chris@0
|
33 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
34 *
|
Chris@0
|
35 * @return array
|
Chris@0
|
36 */
|
Chris@0
|
37 public function register()
|
Chris@0
|
38 {
|
Chris@0
|
39 return array(
|
Chris@0
|
40 T_CLASS,
|
Chris@0
|
41 T_INTERFACE,
|
Chris@0
|
42 T_TRAIT,
|
Chris@0
|
43 );
|
Chris@0
|
44
|
Chris@0
|
45 }//end register()
|
Chris@0
|
46
|
Chris@0
|
47
|
Chris@0
|
48 /**
|
Chris@0
|
49 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
50 *
|
Chris@17
|
51 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
52 * @param int $stackPtr The position of the current token
|
Chris@17
|
53 * in the stack passed in $tokens.
|
Chris@0
|
54 *
|
Chris@0
|
55 * @return void
|
Chris@0
|
56 */
|
Chris@17
|
57 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
58 {
|
Chris@0
|
59 $tokens = $phpcsFile->getTokens();
|
Chris@17
|
60 $find = Tokens::$methodPrefixes;
|
Chris@0
|
61 $find[] = T_WHITESPACE;
|
Chris@0
|
62 $name = $tokens[$stackPtr]['content'];
|
Chris@0
|
63
|
Chris@0
|
64 $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
|
Chris@0
|
65 if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
|
Chris@0
|
66 && $tokens[$commentEnd]['code'] !== T_COMMENT
|
Chris@0
|
67 ) {
|
Chris@0
|
68 $fix = $phpcsFile->addFixableError('Missing %s doc comment', $stackPtr, 'Missing', array($name));
|
Chris@0
|
69 if ($fix === true) {
|
Chris@0
|
70 $phpcsFile->fixer->addContent($commentEnd, "\n/**\n *\n */");
|
Chris@0
|
71 }
|
Chris@0
|
72
|
Chris@0
|
73 return;
|
Chris@0
|
74 }
|
Chris@0
|
75
|
Chris@0
|
76 // Try and determine if this is a file comment instead of a class comment.
|
Chris@0
|
77 if ($tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
|
Chris@0
|
78 $start = ($tokens[$commentEnd]['comment_opener'] - 1);
|
Chris@0
|
79 } else {
|
Chris@0
|
80 $start = ($commentEnd - 1);
|
Chris@0
|
81 }
|
Chris@0
|
82
|
Chris@0
|
83 $fileTag = $phpcsFile->findNext(T_DOC_COMMENT_TAG, ($start + 1), $commentEnd, false, '@file');
|
Chris@0
|
84 if ($fileTag !== false) {
|
Chris@0
|
85 // This is a file comment.
|
Chris@0
|
86 $fix = $phpcsFile->addFixableError('Missing %s doc comment', $stackPtr, 'Missing', array($name));
|
Chris@0
|
87 if ($fix === true) {
|
Chris@0
|
88 $phpcsFile->fixer->addContent($commentEnd, "\n/**\n *\n */");
|
Chris@0
|
89 }
|
Chris@0
|
90
|
Chris@0
|
91 return;
|
Chris@0
|
92 }
|
Chris@0
|
93
|
Chris@0
|
94 if ($tokens[$commentEnd]['code'] === T_COMMENT) {
|
Chris@0
|
95 $fix = $phpcsFile->addFixableError('You must use "/**" style comments for a %s comment', $stackPtr, 'WrongStyle', array($name));
|
Chris@0
|
96 if ($fix === true) {
|
Chris@0
|
97 // Convert the comment into a doc comment.
|
Chris@0
|
98 $phpcsFile->fixer->beginChangeset();
|
Chris@0
|
99 $comment = '';
|
Chris@0
|
100 for ($i = $commentEnd; $tokens[$i]['code'] === T_COMMENT; $i--) {
|
Chris@0
|
101 $comment = ' *'.ltrim($tokens[$i]['content'], '/* ').$comment;
|
Chris@0
|
102 $phpcsFile->fixer->replaceToken($i, '');
|
Chris@0
|
103 }
|
Chris@0
|
104
|
Chris@0
|
105 $phpcsFile->fixer->replaceToken($commentEnd, "/**\n".rtrim($comment, "*/\n")."\n */");
|
Chris@0
|
106 $phpcsFile->fixer->endChangeset();
|
Chris@0
|
107 }
|
Chris@0
|
108
|
Chris@0
|
109 return;
|
Chris@0
|
110 }
|
Chris@0
|
111
|
Chris@0
|
112 if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
|
Chris@0
|
113 $error = 'There must be exactly one newline after the %s comment';
|
Chris@0
|
114 $fix = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter', array($name));
|
Chris@0
|
115 if ($fix === true) {
|
Chris@0
|
116 $phpcsFile->fixer->beginChangeset();
|
Chris@0
|
117 for ($i = ($commentEnd + 1); $tokens[$i]['code'] === T_WHITESPACE && $i < $stackPtr; $i++) {
|
Chris@0
|
118 $phpcsFile->fixer->replaceToken($i, '');
|
Chris@0
|
119 }
|
Chris@0
|
120
|
Chris@0
|
121 $phpcsFile->fixer->addContent($commentEnd, "\n");
|
Chris@0
|
122 $phpcsFile->fixer->endChangeset();
|
Chris@0
|
123 }
|
Chris@0
|
124 }
|
Chris@0
|
125
|
Chris@0
|
126 }//end process()
|
Chris@0
|
127
|
Chris@0
|
128
|
Chris@0
|
129 }//end class
|