Created Sniff to validate function without argument

[anzin]

Description (*)

Added sniff for check deprecated function without argument.

Addresses backward incompatible change in PHP 8.1: https://wiki.php.net/rfc/deprecations_php_8_1

Fixed Issues (if relevant)

1. Add new sniff Magento2.Functions.DeprecatedFunction into magento-coding-standard magento2#34547

Contribution checklist (*)

• Author has signed the Adobe CLA
• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[sivaschenko]

Thanks for the pull request @anzin , please see my comments

[sivaschenko]

Can it be simplified considering there is only one test file?

Suggested change

	if ($testFile === 'DeprecatedFunctionUnitTest.inc') {
	return [
	23 => 1
	];
	}
	return [];
	return [
	23 => 1
	];

[sivaschenko]

I believe the following functions should be added to the list:

• get_class
• get_parent_class
• get_called_class

According to https://wiki.php.net/rfc/deprecations_php_8_1

[sivaschenko]

I think the following name would better describe the purpose of this sniff

Suggested change

	class DeprecatedFunctionSniff implements Sniff
	class FunctionsDeprecatedWithoutArgumentSniff implements Sniff

[sivaschenko]

Suggested change

	* Sniff to validate PHP deprecated function.
	* Sniff to validate PHP functions usage of which without passing arguments is deprecated.

[sivaschenko]

Can you please provide a suggestion on how to fix this issue in the message?

[sivaschenko]

A good approach for phpcs tests (that also matches the design of this static testing library) is utilizing the iteration that is already done by the library instead of registering T_OPEN_TAG to process every file and performing an additional custom parsing/iteration of the file.

Please see an example of the implementation where each invoked relevant token is analyzed:

/**
     * Deprecated functions without argument.
     *
     * @var array
     */
    private $deprecatedFunctions = [
        'mb_check_encoding' => 'Calling function mb_check_encoding() without argument is deprecated in PHP 8.1. '
            . 'Please pass the input to check for encoding as the first argument of the function.'
    ];

    /**
     * @inheritdoc
     */
    public function register(): array
    {
        return [
            T_OPEN_PARENTHESIS
        ];
    }

    /**
     * @inheritdoc
     */
    public function process(File $phpcsFile, $stackPtr): void
    {
        $closeParenthesisPtr = $phpcsFile->findNext(T_CLOSE_PARENTHESIS, $stackPtr);
        $arguments = trim($phpcsFile->getTokensAsString($stackPtr + 1, $closeParenthesisPtr - $stackPtr - 1));
        if ($arguments) {
            return;
        }

        $functionName = $phpcsFile->getTokensAsString($phpcsFile->findPrevious(T_STRING, $stackPtr), 1);

        if (isset($this->deprecatedFunctions[$functionName])) {
            $phpcsFile->addWarning($this->deprecatedFunctions[$functionName], $stackPtr, 'FunctionDeprecatedWithoutArguments');
        }
    }

[anzin]

Hello @sivaschenko , thanks for your review, I fixed code by you recommendation, please check if every think fine.

[sivaschenko]

Thanks for the update @anzin ! The implementation looks great!

The final thing that I'd recommend to improve the sniff is using constants instead of variables for the values that are not supposed to be changed/updated in runtime.

[sivaschenko]

Suggested change

	private $deprecatedFunctions = [
	private const FUNCTIONS_LIST = [

[sivaschenko]

Suggested change

	private $warningCode = 'FunctionsDeprecatedWithoutArgument';
	private const WARNING_CODE = 'FunctionsDeprecatedWithoutArgument';

[sivaschenko]

Suggested change

	private $warningMessage = 'Calling function %s() without argument is deprecated in PHP 8.1. '
	private const WARNING_MESSAGE = 'Calling function %s() without argument is deprecated in PHP 8.1. '

[sivaschenko]

Suggested change

	if (in_array($functionName, $this->deprecatedFunctions)) {
	if (in_array($functionName, self::FUNCTIONS_LIST)) {

[sivaschenko]

Suggested change

	$phpcsFile->addWarning(sprintf($this->warningMessage, $functionName), $stackPtr, $this->warningCode);
	$phpcsFile->addWarning(sprintf(self::WARNING_MESSAGE, $functionName), $stackPtr, self::WARNING_CODE);

[anzin]

Hello @sivaschenko, I fixed code by you recommendation, please check if every think fine.

[sivaschenko]

@magento import pr to magento-commerce/magento-coding-standard

[m2-github-services]

@sivaschenko an error occurred during the Pull Request import.