13969897705

Committed 20 Mar 2025 12:59PM UTC coverage: 78.707% (+0.2%) from 78.556%

Build # 13969897705

Build Type

Pull #848

github

Committed by

web-flow

Commit Message

Merge 3e6fe4510 into fa32635a4

Pull Request Pull Request #848: [Docs] Add XML doc for Squiz.Commenting.BlockComment sniff

Run Details

24844 of 31565 relevant lines covered (78.71%)

66.34 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.41

/src/Standards/Squiz/Sniffs/Classes/ClassDeclarationSniff.php

<?php
/**
 * Checks the declaration of the class and its inheritance is correct.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */

namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff as PSR2ClassDeclarationSniff;
use PHP_CodeSniffer\Util\Tokens;

class ClassDeclarationSniff extends PSR2ClassDeclarationSniff
{


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        // We want all the errors from the PSR2 standard, plus some of our own.
        parent::process($phpcsFile, $stackPtr);

        // Check that this is the only class or interface in the file.
        $nextClass = $phpcsFile->findNext([T_CLASS, T_INTERFACE], ($stackPtr + 1));
        if ($nextClass !== false) {
            // We have another, so an error is thrown.
            $error = 'Only one interface or class is allowed in a file';
            $phpcsFile->addError($error, $nextClass, 'MultipleClasses');
        }

    }//end process()


    /**
     * Processes the opening section of a class declaration.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return void
     */
    public function processOpen(File $phpcsFile, $stackPtr)
    {
        parent::processOpen($phpcsFile, $stackPtr);

        $tokens = $phpcsFile->getTokens();

        if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {
            $prevContent = $tokens[($stackPtr - 1)]['content'];
            if ($prevContent !== $phpcsFile->eolChar) {
                $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
                $spaces     = strlen($blankSpace);

                if ($tokens[($stackPtr - 2)]['code'] !== T_ABSTRACT
                    && $tokens[($stackPtr - 2)]['code'] !== T_FINAL
                    && $tokens[($stackPtr - 2)]['code'] !== T_READONLY
                ) {
                    if ($spaces !== 0) {
                        $type  = strtolower($tokens[$stackPtr]['content']);
                        $error = 'Expected 0 spaces before %s keyword; %s found';
                        $data  = [
                            $type,
                            $spaces,
                        ];

                        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeKeyword', $data);
                        if ($fix === true) {
                            $phpcsFile->fixer->replaceToken(($stackPtr - 1), '');
                        }
                    }
                }
            }//end if
        }//end if

    }//end processOpen()


    /**
     * Processes the closing section of a class declaration.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return void
     */
    public function processClose(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        if (isset($tokens[$stackPtr]['scope_closer']) === false) {
            return;
        }

        $closeBrace = $tokens[$stackPtr]['scope_closer'];

        // Check that the closing brace has one blank line after it.
        for ($nextContent = ($closeBrace + 1); $nextContent < $phpcsFile->numTokens; $nextContent++) {
            // Ignore comments on the same line as the brace.
            if ($tokens[$nextContent]['line'] === $tokens[$closeBrace]['line']
                && ($tokens[$nextContent]['code'] === T_WHITESPACE
                || $tokens[$nextContent]['code'] === T_COMMENT
                || isset(Tokens::$phpcsCommentTokens[$tokens[$nextContent]['code']]) === true)
            ) {
                continue;
            }

            if ($tokens[$nextContent]['code'] !== T_WHITESPACE) {
                break;
            }
        }

        if ($nextContent === $phpcsFile->numTokens) {
            // Ignore the line check as this is the very end of the file.
            $difference = 1;
        } else {
            $difference = ($tokens[$nextContent]['line'] - $tokens[$closeBrace]['line'] - 1);
        }

        $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBrace - 1), $stackPtr, true);

        if ($difference === -1
            || $tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']
        ) {
            $error = 'Closing %s brace must be on a line by itself';
            $data  = [$tokens[$stackPtr]['content']];
            $fix   = $phpcsFile->addFixableError($error, $closeBrace, 'CloseBraceSameLine', $data);
            if ($fix === true) {
                if ($difference === -1) {
                    $phpcsFile->fixer->addNewlineBefore($nextContent);
                }

                if ($tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']) {
                    $phpcsFile->fixer->addNewlineBefore($closeBrace);
                }
            }
        } else if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) {
            $prevContent = $tokens[($closeBrace - 1)]['content'];
            if ($prevContent !== $phpcsFile->eolChar) {
                $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
                $spaces     = strlen($blankSpace);
                if ($spaces !== 0) {
                    if ($tokens[($closeBrace - 1)]['line'] !== $tokens[$closeBrace]['line']) {
                        $error = 'Expected 0 spaces before closing brace; newline found';
                        $phpcsFile->addError($error, $closeBrace, 'NewLineBeforeCloseBrace');
                    } else {
                        $error = 'Expected 0 spaces before closing brace; %s found';
                        $data  = [$spaces];
                        $fix   = $phpcsFile->addFixableError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data);
                        if ($fix === true) {
                            $phpcsFile->fixer->replaceToken(($closeBrace - 1), '');
                        }
                    }
                }
            }
        }//end if

        if ($difference !== -1 && $difference !== 1) {
            for ($nextSignificant = $nextContent; $nextSignificant < $phpcsFile->numTokens; $nextSignificant++) {
                if ($tokens[$nextSignificant]['code'] === T_WHITESPACE) {
                    continue;
                }

                if ($tokens[$nextSignificant]['code'] === T_DOC_COMMENT_OPEN_TAG) {
                    $nextSignificant = $tokens[$nextSignificant]['comment_closer'];
                    continue;
                }

                if ($tokens[$nextSignificant]['code'] === T_ATTRIBUTE
                    && isset($tokens[$nextSignificant]['attribute_closer']) === true
                ) {
                    $nextSignificant = $tokens[$nextSignificant]['attribute_closer'];
                    continue;
                }

                break;
            }

            if ($tokens[$nextSignificant]['code'] === T_FUNCTION) {
                return;
            }

            $error = 'Closing brace of a %s must be followed by a single blank line; found %s';
            $data  = [
                $tokens[$stackPtr]['content'],
                $difference,
            ];
            $fix   = $phpcsFile->addFixableError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data);
            if ($fix === true) {
                if ($difference === 0) {
                    $first = $phpcsFile->findFirstOnLine([], $nextContent, true);
                    $phpcsFile->fixer->addNewlineBefore($first);
                } else {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = ($closeBrace + 1); $i < $nextContent; $i++) {
                        if ($tokens[$i]['line'] <= ($tokens[$closeBrace]['line'] + 1)) {
                            continue;
                        } else if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) {
                            break;
                        }

                        $phpcsFile->fixer->replaceToken($i, '');
                    }

                    $phpcsFile->fixer->endChangeset();
                }
            }
        }//end if

    }//end processClose()


}//end class

