Create New Item
Item Type
File
Folder
Item Name
Search file in folder and subfolders...
Are you sure want to rename?
primogenial
/
themes
/
storefront
/
vendor
/
squizlabs
/
php_codesniffer
/
src
/
Standards
/
Squiz
/
Sniffs
/
Commenting
:
LongConditionClosingCommentSniff.php
Advanced Search
Upload
New Item
Settings
Back
Back Up
Advanced Editor
Save
<?php /** * Ensures long conditions have a comment at the end. * * @author Greg Sherwood <gsherwood@squiz.net> * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence */ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\Sniff; class LongConditionClosingCommentSniff implements Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = [ 'PHP', 'JS', ]; /** * The openers that we are interested in. * * @var integer[] */ private static $openers = [ T_SWITCH, T_IF, T_FOR, T_FOREACH, T_WHILE, T_TRY, T_CASE, T_MATCH, ]; /** * The length that a code block must be before * requiring a closing comment. * * @var integer */ public $lineLimit = 20; /** * The format the end comment should be in. * * The placeholder %s will be replaced with the type of condition opener. * * @var string */ public $commentFormat = '//end %s'; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return [T_CLOSE_CURLY_BRACKET]; }//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 void */ public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_condition']) === false) { // No scope condition. It is a function closer. return; } $startCondition = $tokens[$tokens[$stackPtr]['scope_condition']]; $startBrace = $tokens[$tokens[$stackPtr]['scope_opener']]; $endBrace = $tokens[$stackPtr]; // We are only interested in some code blocks. if (in_array($startCondition['code'], self::$openers, true) === false) { return; } if ($startCondition['code'] === T_IF) { // If this is actually an ELSE IF, skip it as the brace // will be checked by the original IF. $else = $phpcsFile->findPrevious(T_WHITESPACE, ($tokens[$stackPtr]['scope_condition'] - 1), null, true); if ($tokens[$else]['code'] === T_ELSE) { return; } // IF statements that have an ELSE block need to use // "end if" rather than "end else" or "end elseif". do { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$nextToken]['code'] === T_ELSE || $tokens[$nextToken]['code'] === T_ELSEIF) { // Check for ELSE IF (2 tokens) as opposed to ELSEIF (1 token). if ($tokens[$nextToken]['code'] === T_ELSE && isset($tokens[$nextToken]['scope_closer']) === false ) { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] !== T_IF || isset($tokens[$nextToken]['scope_closer']) === false ) { // Not an ELSE IF or is an inline ELSE IF. break; } } if (isset($tokens[$nextToken]['scope_closer']) === false) { // There isn't going to be anywhere to print the "end if" comment // because there is no closer. return; } // The end brace becomes the ELSE's end brace. $stackPtr = $tokens[$nextToken]['scope_closer']; $endBrace = $tokens[$stackPtr]; } else { break; }//end if } while (isset($tokens[$nextToken]['scope_closer']) === true); }//end if if ($startCondition['code'] === T_TRY) { // TRY statements need to check until the end of all CATCH statements. do { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$nextToken]['code'] === T_CATCH || $tokens[$nextToken]['code'] === T_FINALLY ) { // The end brace becomes the CATCH end brace. $stackPtr = $tokens[$nextToken]['scope_closer']; $endBrace = $tokens[$stackPtr]; } else { break; } } while (isset($tokens[$nextToken]['scope_closer']) === true); } if ($startCondition['code'] === T_MATCH) { // Move the stackPtr to after the semi-colon/comma if there is one. $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($nextToken !== false && ($tokens[$nextToken]['code'] === T_SEMICOLON || $tokens[$nextToken]['code'] === T_COMMA) ) { $stackPtr = $nextToken; } } $lineDifference = ($endBrace['line'] - $startBrace['line']); $expected = sprintf($this->commentFormat, $startCondition['content']); $comment = $phpcsFile->findNext([T_COMMENT], $stackPtr, null, false); if (($comment === false) || ($tokens[$comment]['line'] !== $endBrace['line'])) { if ($lineDifference >= $this->lineLimit) { $error = 'End comment for long condition not found; expected "%s"'; $data = [$expected]; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Missing', $data); if ($fix === true) { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($next !== false && $tokens[$next]['line'] === $tokens[$stackPtr]['line']) { $expected .= $phpcsFile->eolChar; } $phpcsFile->fixer->addContent($stackPtr, $expected); } } return; } if (($comment - $stackPtr) !== 1) { $error = 'Space found before closing comment; expected "%s"'; $data = [$expected]; $phpcsFile->addError($error, $stackPtr, 'SpacingBefore', $data); } if (trim($tokens[$comment]['content']) !== $expected) { $found = trim($tokens[$comment]['content']); $error = 'Incorrect closing comment; expected "%s" but found "%s"'; $data = [ $expected, $found, ]; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Invalid', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($comment, $expected.$phpcsFile->eolChar); } return; } }//end process() }//end class