xarxaprod-wp-theme/vendor/phpcompatibility/php-compatibility/PHPCompatibility/Sniffs/ControlStructures/ForbiddenBreakContinueOutsi...

117 lines
3.3 KiB
PHP
Raw Normal View History

2024-01-09 16:13:20 +01:00
<?php
/**
* PHPCompatibility, an external standard for PHP_CodeSniffer.
*
* @package PHPCompatibility
* @copyright 2012-2019 PHPCompatibility Contributors
* @license https://opensource.org/licenses/LGPL-3.0 LGPL3
* @link https://github.com/PHPCompatibility/PHPCompatibility
*/
namespace PHPCompatibility\Sniffs\ControlStructures;
use PHPCompatibility\Sniff;
use PHP_CodeSniffer_File as File;
/**
* Detect using `break` and/or `continue` statements outside of a looping structure.
*
* PHP version 7.0
*
* @link https://www.php.net/manual/en/migration70.incompatible.php#migration70.incompatible.other.break-continue
* @link https://www.php.net/manual/en/control-structures.break.php
* @link https://www.php.net/manual/en/control-structures.continue.php
*
* @since 7.0.7
*/
class ForbiddenBreakContinueOutsideLoopSniff extends Sniff
{
/**
* Token codes of control structure in which usage of break/continue is valid.
*
* @since 7.0.7
*
* @var array
*/
protected $validLoopStructures = array(
\T_FOR => true,
\T_FOREACH => true,
\T_WHILE => true,
\T_DO => true,
\T_SWITCH => true,
);
/**
* Token codes which did not correctly get a condition assigned in older PHPCS versions.
*
* @since 7.0.7
*
* @var array
*/
protected $backCompat = array(
\T_CASE => true,
\T_DEFAULT => true,
);
/**
* Returns an array of tokens this test wants to listen for.
*
* @since 7.0.7
*
* @return array
*/
public function register()
{
return array(
\T_BREAK,
\T_CONTINUE,
);
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @since 7.0.7
*
* @param \PHP_CodeSniffer_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();
$token = $tokens[$stackPtr];
// Check if the break/continue is within a valid loop structure.
if (empty($token['conditions']) === false) {
foreach ($token['conditions'] as $tokenCode) {
if (isset($this->validLoopStructures[$tokenCode]) === true) {
return;
}
}
} else {
// Deal with older PHPCS versions.
if (isset($token['scope_condition']) === true && isset($this->backCompat[$tokens[$token['scope_condition']]['code']]) === true) {
return;
}
}
// If we're still here, no valid loop structure container has been found, so throw an error.
$error = "Using '%s' outside of a loop or switch structure is invalid";
$isError = false;
$errorCode = 'Found';
$data = array($token['content']);
if ($this->supportsAbove('7.0')) {
$error .= ' and will throw a fatal error since PHP 7.0';
$isError = true;
$errorCode = 'FatalError';
}
$this->addMessage($phpcsFile, $error, $stackPtr, $isError, $errorCode, $data);
}
}