ee3875eb4e
* Qual: Generate phan specific changed php files list # Qual: Generate phan specific changed php files list Uses multiple parts of the Phan configuration to select and exclude files for phan analysis. * avoid catching special characters in regexes as indicators of french * Qual: Translate french to english
104 lines
3 KiB
PHP
104 lines
3 KiB
PHP
<?php
|
|
/* Copyright (C) 2025 Frédéric France <frederic.france@free.fr>
|
|
* Copyright (C) 2026 MDW <mdeweerd@users.noreply.github.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace codesniffer\Sniffs\Dolibarr;
|
|
|
|
use PHP_CodeSniffer\Sniffs\Sniff;
|
|
use PHP_CodeSniffer\Files\File;
|
|
|
|
/**
|
|
* CheckIsModEnabledArgumentSniff
|
|
*/
|
|
class CheckIsModEnabledArgumentSniff implements Sniff
|
|
{
|
|
// Target function name
|
|
protected $targetFunction = 'ismodenabled';
|
|
|
|
protected $deprecatedModulesNames = [
|
|
'actioncomm' => 'agenda',
|
|
'adherent' => 'member',
|
|
'adherent_type' => 'member_type',
|
|
'banque' => 'bank',
|
|
'categorie' => 'category',
|
|
'commande' => 'order',
|
|
'contrat' => 'contract',
|
|
'entrepot' => 'stock',
|
|
'expedition' => 'shipping',
|
|
'facture' => 'invoice',
|
|
'ficheinter' => 'intervention',
|
|
'product_fournisseur_price' => 'productsupplierprice',
|
|
'product_price' => 'productprice',
|
|
'projet' => 'project',
|
|
'propale' => 'propal',
|
|
'socpeople' => 'contact',
|
|
];
|
|
|
|
/**
|
|
* register
|
|
*
|
|
* @return void
|
|
*/
|
|
public function register()
|
|
{
|
|
// We are listening function calls (T_STRING)
|
|
return [T_STRING];
|
|
}
|
|
|
|
/**
|
|
* process
|
|
*
|
|
* @param File $phpcsFile file to process
|
|
* @param mixed $stackPtr pointer
|
|
* @return void
|
|
*/
|
|
public function process(File $phpcsFile, $stackPtr)
|
|
{
|
|
$tokens = $phpcsFile->getTokens();
|
|
|
|
if (strtolower($tokens[$stackPtr]['content']) !== strtolower($this->targetFunction)) {
|
|
return;
|
|
}
|
|
|
|
// Check that it is a function call (followed by '(')
|
|
$openParen = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
|
|
if ($tokens[$openParen]['code'] !== T_OPEN_PARENTHESIS) {
|
|
return;
|
|
}
|
|
|
|
// We are looking for the first 'useful' token after the parenthesis
|
|
$firstArgTokenPtr = $phpcsFile->findNext(T_WHITESPACE, $openParen + 1, null, true);
|
|
|
|
// If the function is called without arguments (isModEnabled()), we stop
|
|
if ($tokens[$firstArgTokenPtr]['code'] === T_CLOSE_PARENTHESIS) {
|
|
return;
|
|
}
|
|
|
|
// Check argument value
|
|
$argContent = str_replace(["'", '"'], '', $tokens[$firstArgTokenPtr]['content']);
|
|
$argCode = $tokens[$firstArgTokenPtr]['code'];
|
|
|
|
if (array_key_exists($argContent, $this->deprecatedModulesNames)) {
|
|
$phpcsFile->addError(
|
|
'The function "%s" has deprecated argument ("%s") to replace with "%s".',
|
|
$firstArgTokenPtr,
|
|
'DeprecatedArgument',
|
|
[$tokens[$stackPtr]['content'], $argContent, $this->deprecatedModulesNames[$argContent]]
|
|
);
|
|
}
|
|
}
|
|
}
|