1	<?php
2	/**
3	* Checks the declaration of the class and its inheritance is correct.
4	*
5	* @author Greg Sherwood <gsherwood@squiz.net>
6	* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
7	* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
8	*/
9
10	namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes;
11
12	use PHP_CodeSniffer\Files\File;
13	use PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff as PSR2ClassDeclarationSniff;
14	use PHP_CodeSniffer\Util\Tokens;
15
16	class ClassDeclarationSniff extends PSR2ClassDeclarationSniff
17	{
18
19
20	/**
21	* Processes this test, when one of its tokens is encountered.
22	*
23	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
24	* @param int $stackPtr The position of the current token
25	* in the stack passed in $tokens.
26	*
27	* @return void
28	*/
29	public function process(File $phpcsFile, $stackPtr)	3✔
30	{
31	// We want all the errors from the PSR2 standard, plus some of our own.
32	parent::process($phpcsFile, $stackPtr);	3✔
33
34	// Check that this is the only class or interface in the file.
35	$nextClass = $phpcsFile->findNext([T_CLASS, T_INTERFACE], ($stackPtr + 1));	3✔
36	if ($nextClass !== false) {	3✔
37	// We have another, so an error is thrown.
38	$error = 'Only one interface or class is allowed in a file';	3✔
39	$phpcsFile->addError($error, $nextClass, 'MultipleClasses');	3✔
40	}	1✔
41
42	}//end process()	2✔
43
44
45	/**
46	* Processes the opening section of a class declaration.
47	*
48	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
49	* @param int $stackPtr The position of the current token
50	* in the stack passed in $tokens.
51	*
52	* @return void
53	*/
54	public function processOpen(File $phpcsFile, $stackPtr)	3✔
55	{
56	parent::processOpen($phpcsFile, $stackPtr);	3✔
57
58	$tokens = $phpcsFile->getTokens();	3✔
59
60	if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {	3✔
61	$prevContent = $tokens[($stackPtr - 1)]['content'];	3✔
62	if ($prevContent !== $phpcsFile->eolChar) {	3✔
63	$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));	3✔
64	$spaces = strlen($blankSpace);	3✔
65
66	if ($tokens[($stackPtr - 2)]['code'] !== T_ABSTRACT	3✔
67	&& $tokens[($stackPtr - 2)]['code'] !== T_FINAL	3✔
68	&& $tokens[($stackPtr - 2)]['code'] !== T_READONLY	3✔
69	) {	1✔
70	if ($spaces !== 0) {	3✔
71	$type = strtolower($tokens[$stackPtr]['content']);	3✔
72	$error = 'Expected 0 spaces before %s keyword; %s found';	3✔
73	$data = [	1✔
74	$type,	3✔
75	$spaces,	3✔
76	];	2✔
77
78	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeKeyword', $data);	3✔
79	if ($fix === true) {	3✔
80	$phpcsFile->fixer->replaceToken(($stackPtr - 1), '');	3✔
81	}	1✔
82	}	1✔
83	}	1✔
84	}//end if	1✔
85	}//end if	1✔
86
87	}//end processOpen()	2✔
88
89
90	/**
91	* Processes the closing section of a class declaration.
92	*
93	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
94	* @param int $stackPtr The position of the current token
95	* in the stack passed in $tokens.
96	*
97	* @return void
98	*/
99	public function processClose(File $phpcsFile, $stackPtr)	3✔
100	{
101	$tokens = $phpcsFile->getTokens();	3✔
102	if (isset($tokens[$stackPtr]['scope_closer']) === false) {	3✔
103	return;	×
104	}
105
106	$closeBrace = $tokens[$stackPtr]['scope_closer'];	3✔
107
108	// Check that the closing brace has one blank line after it.
109	for ($nextContent = ($closeBrace + 1); $nextContent < $phpcsFile->numTokens; $nextContent++) {	3✔
110	// Ignore comments on the same line as the brace.
111	if ($tokens[$nextContent]['line'] === $tokens[$closeBrace]['line']	3✔
112	&& ($tokens[$nextContent]['code'] === T_WHITESPACE	3✔
113	\|\| $tokens[$nextContent]['code'] === T_COMMENT	3✔
114	\|\| isset(Tokens::$phpcsCommentTokens[$tokens[$nextContent]['code']]) === true)	3✔
115	) {	1✔
116	continue;	3✔
117	}
118
119	if ($tokens[$nextContent]['code'] !== T_WHITESPACE) {	3✔
120	break;	3✔
121	}
122	}	1✔
123
124	if ($nextContent === $phpcsFile->numTokens) {	3✔
125	// Ignore the line check as this is the very end of the file.
126	$difference = 1;	×
127	} else {
128	$difference = ($tokens[$nextContent]['line'] - $tokens[$closeBrace]['line'] - 1);	3✔
129	}
130
131	$lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBrace - 1), $stackPtr, true);	3✔
132
133	if ($difference === -1	2✔
134	\|\| $tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']	3✔
135	) {	1✔
136	$error = 'Closing %s brace must be on a line by itself';	3✔
137	$data = [$tokens[$stackPtr]['content']];	3✔
138	$fix = $phpcsFile->addFixableError($error, $closeBrace, 'CloseBraceSameLine', $data);	3✔
139	if ($fix === true) {	3✔
140	if ($difference === -1) {	3✔
141	$phpcsFile->fixer->addNewlineBefore($nextContent);	3✔
142	}	1✔
143
144	if ($tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']) {	3✔
145	$phpcsFile->fixer->addNewlineBefore($closeBrace);	3✔
146	}	1✔
147	}	1✔
148	} else if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) {	3✔
149	$prevContent = $tokens[($closeBrace - 1)]['content'];	3✔
150	if ($prevContent !== $phpcsFile->eolChar) {	3✔
151	$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));	3✔
152	$spaces = strlen($blankSpace);	3✔
153	if ($spaces !== 0) {	3✔
154	if ($tokens[($closeBrace - 1)]['line'] !== $tokens[$closeBrace]['line']) {	3✔
155	$error = 'Expected 0 spaces before closing brace; newline found';	3✔
156	$phpcsFile->addError($error, $closeBrace, 'NewLineBeforeCloseBrace');	3✔
157	} else {	1✔
158	$error = 'Expected 0 spaces before closing brace; %s found';	3✔
159	$data = [$spaces];	3✔
160	$fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data);	3✔
161	if ($fix === true) {	3✔
162	$phpcsFile->fixer->replaceToken(($closeBrace - 1), '');	3✔
163	}	1✔
164	}
165	}	1✔
166	}	1✔
167	}//end if	1✔
168
169	if ($difference !== -1 && $difference !== 1) {	3✔
170	for ($nextSignificant = $nextContent; $nextSignificant < $phpcsFile->numTokens; $nextSignificant++) {	3✔
171	if ($tokens[$nextSignificant]['code'] === T_WHITESPACE) {	3✔
172	continue;	3✔
173	}
174
175	if ($tokens[$nextSignificant]['code'] === T_DOC_COMMENT_OPEN_TAG) {	3✔
176	$nextSignificant = $tokens[$nextSignificant]['comment_closer'];	3✔
177	continue;	3✔
178	}
179
180	if ($tokens[$nextSignificant]['code'] === T_ATTRIBUTE	3✔
181	&& isset($tokens[$nextSignificant]['attribute_closer']) === true	3✔
182	) {	1✔
183	$nextSignificant = $tokens[$nextSignificant]['attribute_closer'];	3✔
184	continue;	3✔
185	}
186
187	break;	3✔
188	}
189
190	if ($tokens[$nextSignificant]['code'] === T_FUNCTION) {	3✔
191	return;	3✔
192	}
193
194	$error = 'Closing brace of a %s must be followed by a single blank line; found %s';	3✔
195	$data = [	1✔
196	$tokens[$stackPtr]['content'],	3✔
197	$difference,	3✔
198	];	2✔
199	$fix = $phpcsFile->addFixableError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data);	3✔
200	if ($fix === true) {	3✔
201	if ($difference === 0) {	3✔
202	$first = $phpcsFile->findFirstOnLine([], $nextContent, true);	3✔
203	$phpcsFile->fixer->addNewlineBefore($first);	3✔
204	} else {	1✔
205	$phpcsFile->fixer->beginChangeset();	3✔
206	for ($i = ($closeBrace + 1); $i < $nextContent; $i++) {	3✔
207	if ($tokens[$i]['line'] <= ($tokens[$closeBrace]['line'] + 1)) {	3✔
208	continue;	3✔
209	} else if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) {	3✔
210	break;	3✔
211	}
212
213	$phpcsFile->fixer->replaceToken($i, '');	3✔
214	}	1✔
215
216	$phpcsFile->fixer->endChangeset();	3✔
217	}
218	}	1✔
219	}//end if	1✔
220
221	}//end processClose()	2✔
222
223
224	}//end class

PHPCSStandards / PHP_CodeSniffer / 13969897705

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous