17662127818

Committed 12 Sep 2025 01:50AM UTC coverage: 78.786%. Remained the same

Build # 17662127818

Build Type

push

github

Committed by

web-flow

Commit Message

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

CS: normalize code style rules [3]

Run Details

343 of 705 new or added lines in 108 files covered. (48.65%)

3 existing lines in 3 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

0.0

/src/Reports/Cbf.php

<?php
/**
 * CBF report for PHP_CodeSniffer.
 *
 * This report implements the various auto-fixing features of the
 * PHPCBF script and is not intended (or allowed) to be selected as a
 * report from the command line.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @author    Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @copyright 2025 PHPCSStandards and contributors
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */

namespace PHP_CodeSniffer\Reports;

use PHP_CodeSniffer\Exceptions\DeepExitException;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Reporter;
use PHP_CodeSniffer\Util\ExitCode;
use PHP_CodeSniffer\Util\Timing;
use PHP_CodeSniffer\Util\Writers\StatusWriter;

class Cbf implements Report
{


    /**
     * Generate a partial report for a single processed file.
     *
     * Function should return TRUE if it printed or stored data about the file
     * and FALSE if it ignored the file. Returning TRUE indicates that the file and
     * its data should be counted in the grand totals.
     *
     * @param array<string, string|int|array> $report      Prepared report data.
     *                                                     See the {@see Report} interface for a detailed specification.
     * @param \PHP_CodeSniffer\Files\File     $phpcsFile   The file being reported on.
     * @param bool                            $showSources Show sources?
     * @param int                             $width       Maximum allowed line width.
     *
     * @return bool
     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
     */
    public function generateFileReport(array $report, File $phpcsFile, bool $showSources = false, int $width = 80)
    {
        $errors = $phpcsFile->getFixableCount();
        if ($errors !== 0) {
            if (PHP_CODESNIFFER_VERBOSITY > 0) {
                $startTime = microtime(true);
                $newlines  = 0;
                if (PHP_CODESNIFFER_VERBOSITY > 1) {
                    $newlines = 1;
                }

                StatusWriter::forceWrite("=> Fixing file: $errors/$errors violations remaining", 1, $newlines);
            }

            $fixed = $phpcsFile->fixer->fixFile();
        }

        if ($phpcsFile->config->stdin === true) {
            // Replacing STDIN, so output current file to STDOUT
            // even if nothing was fixed. Exit here because we
            // can't process any more than 1 file in this setup.
            echo $phpcsFile->fixer->getContents();

            // Fake a Reporter instance to allow for getting a proper exit code.
            $reporter = $this->createReporterInstance($phpcsFile);

            throw new DeepExitException('', ExitCode::calculate($reporter));
        }

        if ($errors === 0) {
            return false;
        }

        if (PHP_CODESNIFFER_VERBOSITY > 0) {
            if ($fixed === false) {
                StatusWriter::forceWrite('ERROR', 0, 0);
            } else {
                StatusWriter::forceWrite('DONE', 0, 0);
            }

            StatusWriter::forceWrite(' in ' . Timing::getHumanReadableDuration(Timing::getDurationSince($startTime)));
        }

        if ($fixed === true) {
            // The filename in the report may be truncated due to a basepath setting
            // but we are using it for writing here and not display,
            // so find the correct path if basepath is in use.
            $newFilename = $report['filename'] . $phpcsFile->config->suffix;
            if ($phpcsFile->config->basepath !== null) {
                $newFilename = $phpcsFile->config->basepath . DIRECTORY_SEPARATOR . $newFilename;
            }

            $newContent = $phpcsFile->fixer->getContents();
            file_put_contents($newFilename, $newContent);

            if (PHP_CODESNIFFER_VERBOSITY > 0) {
                if ($newFilename === $report['filename']) {
                    StatusWriter::forceWrite('=> File was overwritten', 1);
                } else {
                    StatusWriter::forceWrite('=> Fixed file written to ' . basename($newFilename), 1);
                }
            }
        }

        $errorCount   = $phpcsFile->getErrorCount();
        $warningCount = $phpcsFile->getWarningCount();
        $fixableCount = $phpcsFile->getFixableCount();
        $fixedCount   = ($errors - $fixableCount);
        echo $report['filename'] . ">>$errorCount>>$warningCount>>$fixableCount>>$fixedCount" . PHP_EOL;

        return $fixed;

    }//end generateFileReport()


