14023452056

Committed 23 Mar 2025 10:08PM UTC coverage: 78.708% (+0.2%) from 78.556%

Build # 14023452056

Build Type

Pull #848

github

Committed by

web-flow

Commit Message

Merge 98dc9607e into a4c38a9a5

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

Run Details

24845 of 31566 relevant lines covered (78.71%)

66.4 hits per line

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

98.9

/src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php

<?php
/**
 * Ensures all language constructs contain a single space between themselves and their content.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2017 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\Generic\Sniffs\WhiteSpace;

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

class LanguageConstructSpacingSniff implements Sniff
{


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register()
    {
        return [
            T_ECHO,
            T_PRINT,
            T_RETURN,
            T_INCLUDE,
            T_INCLUDE_ONCE,
            T_REQUIRE,
            T_REQUIRE_ONCE,
            T_NEW,
            T_YIELD,
            T_YIELD_FROM,
            T_THROW,
            T_NAMESPACE,
            T_USE,
        ];

    }//end register()


    /**
     * 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 int|void Integer stack pointer to skip forward or void to continue
     *                  normal file processing.
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();

        $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
        if ($nextToken === false) {
            // Skip when at end of file.
            return;
        }

        if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) {
            // No content for this language construct.
            return;
        }

        $content = $tokens[$stackPtr]['content'];
        if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {
            $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
            if ($nextNonEmpty !== false && $tokens[$nextNonEmpty]['code'] === T_NS_SEPARATOR) {
                // Namespace keyword used as operator, not as the language construct.
                return;
            }
        }

        if ($tokens[$stackPtr]['code'] === T_YIELD_FROM
            && strtolower($content) !== 'yield from'
        ) {
            $found        = $content;
            $hasComment   = false;
            $yieldFromEnd = $stackPtr;

            // Handle potentially multi-line/multi-token "yield from" expressions.
            if (preg_match('`yield\s+from`i', $content) !== 1) {
                for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
                    if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false
                        && $tokens[$i]['code'] !== T_YIELD_FROM
                    ) {
                        break;
                    }

                    if (isset(Tokens::$commentTokens[$tokens[$i]['code']]) === true) {
                        $hasComment = true;
                    }

                    $found .= $tokens[$i]['content'];

                    if ($tokens[$i]['code'] === T_YIELD_FROM
                        && strtolower(trim($tokens[$i]['content'])) === 'from'
                    ) {
                        break;
                    }
                }

                $yieldFromEnd = $i;
            }//end if

            $error = 'Language constructs must be followed by a single space; expected 1 space between YIELD FROM found "%s"';
            $data  = [Common::prepareForOutput($found)];

            if ($hasComment === true) {
                $phpcsFile->addError($error, $stackPtr, 'IncorrectYieldFromWithComment', $data);
            } else {
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectYieldFrom', $data);
                if ($fix === true) {
                    preg_match('/yield/i', $found, $yield);
                    preg_match('/from/i', $found, $from);
                    $phpcsFile->fixer->beginChangeset();
                    $phpcsFile->fixer->replaceToken($stackPtr, $yield[0].' '.$from[0]);

                    for ($i = ($stackPtr + 1); $i <= $yieldFromEnd; $i++) {
                        $phpcsFile->fixer->replaceToken($i, '');
                    }

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

            return ($yieldFromEnd + 1);
        }//end if

        if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
            $content = $tokens[($stackPtr + 1)]['content'];
            if ($content !== ' ') {
                $error = 'Language constructs must be followed by a single space; expected 1 space but found "%s"';
                $data  = [Common::prepareForOutput($content)];
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectSingle', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
                }
            }
        } else if ($tokens[($stackPtr + 1)]['code'] !== T_OPEN_PARENTHESIS) {
            $error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"';
            $data  = [
                $tokens[$stackPtr]['content'].' '.$tokens[($stackPtr + 1)]['content'],
                $tokens[$stackPtr]['content'].$tokens[($stackPtr + 1)]['content'],
            ];
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);
            if ($fix === true) {
                $phpcsFile->fixer->addContent($stackPtr, ' ');
            }
        }//end if

    }//end process()


}//end class

1	<?php
2	/**
3	* Ensures all language constructs contain a single space between themselves and their content.
4	*
5	* @author Greg Sherwood <gsherwood@squiz.net>
6	* @copyright 2006-2017 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\Generic\Sniffs\WhiteSpace;
11
12	use PHP_CodeSniffer\Files\File;
13	use PHP_CodeSniffer\Sniffs\Sniff;
14	use PHP_CodeSniffer\Util\Common;
15	use PHP_CodeSniffer\Util\Tokens;
16
17	class LanguageConstructSpacingSniff implements Sniff
18	{
19
20
21	/**
22	* Returns an array of tokens this test wants to listen for.
23	*
24	* @return array<int\|string>
25	*/
26	public function register()	3✔
27	{
28	return [	1✔
29	T_ECHO,	3✔
30	T_PRINT,	3✔
31	T_RETURN,	3✔
32	T_INCLUDE,	3✔
33	T_INCLUDE_ONCE,	3✔
34	T_REQUIRE,	3✔
35	T_REQUIRE_ONCE,	3✔
36	T_NEW,	3✔
37	T_YIELD,	3✔
38	T_YIELD_FROM,	3✔
39	T_THROW,	3✔
40	T_NAMESPACE,	3✔
41	T_USE,	3✔
42	];	2✔
43
44	}//end register()
45
46
47	/**
48	* Processes this test, when one of its tokens is encountered.
49	*
50	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
51	* @param int $stackPtr The position of the current token in
52	* the stack passed in $tokens.
53	*
54	* @return int\|void Integer stack pointer to skip forward or void to continue
55	* normal file processing.
56	*/
57	public function process(File $phpcsFile, $stackPtr)	3✔
58	{
59	$tokens = $phpcsFile->getTokens();	3✔
60
61	$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);	3✔
62	if ($nextToken === false) {	3✔
63	// Skip when at end of file.
64	return;	3✔
65	}
66
67	if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) {	3✔
68	// No content for this language construct.
69	return;	3✔
70	}
71
72	$content = $tokens[$stackPtr]['content'];	3✔
73	if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {	3✔
74	$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);	3✔
75	if ($nextNonEmpty !== false && $tokens[$nextNonEmpty]['code'] === T_NS_SEPARATOR) {	3✔
76	// Namespace keyword used as operator, not as the language construct.
77	return;	3✔
78	}
79	}	1✔
80
81	if ($tokens[$stackPtr]['code'] === T_YIELD_FROM	3✔
82	&& strtolower($content) !== 'yield from'	3✔
83	) {	1✔
84	$found = $content;	3✔
85	$hasComment = false;	3✔
86	$yieldFromEnd = $stackPtr;	3✔
87
88	// Handle potentially multi-line/multi-token "yield from" expressions.
89	if (preg_match('`yield\s+from`i', $content) !== 1) {	3✔
90	for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {	3✔
91	if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false	3✔
92	&& $tokens[$i]['code'] !== T_YIELD_FROM	3✔
93	) {	1✔
94	break;	×
95	}
96
97	if (isset(Tokens::$commentTokens[$tokens[$i]['code']]) === true) {	3✔
98	$hasComment = true;	3✔
99	}	1✔
100
101	$found .= $tokens[$i]['content'];	3✔
102
103	if ($tokens[$i]['code'] === T_YIELD_FROM	3✔
104	&& strtolower(trim($tokens[$i]['content'])) === 'from'	3✔
105	) {	1✔
106	break;	3✔
107	}
108	}	1✔
109
110	$yieldFromEnd = $i;	3✔
111	}//end if	1✔
112
113	$error = 'Language constructs must be followed by a single space; expected 1 space between YIELD FROM found "%s"';	3✔
114	$data = [Common::prepareForOutput($found)];	3✔
115
116	if ($hasComment === true) {	3✔
117	$phpcsFile->addError($error, $stackPtr, 'IncorrectYieldFromWithComment', $data);	3✔
118	} else {	1✔
119	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectYieldFrom', $data);	3✔
120	if ($fix === true) {	3✔
121	preg_match('/yield/i', $found, $yield);	3✔
122	preg_match('/from/i', $found, $from);	3✔
123	$phpcsFile->fixer->beginChangeset();	3✔
124	$phpcsFile->fixer->replaceToken($stackPtr, $yield[0].' '.$from[0]);	3✔
125
126	for ($i = ($stackPtr + 1); $i <= $yieldFromEnd; $i++) {	3✔
127	$phpcsFile->fixer->replaceToken($i, '');	3✔
128	}	1✔
129
130	$phpcsFile->fixer->endChangeset();	3✔
131	}	1✔
132	}//end if
133
134	return ($yieldFromEnd + 1);	3✔
135	}//end if
136
137	if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {	3✔
138	$content = $tokens[($stackPtr + 1)]['content'];	3✔
139	if ($content !== ' ') {	3✔
140	$error = 'Language constructs must be followed by a single space; expected 1 space but found "%s"';	3✔
141	$data = [Common::prepareForOutput($content)];	3✔
142	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectSingle', $data);	3✔
143	if ($fix === true) {	3✔
144	$phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');	3✔
145	}	1✔
146	}	1✔
147	} else if ($tokens[($stackPtr + 1)]['code'] !== T_OPEN_PARENTHESIS) {	3✔
148	$error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"';	3✔
149	$data = [	1✔
150	$tokens[$stackPtr]['content'].' '.$tokens[($stackPtr + 1)]['content'],	3✔
151	$tokens[$stackPtr]['content'].$tokens[($stackPtr + 1)]['content'],	3✔
152	];	2✔
153	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);	3✔
154	if ($fix === true) {	3✔
155	$phpcsFile->fixer->addContent($stackPtr, ' ');	3✔
156	}	1✔
157	}//end if	1✔
158
159	}//end process()	2✔
160
161
162	}//end class

PHPCSStandards / PHP_CodeSniffer / 14023452056

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