17663621563

Committed 12 Sep 2025 03:25AM UTC coverage: 78.786%. Remained the same

Build # 17663621563

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1243 from PHPCSStandards/phpcs-4.x/feature/155-normalize-some-code-style-rules-5

CS: normalize code style rules [5]

Coverage Stats

294 of 308 new or added lines in 191 files covered. (95.45%)

2354 existing lines in 130 files now uncovered.

19732 of 25045 relevant lines covered (78.79%)

96.47 hits per line

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

98.61

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

<?php
/**
 * Checks the declaration of the class 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\PEAR\Sniffs\Classes;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

class ClassDeclarationSniff implements Sniff
{


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register()
    {
        return [
            T_CLASS,
            T_INTERFACE,
            T_TRAIT,
            T_ENUM,
        ];
    }


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param integer                     $stackPtr  The position of the current token in the
     *                                               stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, int $stackPtr)
    {
        $tokens    = $phpcsFile->getTokens();
        $errorData = [strtolower($tokens[$stackPtr]['content'])];

        if (isset($tokens[$stackPtr]['scope_opener']) === false) {
            // Parse error or live coding.
            return;
        }

        $curlyBrace  = $tokens[$stackPtr]['scope_opener'];
        $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($curlyBrace - 1), $stackPtr, true);
        $classLine   = $tokens[$lastContent]['line'];
        $braceLine   = $tokens[$curlyBrace]['line'];
        if ($braceLine === $classLine) {
            $phpcsFile->recordMetric($stackPtr, 'Class opening brace placement', 'same line');
            $error = 'Opening brace of a %s must be on the line after the definition';
            $fix   = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceNewLine', $errorData);
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();
                if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) {
                    $phpcsFile->fixer->replaceToken(($curlyBrace - 1), '');
                }

                $phpcsFile->fixer->addNewlineBefore($curlyBrace);
                $phpcsFile->fixer->endChangeset();
            }

            return;
        } else {
            $phpcsFile->recordMetric($stackPtr, 'Class opening brace placement', 'new line');

            if ($braceLine > ($classLine + 1)) {
                $error = 'Opening brace of a %s must be on the line following the %s declaration; found %s line(s)';
                $data  = [
                    $tokens[$stackPtr]['content'],
                    $tokens[$stackPtr]['content'],
                    ($braceLine - $classLine - 1),
                ];
                $fix   = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceWrongLine', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = ($curlyBrace - 1); $i > $lastContent; $i--) {
                        if ($tokens[$i]['line'] === ($tokens[$curlyBrace]['line'] + 1)) {
                            break;
                        }

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

                    $phpcsFile->fixer->endChangeset();
                }

                return;
            }//end if
        }//end if

        if ($tokens[($curlyBrace + 1)]['content'] !== $phpcsFile->eolChar) {
            $error = 'Opening %s brace must be on a line by itself';

            $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($curlyBrace + 1), null, true);
            if ($tokens[$nextNonWhitespace]['code'] === T_PHPCS_IGNORE) {
                // Don't auto-fix if the next thing is a PHPCS ignore annotation.
                $phpcsFile->addError($error, $curlyBrace, 'OpenBraceNotAlone', $errorData);
            } else {
                $fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceNotAlone', $errorData);
                if ($fix === true) {
                    $phpcsFile->fixer->addNewline($curlyBrace);
                }
            }
        }

        if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) {
            $prevContent = $tokens[($curlyBrace - 1)]['content'];
            if ($prevContent === $phpcsFile->eolChar) {
                $spaces = 0;
            } else {
                $spaces = $tokens[($curlyBrace - 1)]['length'];
            }

            $first    = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true);
            $expected = ($tokens[$first]['column'] - 1);
            if ($spaces !== $expected) {
                $error = 'Expected %s spaces before opening brace; %s found';
                $data  = [
                    $expected,
                    $spaces,
                ];

                $fix = $phpcsFile->addFixableError($error, $curlyBrace, 'SpaceBeforeBrace', $data);
                if ($fix === true) {
                    $indent = str_repeat(' ', $expected);
                    if ($spaces === 0) {
                        $phpcsFile->fixer->addContentBefore($curlyBrace, $indent);
                    } else {
                        $phpcsFile->fixer->replaceToken(($curlyBrace - 1), $indent);
                    }
                }
            }
        }//end if
    }
}

1	<?php
2	/**
3	* Checks the declaration of the class 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\PEAR\Sniffs\Classes;
11
12	use PHP_CodeSniffer\Files\File;
13	use PHP_CodeSniffer\Sniffs\Sniff;
14
15	class ClassDeclarationSniff implements Sniff
16	{
17
18
19	/**
20	* Returns an array of tokens this test wants to listen for.
21	*
22	* @return array<int\|string>
23	*/
24	public function register()	3✔
25	{
26	return [	2✔
27	T_CLASS,	3✔
28	T_INTERFACE,	3✔
29	T_TRAIT,	3✔
30	T_ENUM,	3✔
31	];	2✔
32	}
33
34
35	/**
36	* Processes this test, when one of its tokens is encountered.
37	*
38	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
39	* @param integer $stackPtr The position of the current token in the
40	* stack passed in $tokens.
41	*
42	* @return void
43	*/
44	public function process(File $phpcsFile, int $stackPtr)	3✔
45	{
46	$tokens = $phpcsFile->getTokens();	3✔
47	$errorData = [strtolower($tokens[$stackPtr]['content'])];	3✔
48
49	if (isset($tokens[$stackPtr]['scope_opener']) === false) {	3✔
50	// Parse error or live coding.
51	return;	3✔
52	}
53
54	$curlyBrace = $tokens[$stackPtr]['scope_opener'];	3✔
55	$lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($curlyBrace - 1), $stackPtr, true);	3✔
56	$classLine = $tokens[$lastContent]['line'];	3✔
57	$braceLine = $tokens[$curlyBrace]['line'];	3✔
58	if ($braceLine === $classLine) {	3✔
59	$phpcsFile->recordMetric($stackPtr, 'Class opening brace placement', 'same line');	3✔
60	$error = 'Opening brace of a %s must be on the line after the definition';	3✔
61	$fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceNewLine', $errorData);	3✔
62	if ($fix === true) {	3✔
63	$phpcsFile->fixer->beginChangeset();	3✔
64	if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) {	3✔
65	$phpcsFile->fixer->replaceToken(($curlyBrace - 1), '');	3✔
66	}
67
68	$phpcsFile->fixer->addNewlineBefore($curlyBrace);	3✔
69	$phpcsFile->fixer->endChangeset();	3✔
70	}
71
72	return;	3✔
73	} else {
74	$phpcsFile->recordMetric($stackPtr, 'Class opening brace placement', 'new line');	3✔
75
76	if ($braceLine > ($classLine + 1)) {	3✔
77	$error = 'Opening brace of a %s must be on the line following the %s declaration; found %s line(s)';	3✔
78	$data = [	2✔
79	$tokens[$stackPtr]['content'],	3✔
80	$tokens[$stackPtr]['content'],	3✔
81	($braceLine - $classLine - 1),	3✔
82	];	2✔
83	$fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceWrongLine', $data);	3✔
84	if ($fix === true) {	3✔
85	$phpcsFile->fixer->beginChangeset();	3✔
86	for ($i = ($curlyBrace - 1); $i > $lastContent; $i--) {	3✔
87	if ($tokens[$i]['line'] === ($tokens[$curlyBrace]['line'] + 1)) {	3✔
UNCOV 88	break;	×
89	}
90
91	$phpcsFile->fixer->replaceToken($i, '');	3✔
92	}
93
94	$phpcsFile->fixer->endChangeset();	3✔
95	}
96
97	return;	3✔
98	}//end if
99	}//end if
100
101	if ($tokens[($curlyBrace + 1)]['content'] !== $phpcsFile->eolChar) {	3✔
102	$error = 'Opening %s brace must be on a line by itself';	3✔
103
104	$nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($curlyBrace + 1), null, true);	3✔
105	if ($tokens[$nextNonWhitespace]['code'] === T_PHPCS_IGNORE) {	3✔
106	// Don't auto-fix if the next thing is a PHPCS ignore annotation.
107	$phpcsFile->addError($error, $curlyBrace, 'OpenBraceNotAlone', $errorData);	3✔
108	} else {
109	$fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceNotAlone', $errorData);	3✔
110	if ($fix === true) {	3✔
111	$phpcsFile->fixer->addNewline($curlyBrace);	3✔
112	}
113	}
114	}
115
116	if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) {	3✔
117	$prevContent = $tokens[($curlyBrace - 1)]['content'];	3✔
118	if ($prevContent === $phpcsFile->eolChar) {	3✔
119	$spaces = 0;	3✔
120	} else {
121	$spaces = $tokens[($curlyBrace - 1)]['length'];	3✔
122	}
123
124	$first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true);	3✔
125	$expected = ($tokens[$first]['column'] - 1);	3✔
126	if ($spaces !== $expected) {	3✔
127	$error = 'Expected %s spaces before opening brace; %s found';	3✔
128	$data = [	2✔
129	$expected,	3✔
130	$spaces,	3✔
131	];	2✔
132
133	$fix = $phpcsFile->addFixableError($error, $curlyBrace, 'SpaceBeforeBrace', $data);	3✔
134	if ($fix === true) {	3✔
135	$indent = str_repeat(' ', $expected);	3✔
136	if ($spaces === 0) {	3✔
137	$phpcsFile->fixer->addContentBefore($curlyBrace, $indent);	3✔
138	} else {
139	$phpcsFile->fixer->replaceToken(($curlyBrace - 1), $indent);	3✔
140	}
141	}
142	}
143	}//end if
144	}	1✔
145	}

PHPCSStandards / PHP_CodeSniffer / 17663621563

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