    /**
     * Prints a summary of fixed files.
     *
     * @param string $cachedData    Any partial report data that was returned from
     *                              generateFileReport during the run.
     * @param int    $totalFiles    Total number of files processed during the run.
     * @param int    $totalErrors   Total number of errors found during the run.
     * @param int    $totalWarnings Total number of warnings found during the run.
     * @param int    $totalFixable  Total number of problems that can be fixed.
     * @param bool   $showSources   Show sources?
     * @param int    $width         Maximum allowed line width.
     * @param bool   $interactive   Are we running in interactive mode?
     * @param bool   $toScreen      Is the report being printed to screen?
     *
     * @return void
     */
    public function generate(
        string $cachedData,
        int $totalFiles,
        int $totalErrors,
        int $totalWarnings,
        int $totalFixable,
        bool $showSources = false,
        int $width = 80,
        bool $interactive = false,
        bool $toScreen = true
    ) {
        $lines = explode(PHP_EOL, $cachedData);
        array_pop($lines);

        if (empty($lines) === true) {
            if (($totalErrors + $totalWarnings) === 0) {
                StatusWriter::writeNewline();
                StatusWriter::write('No violations were found');
            } else {
                StatusWriter::writeNewline();
                StatusWriter::write('No fixable errors were found');
            }

            return;
        }

        $reportFiles = [];
        $maxLength   = 0;
        $totalFixed  = 0;
        $failures    = 0;

        foreach ($lines as $line) {
            $parts   = explode('>>', $line);
            $fileLen = strlen($parts[0]);
            $reportFiles[$parts[0]] = [
                'errors'   => $parts[1],
                'warnings' => $parts[2],
                'fixable'  => $parts[3],
                'fixed'    => $parts[4],
                'strlen'   => $fileLen,
            ];

            $maxLength = max($maxLength, $fileLen);

            $totalFixed += $parts[4];

            if ($parts[3] > 0) {
                $failures++;
            }
        }

        $width = min($width, ($maxLength + 21));
        $width = max($width, 70);

        echo PHP_EOL . "\033[1m" . 'PHPCBF RESULT SUMMARY' . "\033[0m" . PHP_EOL;
        echo str_repeat('-', $width) . PHP_EOL;
        echo "\033[1m" . 'FILE' . str_repeat(' ', ($width - 20)) . 'FIXED  REMAINING' . "\033[0m" . PHP_EOL;
        echo str_repeat('-', $width) . PHP_EOL;

        foreach ($reportFiles as $file => $data) {
            $padding = ($width - 18 - $data['strlen']);
            if ($padding < 0) {
                $file    = '...' . substr($file, (($padding * -1) + 3));
                $padding = 0;
            }

            echo $file . str_repeat(' ', $padding) . '  ';

            if ($data['fixable'] > 0) {
                echo "\033[31mFAILED TO FIX\033[0m" . PHP_EOL;
                continue;
            }

            $remaining = ($data['errors'] + $data['warnings']);

            if ($data['fixed'] !== 0) {
                echo $data['fixed'];
                echo str_repeat(' ', (7 - strlen((string) $data['fixed'])));
            } else {
                echo '0      ';
            }

            if ($remaining !== 0) {
                echo $remaining;
            } else {
                echo '0';
            }

            echo PHP_EOL;
        }//end foreach

        echo str_repeat('-', $width) . PHP_EOL;
        echo "\033[1mA TOTAL OF $totalFixed ERROR";
        if ($totalFixed !== 1) {
            echo 'S';
        }

        $numFiles = count($reportFiles);
        echo ' WERE FIXED IN ' . $numFiles . ' FILE';
        if ($numFiles !== 1) {
            echo 'S';
        }

        echo "\033[0m";

        if ($failures > 0) {
            echo PHP_EOL . str_repeat('-', $width) . PHP_EOL;
            echo "\033[1mPHPCBF FAILED TO FIX $failures FILE";
            if ($failures !== 1) {
                echo 'S';
            }

            echo "\033[0m";
        }

        echo PHP_EOL . str_repeat('-', $width) . PHP_EOL . PHP_EOL;

    }//end generate()


