106 lines
4.0 KiB
PHP
106 lines
4.0 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of the TYPO3 CMS project.
|
|
*
|
|
* It is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License, either version 2
|
|
* of the License, or any later version.
|
|
*
|
|
* For the full copyright and license information, please read the
|
|
* LICENSE.txt file that was distributed with this source code.
|
|
*
|
|
* The TYPO3 project - inspiring people to share!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Install\ExtensionScanner\Php\Matcher;
|
|
|
|
use PhpParser\Modifiers;
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr\MethodCall;
|
|
use PhpParser\Node\Identifier;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
|
|
/**
|
|
* Matches interface method arguments which have been dropped.
|
|
*
|
|
* This does *not* test if a class implements an interface.
|
|
* The scanner only looks for:
|
|
* - Class method names not having specified number of arguments
|
|
* - Method calls with given method name not having this number of arguments
|
|
* @internal This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
|
|
*/
|
|
class InterfaceMethodChangedMatcher extends AbstractCoreMatcher
|
|
{
|
|
/**
|
|
* Default constructor validates config
|
|
*
|
|
* @param array $matcherDefinitions Incoming main configuration
|
|
*/
|
|
public function __construct(array $matcherDefinitions)
|
|
{
|
|
$this->matcherDefinitions = $matcherDefinitions;
|
|
// newNumberOfArguments must exist in all matcherDefinitions
|
|
$this->validateMatcherDefinitions(['newNumberOfArguments']);
|
|
}
|
|
|
|
/**
|
|
* Called by PhpParser.
|
|
* Test for "public function like($arg1, $arg2, $arg3) {}" (weak match)
|
|
* Test for "->like($arg1, $arg2, $arg3); (weak match)
|
|
*/
|
|
public function enterNode(Node $node): null
|
|
{
|
|
if ($this->isFileIgnored($node) || $this->isLineIgnored($node)) {
|
|
return null;
|
|
}
|
|
|
|
// Match method name of a class, must be public, wouldn't make sense as interface if protected/private
|
|
if ($node instanceof ClassMethod
|
|
&& array_key_exists($node->name->name, $this->matcherDefinitions)
|
|
&& $node->flags & Modifiers::PUBLIC // public
|
|
&& ($node->flags & Modifiers::STATIC) !== Modifiers::STATIC // not static
|
|
) {
|
|
$methodName = $node->name->name;
|
|
$numberOfUsedArguments = 0;
|
|
if (is_array($node->params ?? null)) {
|
|
$numberOfUsedArguments = count($node->params);
|
|
}
|
|
$numberOfAllowedArguments = $this->matcherDefinitions[$methodName]['newNumberOfArguments'];
|
|
if ($numberOfUsedArguments > $numberOfAllowedArguments) {
|
|
$this->matches[] = [
|
|
'restFiles' => $this->matcherDefinitions[$methodName]['restFiles'],
|
|
'line' => $node->getAttribute('startLine'),
|
|
'message' => 'Implementation of dropped interface argument for method "' . $methodName . '()"',
|
|
'indicator' => 'weak',
|
|
];
|
|
}
|
|
}
|
|
|
|
// Match method call (not static) with number of arguments
|
|
if ($node instanceof MethodCall
|
|
&& $node->name instanceof Identifier
|
|
&& array_key_exists($node->name->name, $this->matcherDefinitions)
|
|
) {
|
|
$methodName = $node->name->name;
|
|
$numberOfUsedArguments = 0;
|
|
if (is_array($node->args ?? null)) {
|
|
$numberOfUsedArguments = count($node->args);
|
|
}
|
|
// @todo: Test for argument unpacking
|
|
$numberOfAllowedArguments = $this->matcherDefinitions[$methodName]['newNumberOfArguments'];
|
|
if ($numberOfUsedArguments > $numberOfAllowedArguments) {
|
|
$this->matches[] = [
|
|
'restFiles' => $this->matcherDefinitions[$methodName]['restFiles'],
|
|
'line' => $node->getAttribute('startLine'),
|
|
'message' => 'Call to interface method "' . $methodName . '()"',
|
|
'indicator' => 'weak',
|
|
];
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
}
|