File "NativeFunctionInvocationFixer.php"
Full Path: /var/www/html/back/vendor/friendsofphp/php-cs-fixer/src/Fixer/FunctionNotation/NativeFunctionInvocationFixer.php
File size: 14.64 KB
MIME-type: text/x-php
Charset: utf-8
<?php
declare(strict_types=1);
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Fixer\FunctionNotation;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\Fixer\ConfigurableFixerTrait;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Analyzer\FunctionsAnalyzer;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Utils;
use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
/**
* @phpstan-type _AutogeneratedInputConfiguration array{
* exclude?: list<string>,
* include?: list<string>,
* scope?: 'all'|'namespaced',
* strict?: bool,
* }
* @phpstan-type _AutogeneratedComputedConfiguration array{
* exclude: list<string>,
* include: list<string>,
* scope: 'all'|'namespaced',
* strict: bool,
* }
*
* @implements ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>
*
* @author Andreas Möller <am@localheinz.com>
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise.
*/
final class NativeFunctionInvocationFixer extends AbstractFixer implements ConfigurableFixerInterface
{
/** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
use ConfigurableFixerTrait;
/**
* @internal
*/
public const SET_ALL = '@all';
/**
* Subset of SET_INTERNAL.
*
* Change function call to functions known to be optimized by the Zend engine.
* For details:
* - @see https://github.com/php/php-src/blob/php-7.2.6/Zend/zend_compile.c "zend_try_compile_special_func"
* - @see https://github.com/php/php-src/blob/php-7.2.6/ext/opcache/Optimizer/pass1_5.c
*
* @internal
*/
public const SET_COMPILER_OPTIMIZED = '@compiler_optimized';
/**
* @internal
*/
public const SET_INTERNAL = '@internal';
/**
* @var callable
*/
private $functionFilter;
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Add leading `\` before function invocation to speed up resolving.',
[
new CodeSample(
<<<'PHP'
<?php
function baz($options)
{
if (!array_key_exists("foo", $options)) {
throw new \InvalidArgumentException();
}
return json_encode($options);
}
PHP,
),
new CodeSample(
<<<'PHP'
<?php
function baz($options)
{
if (!array_key_exists("foo", $options)) {
throw new \InvalidArgumentException();
}
return json_encode($options);
}
PHP,
[
'exclude' => [
'json_encode',
],
],
),
new CodeSample(
<<<'PHP'
<?php
namespace space1 {
echo count([1]);
}
namespace {
echo count([1]);
}
PHP,
['scope' => 'all'],
),
new CodeSample(
<<<'PHP'
<?php
namespace space1 {
echo count([1]);
}
namespace {
echo count([1]);
}
PHP,
['scope' => 'namespaced'],
),
new CodeSample(
<<<'PHP'
<?php
myGlobalFunction();
count();
PHP,
['include' => ['myGlobalFunction']],
),
new CodeSample(
<<<'PHP'
<?php
myGlobalFunction();
count();
PHP,
['include' => [self::SET_ALL]],
),
new CodeSample(
<<<'PHP'
<?php
myGlobalFunction();
count();
PHP,
['include' => [self::SET_INTERNAL]],
),
new CodeSample(
<<<'PHP'
<?php
$a .= str_repeat($a, 4);
$c = get_class($d);
PHP,
['include' => [self::SET_COMPILER_OPTIMIZED]],
),
],
null,
'Risky when any of the functions are overridden.',
);
}
/**
* {@inheritdoc}
*
* Must run before GlobalNamespaceImportFixer.
* Must run after BacktickToShellExecFixer, MbStrFunctionsFixer, RegularCallableCallFixer, StrictParamFixer.
*/
public function getPriority(): int
{
return 1;
}
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isTokenKindFound(\T_STRING);
}
public function isRisky(): bool
{
return true;
}
protected function configurePostNormalisation(): void
{
$this->functionFilter = $this->getFunctionFilter();
}
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
if ('all' === $this->configuration['scope']) {
$this->fixFunctionCalls($tokens, $this->functionFilter, 0, \count($tokens) - 1, false);
return;
}
$namespaces = $tokens->getNamespaceDeclarations();
// 'scope' is 'namespaced' here
foreach (array_reverse($namespaces) as $namespace) {
$this->fixFunctionCalls($tokens, $this->functionFilter, $namespace->getScopeStartIndex(), $namespace->getScopeEndIndex(), $namespace->isGlobalNamespace());
}
}
protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
{
return new FixerConfigurationResolver([
(new FixerOptionBuilder('exclude', 'List of functions to ignore.'))
->setAllowedTypes(['string[]'])
->setAllowedValues([static function (array $value): bool {
foreach ($value as $functionName) {
if ('' === trim($functionName) || trim($functionName) !== $functionName) {
throw new InvalidOptionsException(\sprintf(
'Each element must be a non-empty, trimmed string, got "%s" instead.',
get_debug_type($functionName),
));
}
}
return true;
}])
->setDefault([])
->getOption(),
(new FixerOptionBuilder('include', 'List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).'))
->setAllowedTypes(['string[]'])
->setAllowedValues([static function (array $value): bool {
foreach ($value as $functionName) {
if ('' === trim($functionName) || trim($functionName) !== $functionName) {
throw new InvalidOptionsException(\sprintf(
'Each element must be a non-empty, trimmed string, got "%s" instead.',
get_debug_type($functionName),
));
}
$sets = [
self::SET_ALL,
self::SET_INTERNAL,
self::SET_COMPILER_OPTIMIZED,
];
if (str_starts_with($functionName, '@') && !\in_array($functionName, $sets, true)) {
throw new InvalidOptionsException(\sprintf('Unknown set "%s", known sets are %s.', $functionName, Utils::naturalLanguageJoin($sets)));
}
}
return true;
}])
->setDefault([self::SET_COMPILER_OPTIMIZED])
->getOption(),
(new FixerOptionBuilder('scope', 'Only fix function calls that are made within a namespace or fix all.'))
->setAllowedValues(['all', 'namespaced'])
->setDefault('all')
->getOption(),
(new FixerOptionBuilder('strict', 'Whether leading `\` of function call not meant to have it should be removed.'))
->setAllowedTypes(['bool'])
->setDefault(true)
->getOption(),
]);
}
private function fixFunctionCalls(Tokens $tokens, callable $functionFilter, int $start, int $end, bool $tryToRemove): void
{
$functionsAnalyzer = new FunctionsAnalyzer();
$tokensToInsert = [];
for ($index = $start; $index < $end; ++$index) {
if (!$functionsAnalyzer->isGlobalFunctionCall($tokens, $index)) {
continue;
}
$prevIndex = $tokens->getPrevMeaningfulToken($index);
if (!$functionFilter($tokens[$index]->getContent()) || $tryToRemove) {
if (false === $this->configuration['strict']) {
continue;
}
if ($tokens[$prevIndex]->isGivenKind(\T_NS_SEPARATOR)) {
$tokens->clearTokenAndMergeSurroundingWhitespace($prevIndex);
}
continue;
}
if ($tokens[$prevIndex]->isGivenKind(\T_NS_SEPARATOR)) {
continue; // do not bother if previous token is already namespace separator
}
$tokensToInsert[$index] = new Token([\T_NS_SEPARATOR, '\\']);
}
$tokens->insertSlices($tokensToInsert);
}
private function getFunctionFilter(): callable
{
$exclude = $this->normalizeFunctionNames($this->configuration['exclude']);
if (\in_array(self::SET_ALL, $this->configuration['include'], true)) {
if (\count($exclude) > 0) {
return static fn (string $functionName): bool => !isset($exclude[strtolower($functionName)]);
}
return static fn (): bool => true;
}
$include = [];
if (\in_array(self::SET_INTERNAL, $this->configuration['include'], true)) {
$include = $this->getAllInternalFunctionsNormalized();
} elseif (\in_array(self::SET_COMPILER_OPTIMIZED, $this->configuration['include'], true)) {
$include = $this->getAllCompilerOptimizedFunctionsNormalized(); // if `@internal` is set all compiler optimized function are already loaded
}
foreach ($this->configuration['include'] as $additional) {
if (!str_starts_with($additional, '@')) {
$include[strtolower($additional)] = true;
}
}
if (\count($exclude) > 0) {
return static fn (string $functionName): bool => isset($include[strtolower($functionName)]) && !isset($exclude[strtolower($functionName)]);
}
return static fn (string $functionName): bool => isset($include[strtolower($functionName)]);
}
/**
* @return array<string, true> normalized function names of which the PHP compiler optimizes
*/
private function getAllCompilerOptimizedFunctionsNormalized(): array
{
return $this->normalizeFunctionNames([
// @see https://github.com/php/php-src/blob/PHP-7.4/Zend/zend_compile.c "zend_try_compile_special_func"
'array_key_exists',
'array_slice',
'assert',
'boolval',
'call_user_func',
'call_user_func_array',
'chr',
'count',
'defined',
'doubleval',
'floatval',
'func_get_args',
'func_num_args',
'get_called_class',
'get_class',
'gettype',
'in_array',
'intval',
'is_array',
'is_bool',
'is_double',
'is_float',
'is_int',
'is_integer',
'is_long',
'is_null',
'is_object',
'is_real',
'is_resource',
'is_scalar',
'is_string',
'ord',
'sizeof',
'sprintf',
'strlen',
'strval',
// @see https://github.com/php/php-src/blob/php-7.2.6/ext/opcache/Optimizer/pass1_5.c
// @see https://github.com/php/php-src/blob/PHP-8.1.2/Zend/Optimizer/block_pass.c
// @see https://github.com/php/php-src/blob/php-8.1.3/Zend/Optimizer/zend_optimizer.c
'constant',
'define',
'dirname',
'extension_loaded',
'function_exists',
'is_callable',
'ini_get',
]);
}
/**
* @return array<string, true> normalized function names of all internal defined functions
*/
private function getAllInternalFunctionsNormalized(): array
{
return $this->normalizeFunctionNames(get_defined_functions()['internal']);
}
/**
* @param list<string> $functionNames
*
* @return array<string, true> all function names lower cased
*/
private function normalizeFunctionNames(array $functionNames): array
{
$result = [];
foreach ($functionNames as $functionName) {
$result[strtolower($functionName)] = true;
}
return $result;
}
}