    /**
     * Create a "fake" Reporter instance to allow for getting a proper exit code when scanning code provided via STDIN.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being reported on.
     *
     * @return \PHP_CodeSniffer\Reporter
     */
    private function createReporterInstance(File $phpcsFile)
    {
        $reporter = new class extends Reporter {


            /**
             * Overload the constructor as we don't need it.
             */
            public function __construct()
            {
            }//end __construct()


        };

        $reporter->totalFiles           = 1;
        $reporter->totalErrors          = $phpcsFile->getFirstRunCount('error');
        $reporter->totalWarnings        = $phpcsFile->getFirstRunCount('warning');
        $reporter->totalFixableErrors   = $phpcsFile->getFixableErrorCount();
        $reporter->totalFixableWarnings = $phpcsFile->getFixableWarningCount();
        $reporter->totalFixedErrors     = $phpcsFile->getFixedErrorCount();
        $reporter->totalFixedWarnings   = $phpcsFile->getFixedWarningCount();

        return $reporter;

    }//end createReporterInstance()


}//end class

1	<?php
2	/**
3	* CBF report for PHP_CodeSniffer.
4	*
5	* This report implements the various auto-fixing features of the
6	* PHPCBF script and is not intended (or allowed) to be selected as a
7	* report from the command line.
8	*
9	* @author Greg Sherwood <gsherwood@squiz.net>
10	* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
11	* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
12	* @copyright 2025 PHPCSStandards and contributors
13	* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
14	*/
15
16	namespace PHP_CodeSniffer\Reports;
17
18	use PHP_CodeSniffer\Exceptions\DeepExitException;
19	use PHP_CodeSniffer\Files\File;
20	use PHP_CodeSniffer\Reporter;
21	use PHP_CodeSniffer\Util\ExitCode;
22	use PHP_CodeSniffer\Util\Timing;
23	use PHP_CodeSniffer\Util\Writers\StatusWriter;
24
25	class Cbf implements Report
26	{
27
28
29	/**
30	* Generate a partial report for a single processed file.
31	*
32	* Function should return TRUE if it printed or stored data about the file
33	* and FALSE if it ignored the file. Returning TRUE indicates that the file and
34	* its data should be counted in the grand totals.
35	*
36	* @param array<string, string\|int\|array> $report Prepared report data.
37	* See the {@see Report} interface for a detailed specification.
38	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being reported on.
39	* @param bool $showSources Show sources?
40	* @param int $width Maximum allowed line width.
41	*
42	* @return bool
43	* @throws \PHP_CodeSniffer\Exceptions\DeepExitException
44	*/
45	public function generateFileReport(array $report, File $phpcsFile, bool $showSources = false, int $width = 80)	×
46	{
47	$errors = $phpcsFile->getFixableCount();	×
48	if ($errors !== 0) {	×
49	if (PHP_CODESNIFFER_VERBOSITY > 0) {	×
50	$startTime = microtime(true);	×
51	$newlines = 0;	×
52	if (PHP_CODESNIFFER_VERBOSITY > 1) {	×
53	$newlines = 1;	×
54	}
55
56	StatusWriter::forceWrite("=> Fixing file: $errors/$errors violations remaining", 1, $newlines);	×
57	}
58
59	$fixed = $phpcsFile->fixer->fixFile();	×
60	}
61
62	if ($phpcsFile->config->stdin === true) {	×
63	// Replacing STDIN, so output current file to STDOUT
64	// even if nothing was fixed. Exit here because we
65	// can't process any more than 1 file in this setup.
66	echo $phpcsFile->fixer->getContents();	×
67
68	// Fake a Reporter instance to allow for getting a proper exit code.
69	$reporter = $this->createReporterInstance($phpcsFile);	×
70
71	throw new DeepExitException('', ExitCode::calculate($reporter));	×
72	}
73
74	if ($errors === 0) {	×
75	return false;	×
76	}
77
78	if (PHP_CODESNIFFER_VERBOSITY > 0) {	×
79	if ($fixed === false) {	×
80	StatusWriter::forceWrite('ERROR', 0, 0);	×
81	} else {
82	StatusWriter::forceWrite('DONE', 0, 0);	×
83	}
84
NEW 85	StatusWriter::forceWrite(' in ' . Timing::getHumanReadableDuration(Timing::getDurationSince($startTime)));	×
86	}
87
88	if ($fixed === true) {	×
89	// The filename in the report may be truncated due to a basepath setting
90	// but we are using it for writing here and not display,
91	// so find the correct path if basepath is in use.
NEW 92	$newFilename = $report['filename'] . $phpcsFile->config->suffix;	×
93	if ($phpcsFile->config->basepath !== null) {	×
NEW 94	$newFilename = $phpcsFile->config->basepath . DIRECTORY_SEPARATOR . $newFilename;	×
95	}
96
97	$newContent = $phpcsFile->fixer->getContents();	×
98	file_put_contents($newFilename, $newContent);	×
99
100	if (PHP_CODESNIFFER_VERBOSITY > 0) {	×
101	if ($newFilename === $report['filename']) {	×
102	StatusWriter::forceWrite('=> File was overwritten', 1);	×
103	} else {
NEW 104	StatusWriter::forceWrite('=> Fixed file written to ' . basename($newFilename), 1);	×
105	}
106	}
107	}
108
109	$errorCount = $phpcsFile->getErrorCount();	×
110	$warningCount = $phpcsFile->getWarningCount();	×
111	$fixableCount = $phpcsFile->getFixableCount();	×
112	$fixedCount = ($errors - $fixableCount);	×
NEW 113	echo $report['filename'] . ">>$errorCount>>$warningCount>>$fixableCount>>$fixedCount" . PHP_EOL;	×
114
115	return $fixed;	×
116
117	}//end generateFileReport()
118
119
120	/**
121	* Prints a summary of fixed files.
122	*
123	* @param string $cachedData Any partial report data that was returned from
124	* generateFileReport during the run.
125	* @param int $totalFiles Total number of files processed during the run.
126	* @param int $totalErrors Total number of errors found during the run.
127	* @param int $totalWarnings Total number of warnings found during the run.
128	* @param int $totalFixable Total number of problems that can be fixed.
129	* @param bool $showSources Show sources?
130	* @param int $width Maximum allowed line width.
131	* @param bool $interactive Are we running in interactive mode?
132	* @param bool $toScreen Is the report being printed to screen?
133	*
134	* @return void
135	*/
136	public function generate(	×
137	string $cachedData,
138	int $totalFiles,
139	int $totalErrors,
140	int $totalWarnings,
141	int $totalFixable,
142	bool $showSources = false,
143	int $width = 80,
144	bool $interactive = false,
145	bool $toScreen = true
146	) {
147	$lines = explode(PHP_EOL, $cachedData);	×
148	array_pop($lines);	×
149
150	if (empty($lines) === true) {	×
151	if (($totalErrors + $totalWarnings) === 0) {	×
152	StatusWriter::writeNewline();	×
153	StatusWriter::write('No violations were found');	×
154	} else {
155	StatusWriter::writeNewline();	×
156	StatusWriter::write('No fixable errors were found');	×
157	}
158
159	return;	×
160	}
161
162	$reportFiles = [];	×
163	$maxLength = 0;	×
164	$totalFixed = 0;	×
165	$failures = 0;	×
166
167	foreach ($lines as $line) {	×
168	$parts = explode('>>', $line);	×
169	$fileLen = strlen($parts[0]);	×
170	$reportFiles[$parts[0]] = [	×
171	'errors' => $parts[1],	×
172	'warnings' => $parts[2],	×
173	'fixable' => $parts[3],	×
174	'fixed' => $parts[4],	×
175	'strlen' => $fileLen,	×
176	];
177
178	$maxLength = max($maxLength, $fileLen);	×
179
180	$totalFixed += $parts[4];	×
181
182	if ($parts[3] > 0) {	×
183	$failures++;	×
184	}
185	}
186
187	$width = min($width, ($maxLength + 21));	×
188	$width = max($width, 70);	×
189
NEW 190	echo PHP_EOL . "\033[1m" . 'PHPCBF RESULT SUMMARY' . "\033[0m" . PHP_EOL;	×
NEW 191	echo str_repeat('-', $width) . PHP_EOL;	×
NEW 192	echo "\033[1m" . 'FILE' . str_repeat(' ', ($width - 20)) . 'FIXED REMAINING' . "\033[0m" . PHP_EOL;	×
NEW 193	echo str_repeat('-', $width) . PHP_EOL;	×
194
195	foreach ($reportFiles as $file => $data) {	×
196	$padding = ($width - 18 - $data['strlen']);	×
197	if ($padding < 0) {	×
NEW 198	$file = '...' . substr($file, (($padding * -1) + 3));	×
199	$padding = 0;	×
200	}
201
NEW 202	echo $file . str_repeat(' ', $padding) . ' ';	×
203
204	if ($data['fixable'] > 0) {	×
NEW 205	echo "\033[31mFAILED TO FIX\033[0m" . PHP_EOL;	×
206	continue;	×
207	}
208
209	$remaining = ($data['errors'] + $data['warnings']);	×
210
211	if ($data['fixed'] !== 0) {	×
212	echo $data['fixed'];	×
213	echo str_repeat(' ', (7 - strlen((string) $data['fixed'])));	×
214	} else {
215	echo '0 ';	×
216	}
217
218	if ($remaining !== 0) {	×
219	echo $remaining;	×
220	} else {
221	echo '0';	×
222	}
223
224	echo PHP_EOL;	×
225	}//end foreach
226
NEW 227	echo str_repeat('-', $width) . PHP_EOL;	×
228	echo "\033[1mA TOTAL OF $totalFixed ERROR";	×
229	if ($totalFixed !== 1) {	×
230	echo 'S';	×
231	}
232
233	$numFiles = count($reportFiles);	×
NEW 234	echo ' WERE FIXED IN ' . $numFiles . ' FILE';	×
235	if ($numFiles !== 1) {	×
236	echo 'S';	×
237	}
238
239	echo "\033[0m";	×
240
241	if ($failures > 0) {	×
NEW 242	echo PHP_EOL . str_repeat('-', $width) . PHP_EOL;	×
243	echo "\033[1mPHPCBF FAILED TO FIX $failures FILE";	×
244	if ($failures !== 1) {	×
245	echo 'S';	×
246	}
247
248	echo "\033[0m";	×
249	}
250
NEW 251	echo PHP_EOL . str_repeat('-', $width) . PHP_EOL . PHP_EOL;	×
252
253	}//end generate()
254
255
256	/**
257	* Create a "fake" Reporter instance to allow for getting a proper exit code when scanning code provided via STDIN.
258	*
259	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being reported on.
260	*
261	* @return \PHP_CodeSniffer\Reporter
262	*/
263	private function createReporterInstance(File $phpcsFile)	×
264	{
265	$reporter = new class extends Reporter {
266
267
268	/**
269	* Overload the constructor as we don't need it.
270	*/
271	public function __construct()
272	{
273	}//end __construct()	×
274
275
276	};
277
278	$reporter->totalFiles = 1;	×
279	$reporter->totalErrors = $phpcsFile->getFirstRunCount('error');	×
280	$reporter->totalWarnings = $phpcsFile->getFirstRunCount('warning');	×
281	$reporter->totalFixableErrors = $phpcsFile->getFixableErrorCount();	×
282	$reporter->totalFixableWarnings = $phpcsFile->getFixableWarningCount();	×
283	$reporter->totalFixedErrors = $phpcsFile->getFixedErrorCount();	×
284	$reporter->totalFixedWarnings = $phpcsFile->getFixedWarningCount();	×
285
286	return $reporter;	×
287
288	}//end createReporterInstance()
289
290
291	}//end class

PHPCSStandards / PHP_CodeSniffer / 17662127818

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