0
0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2024-11-24 07:26:13 +00:00
PocketMine-MP/tests/phpstan/rules/DisallowEnumComparisonRule.php
2022-06-04 17:34:49 +01:00

91 lines
2.7 KiB
PHP

<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\phpstan\rules;
use PhpParser\Node;
use PhpParser\Node\Expr\BinaryOp;
use PhpParser\Node\Expr\BinaryOp\Identical;
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use pocketmine\utils\EnumTrait;
use function sprintf;
/**
* @phpstan-implements Rule<BinaryOp>
*/
class DisallowEnumComparisonRule implements Rule{
public function getNodeType() : string{
return BinaryOp::class;
}
public function processNode(Node $node, Scope $scope) : array{
if(!($node instanceof Identical) && !($node instanceof NotIdentical)){
return [];
}
$leftType = $scope->getType($node->left);
$rightType = $scope->getType($node->right);
$leftEnum = $this->checkForEnumTypes($leftType);
$rightEnum = $this->checkForEnumTypes($rightType);
if($leftEnum && $rightEnum){
return [RuleErrorBuilder::message(sprintf(
'Strict comparison using %s involving enum types %s and %s is not reliable.',
$node instanceof Identical ? '===' : '!==',
$leftType->describe(VerbosityLevel::value()),
$rightType->describe(VerbosityLevel::value())
))->build()];
}
return [];
}
private function checkForEnumTypes(Type $comparedType) : bool{
//TODO: what we really want to do here is iterate over the contained types, but there's no universal way to
//do that. This might break with other circumstances.
if($comparedType instanceof ObjectType){
$types = [$comparedType];
}elseif($comparedType instanceof UnionType){
$types = $comparedType->getTypes();
}else{
return false;
}
foreach($types as $containedType){
if(!($containedType instanceof ObjectType)){
continue;
}
$class = $containedType->getClassReflection();
if($class !== null && $class->hasTraitUse(EnumTrait::class)){
return true;
}
}
return false;
}
}