120 lines
3.5 KiB
PHP
120 lines
3.5 KiB
PHP
|
<?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\ParameterValues;
|
||
|
|
|
||
|
|
use PHPCompatibility\AbstractFunctionCallParameterSniff;
|
||
|
|
use PHP_CodeSniffer_File as File;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check for valid values for the `fopen()` `$mode` parameter.
|
||
|
|
*
|
||
|
|
* PHP version 5.2+
|
||
|
|
*
|
||
|
|
* @link https://www.php.net/manual/en/function.fopen.php#refsect1-function.fopen-changelog
|
||
|
|
*
|
||
|
|
* @since 9.0.0
|
||
|
|
*/
|
||
|
|
class NewFopenModesSniff extends AbstractFunctionCallParameterSniff
|
||
|
|
{
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Functions to check for.
|
||
|
|
*
|
||
|
|
* @since 9.0.0
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
protected $targetFunctions = array(
|
||
|
|
'fopen' => true,
|
||
|
|
);
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Do a version check to determine if this sniff needs to run at all.
|
||
|
|
*
|
||
|
|
* @since 9.0.0
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
protected function bowOutEarly()
|
||
|
|
{
|
||
|
|
// Version used here should be (above) the highest version from the `newModes` control,
|
||
|
|
// structure below, i.e. the last PHP version in which a new mode was introduced.
|
||
|
|
return ($this->supportsBelow('7.1') === false);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Process the parameters of a matched function.
|
||
|
|
*
|
||
|
|
* @since 9.0.0
|
||
|
|
*
|
||
|
|
* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||
|
|
* @param int $stackPtr The position of the current token in the stack.
|
||
|
|
* @param string $functionName The token content (function name) which was matched.
|
||
|
|
* @param array $parameters Array with information about the parameters.
|
||
|
|
*
|
||
|
|
* @return int|void Integer stack pointer to skip forward or void to continue
|
||
|
|
* normal file processing.
|
||
|
|
*/
|
||
|
|
public function processParameters(File $phpcsFile, $stackPtr, $functionName, $parameters)
|
||
|
|
{
|
||
|
|
if (isset($parameters[2]) === false) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$tokens = $phpcsFile->getTokens();
|
||
|
|
$targetParam = $parameters[2];
|
||
|
|
$errors = array();
|
||
|
|
|
||
|
|
for ($i = $targetParam['start']; $i <= $targetParam['end']; $i++) {
|
||
|
|
if ($tokens[$i]['code'] !== \T_CONSTANT_ENCAPSED_STRING) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (strpos($tokens[$i]['content'], 'c+') !== false && $this->supportsBelow('5.2.5')) {
|
||
|
|
$errors['cplusFound'] = array(
|
||
|
|
'c+',
|
||
|
|
'5.2.5',
|
||
|
|
$targetParam['raw'],
|
||
|
|
);
|
||
|
|
} elseif (strpos($tokens[$i]['content'], 'c') !== false && $this->supportsBelow('5.2.5')) {
|
||
|
|
$errors['cFound'] = array(
|
||
|
|
'c',
|
||
|
|
'5.2.5',
|
||
|
|
$targetParam['raw'],
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (strpos($tokens[$i]['content'], 'e') !== false && $this->supportsBelow('7.0.15')) {
|
||
|
|
$errors['eFound'] = array(
|
||
|
|
'e',
|
||
|
|
'7.0.15',
|
||
|
|
$targetParam['raw'],
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (empty($errors) === true) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($errors as $errorCode => $errorData) {
|
||
|
|
$phpcsFile->addError(
|
||
|
|
'Passing "%s" as the $mode to fopen() is not supported in PHP %s or lower. Found %s',
|
||
|
|
$targetParam['start'],
|
||
|
|
$errorCode,
|
||
|
|
$errorData
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|