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.36

/src/Standards/PSR2/Sniffs/ControlStructures/ControlStructureSpacingSniff.php

<?php
/**
 * Checks that control structures have the correct spacing around brackets.
 *
 * @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\PSR2\Sniffs\ControlStructures;

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

class ControlStructureSpacingSniff implements Sniff
{

    /**
     * How many spaces should follow the opening bracket.
     *
     * @var integer
     */
    public $requiredSpacesAfterOpen = 0;

    /**
     * How many spaces should precede the closing bracket.
     *
     * @var integer
     */
    public $requiredSpacesBeforeClose = 0;


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register()
    {
        return [
            T_IF,
            T_WHILE,
            T_FOREACH,
            T_FOR,
            T_SWITCH,
            T_ELSEIF,
            T_CATCH,
            T_MATCH,
        ];
    }


    /**
     * 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, int $stackPtr)
    {
        $this->requiredSpacesAfterOpen   = (int) $this->requiredSpacesAfterOpen;
        $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
        $tokens = $phpcsFile->getTokens();

        if (isset($tokens[$stackPtr]['parenthesis_opener']) === false
            || isset($tokens[$stackPtr]['parenthesis_closer']) === false
        ) {
            return;
        }

        $parenOpener = $tokens[$stackPtr]['parenthesis_opener'];
        $parenCloser = $tokens[$stackPtr]['parenthesis_closer'];
        $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($parenOpener + 1), null, true);
        if (in_array($tokens[$nextContent]['code'], Tokens::COMMENT_TOKENS, true) === false) {
            $spaceAfterOpen = 0;
            if ($tokens[($parenOpener + 1)]['code'] === T_WHITESPACE) {
                if (strpos($tokens[($parenOpener + 1)]['content'], $phpcsFile->eolChar) !== false) {
                    $spaceAfterOpen = 'newline';
                } else {
                    $spaceAfterOpen = $tokens[($parenOpener + 1)]['length'];
                }
            }

            $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', $spaceAfterOpen);

            if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
                $error = 'Expected %s spaces after opening bracket; %s found';
                $data  = [
                    $this->requiredSpacesAfterOpen,
                    $spaceAfterOpen,
                ];
                $fix   = $phpcsFile->addFixableError($error, ($parenOpener + 1), 'SpacingAfterOpenBrace', $data);
                if ($fix === true) {
                    $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
                    if ($spaceAfterOpen === 0) {
                        $phpcsFile->fixer->addContent($parenOpener, $padding);
                    } elseif ($spaceAfterOpen === 'newline') {
                        $phpcsFile->fixer->replaceToken(($parenOpener + 1), '');
                    } else {
                        $phpcsFile->fixer->replaceToken(($parenOpener + 1), $padding);
                    }
                }
            }
        }//end if

        $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($parenCloser - 1), $parenOpener, true);
        if ($tokens[$prev]['line'] === $tokens[$parenCloser]['line']) {
            $spaceBeforeClose = 0;
            if ($tokens[($parenCloser - 1)]['code'] === T_WHITESPACE) {
                $spaceBeforeClose = strlen(ltrim($tokens[($parenCloser - 1)]['content'], $phpcsFile->eolChar));
            }

            $phpcsFile->recordMetric($stackPtr, 'Spaces before control structure close parenthesis', $spaceBeforeClose);

            if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
                $error = 'Expected %s spaces before closing bracket; %s found';
                $data  = [
                    $this->requiredSpacesBeforeClose,
                    $spaceBeforeClose,
                ];
                $fix   = $phpcsFile->addFixableError($error, ($parenCloser - 1), 'SpaceBeforeCloseBrace', $data);
                if ($fix === true) {
                    $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
                    if ($spaceBeforeClose === 0) {
                        $phpcsFile->fixer->addContentBefore($parenCloser, $padding);
                    } else {
                        $phpcsFile->fixer->replaceToken(($parenCloser - 1), $padding);
                    }
                }
            }
        }//end if
    }
}

1	<?php
2	/**
3	* Checks that control structures have the correct spacing around brackets.
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\PSR2\Sniffs\ControlStructures;
11
12	use PHP_CodeSniffer\Files\File;
13	use PHP_CodeSniffer\Sniffs\Sniff;
14	use PHP_CodeSniffer\Util\Tokens;
15
16	class ControlStructureSpacingSniff implements Sniff
17	{
18
19	/**
20	* How many spaces should follow the opening bracket.
21	*
22	* @var integer
23	*/
24	public $requiredSpacesAfterOpen = 0;
25
26	/**
27	* How many spaces should precede the closing bracket.
28	*
29	* @var integer
30	*/
31	public $requiredSpacesBeforeClose = 0;
32
33
34	/**
35	* Returns an array of tokens this test wants to listen for.
36	*
37	* @return array<int\|string>
38	*/
39	public function register()	3✔
40	{
41	return [	2✔
42	T_IF,	3✔
43	T_WHILE,	3✔
44	T_FOREACH,	3✔
45	T_FOR,	3✔
46	T_SWITCH,	3✔
47	T_ELSEIF,	3✔
48	T_CATCH,	3✔
49	T_MATCH,	3✔
50	];	2✔
51	}
52
53
54	/**
55	* Processes this test, when one of its tokens is encountered.
56	*
57	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
58	* @param int $stackPtr The position of the current token
59	* in the stack passed in $tokens.
60	*
61	* @return void
62	*/
63	public function process(File $phpcsFile, int $stackPtr)	3✔
64	{
65	$this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen;	3✔
66	$this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;	3✔
67	$tokens = $phpcsFile->getTokens();	3✔
68
69	if (isset($tokens[$stackPtr]['parenthesis_opener']) === false	3✔
70	\|\| isset($tokens[$stackPtr]['parenthesis_closer']) === false	3✔
71	) {
UNCOV 72	return;	×
73	}
74
75	$parenOpener = $tokens[$stackPtr]['parenthesis_opener'];	3✔
76	$parenCloser = $tokens[$stackPtr]['parenthesis_closer'];	3✔
77	$nextContent = $phpcsFile->findNext(T_WHITESPACE, ($parenOpener + 1), null, true);	3✔
78	if (in_array($tokens[$nextContent]['code'], Tokens::COMMENT_TOKENS, true) === false) {	3✔
79	$spaceAfterOpen = 0;	3✔
80	if ($tokens[($parenOpener + 1)]['code'] === T_WHITESPACE) {	3✔
81	if (strpos($tokens[($parenOpener + 1)]['content'], $phpcsFile->eolChar) !== false) {	3✔
82	$spaceAfterOpen = 'newline';	3✔
83	} else {
84	$spaceAfterOpen = $tokens[($parenOpener + 1)]['length'];	3✔
85	}
86	}
87
88	$phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', $spaceAfterOpen);	3✔
89
90	if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {	3✔
91	$error = 'Expected %s spaces after opening bracket; %s found';	3✔
92	$data = [	2✔
93	$this->requiredSpacesAfterOpen,	3✔
94	$spaceAfterOpen,	3✔
95	];	2✔
96	$fix = $phpcsFile->addFixableError($error, ($parenOpener + 1), 'SpacingAfterOpenBrace', $data);	3✔
97	if ($fix === true) {	3✔
98	$padding = str_repeat(' ', $this->requiredSpacesAfterOpen);	3✔
99	if ($spaceAfterOpen === 0) {	3✔
100	$phpcsFile->fixer->addContent($parenOpener, $padding);	3✔
101	} elseif ($spaceAfterOpen === 'newline') {	3✔
102	$phpcsFile->fixer->replaceToken(($parenOpener + 1), '');	3✔
103	} else {
104	$phpcsFile->fixer->replaceToken(($parenOpener + 1), $padding);	3✔
105	}
106	}
107	}
108	}//end if
109
110	$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($parenCloser - 1), $parenOpener, true);	3✔
111	if ($tokens[$prev]['line'] === $tokens[$parenCloser]['line']) {	3✔
112	$spaceBeforeClose = 0;	3✔
113	if ($tokens[($parenCloser - 1)]['code'] === T_WHITESPACE) {	3✔
114	$spaceBeforeClose = strlen(ltrim($tokens[($parenCloser - 1)]['content'], $phpcsFile->eolChar));	3✔
115	}
116
117	$phpcsFile->recordMetric($stackPtr, 'Spaces before control structure close parenthesis', $spaceBeforeClose);	3✔
118
119	if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {	3✔
120	$error = 'Expected %s spaces before closing bracket; %s found';	3✔
121	$data = [	2✔
122	$this->requiredSpacesBeforeClose,	3✔
123	$spaceBeforeClose,	3✔
124	];	2✔
125	$fix = $phpcsFile->addFixableError($error, ($parenCloser - 1), 'SpaceBeforeCloseBrace', $data);	3✔
126	if ($fix === true) {	3✔
127	$padding = str_repeat(' ', $this->requiredSpacesBeforeClose);	3✔
128	if ($spaceBeforeClose === 0) {	3✔
129	$phpcsFile->fixer->addContentBefore($parenCloser, $padding);	3✔
130	} else {
131	$phpcsFile->fixer->replaceToken(($parenCloser - 1), $padding);	3✔
132	}
133	}
134	}
135	}//end if
136	}	1✔
137	}

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