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

97.48

/src/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSniff.php

<?php
/**
 * Verifies that there is a space between each condition of foreach loops.
 *
 * @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\ControlStructures;

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

class ForEachLoopDeclarationSniff 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_FOREACH];
    }


    /**
     * 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();

        $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
        if ($openingBracket === false) {
            // Parse error or live coding.
            return;
        }

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

        $closingBracket = $tokens[$openingBracket]['parenthesis_closer'];

        if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
            $error = 'Space found after opening bracket of FOREACH loop';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen');
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken(($openingBracket + 1), '');
            }
        } elseif ($this->requiredSpacesAfterOpen > 0) {
            $spaceAfterOpen = 0;
            if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
                $spaceAfterOpen = $tokens[($openingBracket + 1)]['length'];
            }

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

        if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
            $error = 'Space found before closing bracket of FOREACH loop';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose');
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken(($closingBracket - 1), '');
            }
        } elseif ($this->requiredSpacesBeforeClose > 0) {
            $spaceBeforeClose = 0;
            if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
                $spaceBeforeClose = $tokens[($closingBracket - 1)]['length'];
            }

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

        $asToken = $phpcsFile->findNext(T_AS, $openingBracket);
        if ($asToken === false) {
            // Parse error or live coding.
            return;
        }

        $content = $tokens[$asToken]['content'];
        if ($content !== strtolower($content)) {
            $expected = strtolower($content);
            $error    = 'AS keyword must be lowercase; expected "%s" but found "%s"';
            $data     = [
                $expected,
                $content,
            ];

            $fix = $phpcsFile->addFixableError($error, $asToken, 'AsNotLower', $data);
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken($asToken, $expected);
            }
        }

        $doubleArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $asToken, $closingBracket);

        if ($doubleArrow !== false) {
            if ($tokens[($doubleArrow - 1)]['code'] !== T_WHITESPACE) {
                $error = 'Expected 1 space before "=>"; 0 found';
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeArrow');
                if ($fix === true) {
                    $phpcsFile->fixer->addContentBefore($doubleArrow, ' ');
                }
            } else {
                if ($tokens[($doubleArrow - 1)]['length'] !== 1) {
                    $spaces = $tokens[($doubleArrow - 1)]['length'];
                    $error  = 'Expected 1 space before "=>"; %s found';
                    $data   = [$spaces];
                    $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeArrow', $data);
                    if ($fix === true) {
                        $phpcsFile->fixer->replaceToken(($doubleArrow - 1), ' ');
                    }
                }
            }

            if ($tokens[($doubleArrow + 1)]['code'] !== T_WHITESPACE) {
                $error = 'Expected 1 space after "=>"; 0 found';
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterArrow');
                if ($fix === true) {
                    $phpcsFile->fixer->addContent($doubleArrow, ' ');
                }
            } else {
                if ($tokens[($doubleArrow + 1)]['length'] !== 1) {
                    $spaces = $tokens[($doubleArrow + 1)]['length'];
                    $error  = 'Expected 1 space after "=>"; %s found';
                    $data   = [$spaces];
                    $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterArrow', $data);
                    if ($fix === true) {
                        $phpcsFile->fixer->replaceToken(($doubleArrow + 1), ' ');
                    }
                }
            }
        }//end if

        if ($tokens[($asToken - 1)]['code'] !== T_WHITESPACE) {
            $error = 'Expected 1 space before "as"; 0 found';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAs');
            if ($fix === true) {
                $phpcsFile->fixer->addContentBefore($asToken, ' ');
            }
        } else {
            if ($tokens[($asToken - 1)]['length'] !== 1) {
                $spaces = $tokens[($asToken - 1)]['length'];
                $error  = 'Expected 1 space before "as"; %s found';
                $data   = [$spaces];
                $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAs', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->replaceToken(($asToken - 1), ' ');
                }
            }
        }

        if ($tokens[($asToken + 1)]['code'] !== T_WHITESPACE) {
            $error = 'Expected 1 space after "as"; 0 found';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAs');
            if ($fix === true) {
                $phpcsFile->fixer->addContent($asToken, ' ');
            }
        } else {
            if ($tokens[($asToken + 1)]['length'] !== 1) {
                $spaces = $tokens[($asToken + 1)]['length'];
                $error  = 'Expected 1 space after "as"; %s found';
                $data   = [$spaces];
                $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAs', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->replaceToken(($asToken + 1), ' ');
                }
            }
        }
    }
}

1	<?php
2	/**
3	* Verifies that there is a space between each condition of foreach loops.
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\ControlStructures;
11
12	use PHP_CodeSniffer\Files\File;
13	use PHP_CodeSniffer\Sniffs\Sniff;
14
15	class ForEachLoopDeclarationSniff implements Sniff
16	{
17
18	/**
19	* How many spaces should follow the opening bracket.
20	*
21	* @var integer
22	*/
23	public $requiredSpacesAfterOpen = 0;
24
25	/**
26	* How many spaces should precede the closing bracket.
27	*
28	* @var integer
29	*/
30	public $requiredSpacesBeforeClose = 0;
31
32
33	/**
34	* Returns an array of tokens this test wants to listen for.
35	*
36	* @return array<int\|string>
37	*/
38	public function register()	3✔
39	{
40	return [T_FOREACH];	3✔
41	}
42
43
44	/**
45	* Processes this test, when one of its tokens is encountered.
46	*
47	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
48	* @param int $stackPtr The position of the current token in the
49	* stack passed in $tokens.
50	*
51	* @return void
52	*/
53	public function process(File $phpcsFile, int $stackPtr)	3✔
54	{
55	$this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen;	3✔
56	$this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;	3✔
57	$tokens = $phpcsFile->getTokens();	3✔
58
59	$openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);	3✔
60	if ($openingBracket === false) {	3✔
61	// Parse error or live coding.
UNCOV 62	return;	×
63	}
64
65	if (isset($tokens[$openingBracket]['parenthesis_closer']) === false) {	3✔
66	// Parse error or live coding.
UNCOV 67	return;	×
68	}
69
70	$closingBracket = $tokens[$openingBracket]['parenthesis_closer'];	3✔
71
72	if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {	3✔
73	$error = 'Space found after opening bracket of FOREACH loop';	3✔
74	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen');	3✔
75	if ($fix === true) {	3✔
76	$phpcsFile->fixer->replaceToken(($openingBracket + 1), '');	3✔
77	}
78	} elseif ($this->requiredSpacesAfterOpen > 0) {	3✔
79	$spaceAfterOpen = 0;	3✔
80	if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {	3✔
81	$spaceAfterOpen = $tokens[($openingBracket + 1)]['length'];	3✔
82	}
83
84	if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {	3✔
85	$error = 'Expected %s spaces after opening bracket; %s found';	3✔
86	$data = [	2✔
87	$this->requiredSpacesAfterOpen,	3✔
88	$spaceAfterOpen,	3✔
89	];	2✔
90	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen', $data);	3✔
91	if ($fix === true) {	3✔
92	$padding = str_repeat(' ', $this->requiredSpacesAfterOpen);	3✔
93	if ($spaceAfterOpen === 0) {	3✔
94	$phpcsFile->fixer->addContent($openingBracket, $padding);	3✔
95	} else {
96	$phpcsFile->fixer->replaceToken(($openingBracket + 1), $padding);	3✔
97	}
98	}
99	}
100	}//end if
101
102	if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {	3✔
103	$error = 'Space found before closing bracket of FOREACH loop';	3✔
104	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose');	3✔
105	if ($fix === true) {	3✔
106	$phpcsFile->fixer->replaceToken(($closingBracket - 1), '');	3✔
107	}
108	} elseif ($this->requiredSpacesBeforeClose > 0) {	3✔
109	$spaceBeforeClose = 0;	3✔
110	if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {	3✔
111	$spaceBeforeClose = $tokens[($closingBracket - 1)]['length'];	3✔
112	}
113
114	if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {	3✔
115	$error = 'Expected %s spaces before closing bracket; %s found';	3✔
116	$data = [	2✔
117	$this->requiredSpacesBeforeClose,	3✔
118	$spaceBeforeClose,	3✔
119	];	2✔
120	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose', $data);	3✔
121	if ($fix === true) {	3✔
122	$padding = str_repeat(' ', $this->requiredSpacesBeforeClose);	3✔
123	if ($spaceBeforeClose === 0) {	3✔
124	$phpcsFile->fixer->addContentBefore($closingBracket, $padding);	3✔
125	} else {
126	$phpcsFile->fixer->replaceToken(($closingBracket - 1), $padding);	3✔
127	}
128	}
129	}
130	}//end if
131
132	$asToken = $phpcsFile->findNext(T_AS, $openingBracket);	3✔
133	if ($asToken === false) {	3✔
134	// Parse error or live coding.
UNCOV 135	return;	×
136	}
137
138	$content = $tokens[$asToken]['content'];	3✔
139	if ($content !== strtolower($content)) {	3✔
140	$expected = strtolower($content);	3✔
141	$error = 'AS keyword must be lowercase; expected "%s" but found "%s"';	3✔
142	$data = [	2✔
143	$expected,	3✔
144	$content,	3✔
145	];	2✔
146
147	$fix = $phpcsFile->addFixableError($error, $asToken, 'AsNotLower', $data);	3✔
148	if ($fix === true) {	3✔
149	$phpcsFile->fixer->replaceToken($asToken, $expected);	3✔
150	}
151	}
152
153	$doubleArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $asToken, $closingBracket);	3✔
154
155	if ($doubleArrow !== false) {	3✔
156	if ($tokens[($doubleArrow - 1)]['code'] !== T_WHITESPACE) {	3✔
157	$error = 'Expected 1 space before "=>"; 0 found';	3✔
158	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeArrow');	3✔
159	if ($fix === true) {	3✔
160	$phpcsFile->fixer->addContentBefore($doubleArrow, ' ');	3✔
161	}
162	} else {
163	if ($tokens[($doubleArrow - 1)]['length'] !== 1) {	3✔
164	$spaces = $tokens[($doubleArrow - 1)]['length'];	3✔
165	$error = 'Expected 1 space before "=>"; %s found';	3✔
166	$data = [$spaces];	3✔
167	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeArrow', $data);	3✔
168	if ($fix === true) {	3✔
169	$phpcsFile->fixer->replaceToken(($doubleArrow - 1), ' ');	3✔
170	}
171	}
172	}
173
174	if ($tokens[($doubleArrow + 1)]['code'] !== T_WHITESPACE) {	3✔
175	$error = 'Expected 1 space after "=>"; 0 found';	3✔
176	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterArrow');	3✔
177	if ($fix === true) {	3✔
178	$phpcsFile->fixer->addContent($doubleArrow, ' ');	3✔
179	}
180	} else {
181	if ($tokens[($doubleArrow + 1)]['length'] !== 1) {	3✔
182	$spaces = $tokens[($doubleArrow + 1)]['length'];	3✔
183	$error = 'Expected 1 space after "=>"; %s found';	3✔
184	$data = [$spaces];	3✔
185	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterArrow', $data);	3✔
186	if ($fix === true) {	3✔
187	$phpcsFile->fixer->replaceToken(($doubleArrow + 1), ' ');	3✔
188	}
189	}
190	}
191	}//end if
192
193	if ($tokens[($asToken - 1)]['code'] !== T_WHITESPACE) {	3✔
194	$error = 'Expected 1 space before "as"; 0 found';	3✔
195	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAs');	3✔
196	if ($fix === true) {	3✔
197	$phpcsFile->fixer->addContentBefore($asToken, ' ');	3✔
198	}
199	} else {
200	if ($tokens[($asToken - 1)]['length'] !== 1) {	3✔
201	$spaces = $tokens[($asToken - 1)]['length'];	3✔
202	$error = 'Expected 1 space before "as"; %s found';	3✔
203	$data = [$spaces];	3✔
204	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAs', $data);	3✔
205	if ($fix === true) {	3✔
206	$phpcsFile->fixer->replaceToken(($asToken - 1), ' ');	3✔
207	}
208	}
209	}
210
211	if ($tokens[($asToken + 1)]['code'] !== T_WHITESPACE) {	3✔
212	$error = 'Expected 1 space after "as"; 0 found';	3✔
213	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAs');	3✔
214	if ($fix === true) {	3✔
215	$phpcsFile->fixer->addContent($asToken, ' ');	3✔
216	}
217	} else {
218	if ($tokens[($asToken + 1)]['length'] !== 1) {	3✔
219	$spaces = $tokens[($asToken + 1)]['length'];	3✔
220	$error = 'Expected 1 space after "as"; %s found';	3✔
221	$data = [$spaces];	3✔
222	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAs', $data);	3✔
223	if ($fix === true) {	3✔
224	$phpcsFile->fixer->replaceToken(($asToken + 1), ' ');	3✔
225	}
226	}
227	}
228	}	1✔
229	}

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