psalm/src/Psalm/Checker/FunctionLikeChecker.php

<?php
namespace Psalm\Checker;

use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PhpParser;
use Psalm\CodeLocation;
use Psalm\Checker\Statements\ExpressionChecker;
use Psalm\Context;
use Psalm\EffectsAnalyser;
use Psalm\Exception\DocblockParseException;
use Psalm\FunctionLikeParameter;
use Psalm\Issue\InvalidDocblock;
use Psalm\Issue\InvalidReturnType;
use Psalm\Issue\MethodSignatureMismatch;
use Psalm\Issue\MissingReturnType;
use Psalm\Issue\MixedInferredReturnType;
use Psalm\IssueBuffer;
use Psalm\StatementsSource;
use Psalm\Type;

abstract class FunctionLikeChecker extends SourceChecker implements StatementsSource
{
    const RETURN_TYPE_REGEX = '/\\:\s+(\\??[A-Za-z0-9_\\\\]+)/';

    /**
     * @var Closure|Function_|ClassMethod
     */
    protected $function;

    /**
     * @var string
     */
    protected $namespace;

    /**
     * @var bool
     */
    protected $is_static = false;

    /**
     * @var string
     */
    protected $fq_class_name;

    /**
     * @var StatementsChecker|null
     */
    protected $statements_checker;

    /**
     * @var StatementsSource
     */
    protected $source;

    /**
     * @var array<string,array<string,Psalm\Type\Union>>
     */
    protected $return_vars_in_scope = [];

    /**
     * @var array<string,array<string,bool>>
     */
    protected $return_vars_possibly_in_scope = [];

    /**
     * @var string|null
     */
    protected $class_name;

    /**
     * @var string|null
     */
    protected $class_extends;

    /**
     * @var array<string, array>
     */
    protected static $no_effects_hashes = [];

    /**
     * @param Closure|Function_|ClassMethod $function
     * @param StatementsSource $source
     */
    public function __construct($function, StatementsSource $source)
    {
        $this->function = $function;
        $this->namespace = $source->getNamespace();
        $this->class_name = $source->getClassName();
        $this->class_extends = $source->getParentClass();
        $this->file_name = $source->getFileName();
        $this->file_path = $source->getFilePath();
        $this->include_file_name = $source->getIncludeFileName();
        $this->include_file_path = $source->getIncludeFilePath();
        $this->fq_class_name = $source->getFQCLN();
        $this->source = $source;
        $this->suppressed_issues = $source->getSuppressedIssues();
        $this->aliased_classes = $source->getAliasedClasses();
        $this->aliased_constants = $source->getAliasedConstants();
        $this->aliased_functions = $source->getAliasedFunctions();
    }

    /**
     * @param Context       $context
     * @param Context|null  $global_context
     * @return false|null
     */
    public function check(Context $context, Context $global_context = null)
    {
        if ($function_stmts = $this->function->getStmts()) {
            $statements_checker = new StatementsChecker($this);

            $hash = null;

            if ($this instanceof MethodChecker) {
                if (ClassLikeChecker::getThisClass()) {
                    $hash = $this->getMethodId() . json_encode([
                        $context->vars_in_scope,
                            $context->vars_possibly_in_scope
                        ]);

                    // if we know that the function has no effects on vars, we don't bother rechecking
                    if (isset(self::$no_effects_hashes[$hash])) {
                        list(
                            $context->vars_in_scope,
                            $context->vars_possibly_in_scope
                        ) = self::$no_effects_hashes[$hash];

                        return null;
                    }
                } elseif ($context->self) {
                    $context->vars_in_scope['$this'] = new Type\Union([new Type\Atomic($context->self)]);
                }

                $function_params = MethodChecker::getMethodParams((string)$this->getMethodId());

                if ($function_params === null) {
                    throw new \InvalidArgumentException('Cannot get params for own method');
                }

                $implemented_method_ids = MethodChecker::getOverriddenMethodIds((string)$this->getMethodId());

                if ($implemented_method_ids) {
                    $have_emitted = false;

                    foreach ($implemented_method_ids as $implemented_method_id) {
                        if ($have_emitted) {
                            break;
                        }

                        if ($implemented_method_id === 'ArrayObject::__construct') {
                            continue;
                        }

                        $implemented_params = MethodChecker::getMethodParams($implemented_method_id);

                        if ($implemented_params === null) {
                            continue;
                        }

                        foreach ($implemented_params as $i => $implemented_param) {
                            if (!isset($function_params[$i])) {
                                $cased_method_id = MethodChecker::getCasedMethodId((string)$this->getMethodId());
                                $parent_method_id = MethodChecker::getCasedMethodId($implemented_method_id);

                                if (IssueBuffer::accepts(
                                    new MethodSignatureMismatch(
                                        'Method ' . $cased_method_id .' has fewer arguments than parent method ' .
                                            $parent_method_id,
                                        new CodeLocation($this, $this->function)
                                    )
                                )) {
                                    return false;
                                }

                                $have_emitted = true;
                                break;
                            }

                            if ((string)$function_params[$i]->signature_type !==
                                (string)$implemented_param->signature_type
                            ) {
                                $cased_method_id = MethodChecker::getCasedMethodId((string)$this->getMethodId());
                                $parent_method_id = MethodChecker::getCasedMethodId($implemented_method_id);

                                if (IssueBuffer::accepts(
                                    new MethodSignatureMismatch(
                                        'Argument ' . ($i + 1) . ' of ' . $cased_method_id .' has wrong type \'' .
                                            $function_params[$i]->signature_type . '\', expecting \'' .
                                            $implemented_param->signature_type . '\' as defined by ' .
                                            $parent_method_id,
                                        new CodeLocation($this, $this->function)
                                    )
                                )) {
                                    return false;
                                }

                                $have_emitted = true;
                                break;
                            }
                        }
                    }
                }
            } elseif ($this instanceof FunctionChecker) {
                $function_params = FunctionChecker::getParams(strtolower((string)$this->getMethodId()), $this->file_name);
            } else { // Closure
                $function_params = [];
                $function_param_names = [];

                foreach ($this->function->getParams() as $param) {
                    $param_array = self::getTranslatedParam(
                        $param,
                        $this
                    );

                    $function_params[] = $param_array;
                    $function_param_names[$param->name] = $param_array->type;
                }

                $doc_comment = $this->function->getDocComment();

                if ($doc_comment) {
                    try {
                        $docblock_info = CommentChecker::extractDocblockInfo(
                            (string)$doc_comment,
                            $doc_comment->getLine()
                        );
                    } catch (DocblockParseException $e) {
                        if (IssueBuffer::accepts(
                            new InvalidDocblock(
                                'Invalid type passed in docblock for ' . $this->getMethodId(),
                                new CodeLocation($this, $this->function, true)
                            )
                        )) {
                            return false;
                        }
                    }

                    if ($docblock_info) {
                        $this->suppressed_issues = $docblock_info->suppress;

                        $config = \Psalm\Config::getInstance();

                        if ($config->use_docblock_types) {
                            if ($docblock_info->return_type) {
                                $return_type =
                                    Type::parseString(
                                        self::fixUpLocalType(
                                            (string)$docblock_info->return_type,
                                            null,
                                            $this->namespace,
                                            $this->getAliasedClasses()
                                        )
                                    );
                            }

                            if ($docblock_info->params) {
                                $this->improveParamsFromDocblock(
                                    $docblock_info->params,
                                    $function_param_names,
                                    $function_params,
                                    new CodeLocation($this, $this->function, false)
                                );
                            }
                        }
                    }
                }
            }

            foreach ($function_params as $function_param) {
                $param_type = ExpressionChecker::fleshOutTypes(
                    clone $function_param->type,
                    [],
                    $context->self,
                    $this->getMethodId()
                );

                if (!$function_param->code_location) {
                    throw new \UnexpectedValueException('We should know where this code is');
                }

                foreach ($param_type->types as $atomic_type) {
                    if ($atomic_type->isObjectType()
                        && !$atomic_type->isObject()
                        && $this->function instanceof PhpParser\Node
                        && ClassLikeChecker::checkFullyQualifiedClassLikeName(
                            $atomic_type->value,
                            $function_param->code_location,
                            $this->suppressed_issues
                        ) === false
                    ) {
                        return false;
                    }
                }

                $context->vars_in_scope['$' . $function_param->name] = $param_type;

                $statements_checker->registerVariable($function_param->name, $function_param->code_location->line_number);
            }

            $statements_checker->check($function_stmts, $context, null, $global_context);

            if (isset($this->return_vars_in_scope[''])) {
                $context->vars_in_scope = TypeChecker::combineKeyedTypes(
                    $context->vars_in_scope,
                    $this->return_vars_in_scope['']
                );
            }

            if (isset($this->return_vars_possibly_in_scope[''])) {
                $context->vars_possibly_in_scope = array_merge(
                    $context->vars_possibly_in_scope,
                    $this->return_vars_possibly_in_scope['']
                );
            }

            foreach ($context->vars_in_scope as $var => $type) {
                if (strpos($var, '$this->') !== 0) {
                    unset($context->vars_in_scope[$var]);
                }
            }

            foreach ($context->vars_possibly_in_scope as $var => $type) {
                if (strpos($var, '$this->') !== 0) {
                    unset($context->vars_possibly_in_scope[$var]);
                }
            }

            if ($hash && ClassLikeChecker::getThisClass() && $this instanceof MethodChecker) {
                self::$no_effects_hashes[$hash] = [
                    $context->vars_in_scope,
                    $context->vars_possibly_in_scope
                ];
            }
        }

        return null;
    }

    /**
     * Adds return types for the given function
     *
     * @param   string  $return_type
     * @param   Context $context
     * @return  void
     */
    public function addReturnTypes($return_type, Context $context)
    {
        if (isset($this->return_vars_in_scope[$return_type])) {
            $this->return_vars_in_scope[$return_type] = TypeChecker::combineKeyedTypes(
                $context->vars_in_scope,
                $this->return_vars_in_scope[$return_type]
            );
        } else {
            $this->return_vars_in_scope[$return_type] = $context->vars_in_scope;
        }

        if (isset($this->return_vars_possibly_in_scope[$return_type])) {
            $this->return_vars_possibly_in_scope[$return_type] = array_merge(
                $context->vars_possibly_in_scope,
                $this->return_vars_possibly_in_scope[$return_type]
            );
        } else {
            $this->return_vars_possibly_in_scope[$return_type] = $context->vars_possibly_in_scope;
        }
    }

    /**
     * @return null|string
     */
    public function getMethodId()
    {
        if ($this->function instanceof ClassMethod) {
            $function_name = (string)$this->function->name;

            if (strtolower($function_name) === strtolower((string)$this->class_name)) {
                $function_name = '__construct';
            }

            return $this->fq_class_name . '::' . strtolower($function_name);
        }

        if ($this->function instanceof Function_) {
            return ($this->namespace ? $this->namespace . '\\' : '') . strtolower($this->function->name);
        }

        return null;
    }

    /**
     * @return string
     */
    public function getNamespace()
    {
        return $this->namespace;
    }

    /**
     * @return array<string, string>
     */
    public function getAliasedClassesFlipped()
    {
        if ($this->source instanceof NamespaceChecker || $this->source instanceof FileChecker || $this->source instanceof ClassLikeChecker) {
            return $this->source->getAliasedClassesFlipped();
        }

        return [];
    }

    /**
     * @return string
     */
    public function getFQCLN()
    {
        return $this->fq_class_name;
    }

    /**
     * @return null|string
     */
    public function getClassName()
    {
        return $this->class_name;
    }

    /**
     * @return mixed
     */
    public function getClassLikeChecker()
    {
        return $this->source->getClassLikeChecker();
    }

    /**
     * @return string|null
     */
    public function getParentClass()
    {
        return $this->class_extends;
    }

    /**
     * @return bool
     */
    public function isStatic()
    {
        return $this->is_static;
    }

    /**
     * @return StatementsSource
     */
    public function getSource()
    {
        return $this->source;
    }

    /**
     * @param   bool $update_docblock
     * @return  false|null
     */
    public function checkReturnTypes($update_docblock = false)
    {
        if (!$this->function->getStmts()) {
            return null;
        }

        if ($this->function instanceof ClassMethod && substr($this->function->name, 0, 2) === '__') {
            // do not check __construct, __set, __get, __call etc.
            return null;
        }

        $method_id = (string)$this->getMethodId();
        $cased_method_id = $this instanceof MethodChecker ? MethodChecker::getCasedMethodId($method_id) : $method_id;

        $secondary_return_type_location = null;

        if ($this instanceof MethodChecker) {
            $return_type = MethodChecker::getMethodReturnType($method_id);
            $return_type_location = MethodChecker::getMethodReturnTypeLocation($method_id, $secondary_return_type_location);
        } else {
            try {
                $return_type = FunctionChecker::getFunctionReturnType($method_id, $this->file_name);
                $return_type_location = FunctionChecker::getFunctionReturnTypeLocation($method_id, $this->file_name);
            } catch (\Exception $e) {
                $return_type = null;
                $return_type_location = null;
            }
        }

        if (!$return_type_location) {
            $return_type_location = new CodeLocation($this, $this->function, true);
        }

        if (!$return_type && !$update_docblock) {
            if (IssueBuffer::accepts(
                new MissingReturnType(
                    'Method ' . $cased_method_id . ' does not have a return type',
                    new CodeLocation($this, $this->function, true)
                ),
                $this->suppressed_issues
            )) {
                // fall through
            }

            return null;
        }

        $inferred_yield_types = [];
        $inferred_return_types = EffectsAnalyser::getReturnTypes(
            $this->function->getStmts(),
            $inferred_yield_types,
            true
        );

        $inferred_return_type = $inferred_return_types ? Type::combineTypes($inferred_return_types) : Type::getVoid();
        $inferred_yield_type = $inferred_yield_types ? Type::combineTypes($inferred_yield_types) : null;

        $inferred_generator_return_type = null;

        if ($inferred_yield_type) {
            $inferred_generator_return_type = $inferred_return_type;
            $inferred_return_type = $inferred_yield_type;
        }

        if (!$return_type) {
            if ($inferred_return_type && !$inferred_return_type->isMixed()) {
                FileChecker::addDocblockReturnType(
                    $this->file_name,
                    $this->function->getLine(),
                    (string)$this->function->getDocComment(),
                    $inferred_return_type->toNamespacedString($this->getAliasedClassesFlipped(), $this->getFQCLN(), false),
                    $inferred_return_type->toNamespacedString($this->getAliasedClassesFlipped(), $this->getFQCLN(), true)
                );
            }

            return null;
        }

        // passing it through fleshOutTypes eradicates errant $ vars
        $declared_return_type = ExpressionChecker::fleshOutTypes(
            $return_type,
            [],
            $this->fq_class_name,
            $method_id
        );

        if (!$inferred_return_types && !$inferred_yield_types) {
            if ($declared_return_type->isVoid()) {
                return null;
            }

            if (ScopeChecker::onlyThrows($this->function->getStmts())) {
                // if there's a single throw statement, it's presumably an exception saying this method is not to be
                // used
                return null;
            }

            if (IssueBuffer::accepts(
                new InvalidReturnType(
                    'No return statements were found for method ' . $cased_method_id .
                        ' but return type \'' . $declared_return_type . '\' was expected',
                    $secondary_return_type_location ?: $return_type_location
                )
            )) {
                return false;
            }

            return null;
        }

        if ($inferred_return_type && !$declared_return_type->isMixed()) {
            if ($inferred_return_type->isVoid() && $declared_return_type->isVoid()) {
                return null;
            }

            if ($inferred_return_type->isMixed()) {
                if (IssueBuffer::accepts(
                    new MixedInferredReturnType(
                        'Could not verify return type \'' . $declared_return_type . '\' for ' .
                            $cased_method_id,
                        $secondary_return_type_location ?: $return_type_location
                    ),
                    $this->getSuppressedIssues()
                )) {
                    return false;
                }

                return null;
            }

            if (!TypeChecker::hasIdenticalTypes(
                $declared_return_type,
                $inferred_return_type,
                $this->fq_class_name
            )) {
                if ($update_docblock) {
                    if (!in_array('InvalidReturnType', $this->getSuppressedIssues())) {
                        FileChecker::addDocblockReturnType(
                            $this->file_name,
                            $this->function->getLine(),
                            (string)$this->function->getDocComment(),
                            $inferred_return_type->toNamespacedString($this->getAliasedClassesFlipped(), $this->getFQCLN(), false),
                            $inferred_return_type->toNamespacedString($this->getAliasedClassesFlipped(), $this->getFQCLN(), true)
                        );
                    }

                    return null;
                }

                if (IssueBuffer::accepts(
                    new InvalidReturnType(
                        'The given return type \'' . $declared_return_type . '\' for ' . $cased_method_id .
                            ' is incorrect, got \'' . $inferred_return_type . '\'',
                        $secondary_return_type_location ?: $return_type_location
                    ),
                    $this->getSuppressedIssues()
                )) {
                    return false;
                }
            }
        }

        return null;
    }

    /**
     * @param  array<array{type:string,name:string,line_number:int}>  $docblock_params
     * @param  array<string,Type\Union>               $function_param_names
     * @param  array<\Psalm\FunctionLikeParameter>    &$function_signature
     * @param  CodeLocation                           $code_location
     * @return false|null
     */
    protected function improveParamsFromDocblock(
        array $docblock_params,
        array $function_param_names,
        array &$function_signature,
        CodeLocation $code_location
    ) {
        $docblock_param_vars = [];

        foreach ($docblock_params as $docblock_param) {
            $param_name = $docblock_param['name'];
            $line_number = $docblock_param['line_number'];

            if (!array_key_exists($param_name, $function_param_names)) {
                $code_location->setCommentLine($line_number);
                if (IssueBuffer::accepts(
                    new InvalidDocblock(
                        'Parameter $' . $param_name .' does not appear in the argument list for ' .
                            $this->getMethodId(),
                        $code_location
                    )
                )) {
                    return false;
                }

                continue;
            }

            $docblock_param_vars[$param_name] = true;

            $new_param_type = Type::parseString(
                self::fixUpLocalType(
                    $docblock_param['type'],
                    null,
                    $this->namespace,
                    $this->getAliasedClasses()
                )
            );

            if ($function_param_names[$param_name] && !$function_param_names[$param_name]->isMixed()) {
                if (!$new_param_type->isIn($function_param_names[$param_name])) {
                    $code_location->setCommentLine($line_number);
                    if (IssueBuffer::accepts(
                        new InvalidDocblock(
                            'Parameter $' . $param_name .' has wrong type \'' . $new_param_type . '\', should be \'' .
                                $function_param_names[$param_name] . '\'',
                            $code_location
                        )
                    )) {
                        return false;
                    }

                    continue;
                }
            }

            foreach ($function_signature as &$function_signature_param) {
                if ($function_signature_param->name === $param_name) {
                    $existing_param_type_nullable = $function_signature_param->is_nullable;

                    if ($existing_param_type_nullable && !$new_param_type->isNullable()) {
                        $new_param_type->types['null'] = new Type\Atomic('null');
                    }

                    $function_signature_param->signature_type = $function_signature_param->type;
                    $function_signature_param->type = $new_param_type;
                    break;
                }
            }
        }

        foreach ($function_signature as &$function_signature_param) {
            if (!isset($docblock_param_vars[$function_signature_param->name]) && $function_signature_param->code_location) {
                if (IssueBuffer::accepts(
                    new InvalidDocblock(
                        'Parameter $' . $function_signature_param->name .' does not appear in the docbock for ' .
                            $this->getMethodId(),
                        $function_signature_param->code_location
                    )
                )) {
                    return false;
                }

                continue;
            }
        }

        return null;
    }

    /**
     * @param  PhpParser\Node\Param $param
     * @param  StatementsSource     $source
     * @return FunctionLikeParameter
     */
    public static function getTranslatedParam(
        PhpParser\Node\Param $param,
        StatementsSource $source
    ) {
        $param_type = null;

        $is_nullable = $param->default !== null &&
            $param->default instanceof \PhpParser\Node\Expr\ConstFetch &&
            $param->default->name instanceof PhpParser\Node\Name &&
            strtolower($param->default->name->parts[0]) === 'null';

        $param_typehint = $param->type;

        if ($param_typehint instanceof PhpParser\Node\NullableType) {
            $is_nullable = true;
            $param_typehint = $param_typehint->type;
        }

        if ($param_typehint) {
            if (is_string($param_typehint)) {
                $param_type_string = $param_typehint;
            } elseif ($param_typehint instanceof PhpParser\Node\Name\FullyQualified) {
                $param_type_string = implode('\\', $param_typehint->parts);
            } elseif ($param_typehint->parts === ['self']) {
                $param_type_string = $source->getFQCLN();
            } else {
                $param_type_string = ClassLikeChecker::getFQCLNFromString(
                    implode('\\', $param_typehint->parts),
                    $source->getNamespace(),
                    $source->getAliasedClasses()
                );
            }

            if ($param_type_string) {
                if ($is_nullable) {
                    $param_type_string .= '|null';
                }

                $param_type = Type::parseString($param_type_string);

                if ($param->variadic) {
                    $param_type = new Type\Union([
                        new Type\GenericArray(
                            'array',
                            [
                                Type::getInt(),
                                $param_type
                            ]
                        )
                    ]);
                }
            }
        }

        $is_optional = $param->default !== null;

        return new FunctionLikeParameter(
            $param->name,
            $param->byRef,
            $param_type ?: Type::getMixed(),
            new CodeLocation($source, $param),
            $is_optional,
            $is_nullable,
            $param->variadic
        );
    }

    /**
     * @param  \ReflectionParameter $param
     * @return FunctionLikeParameter
     */
    protected static function getReflectionParamArray(\ReflectionParameter $param)
    {
        $param_type_string = null;

        if ($param->isArray()) {
            $param_type_string = 'array';
        } else {
            $param_class = null;

            try {
                /** @var \ReflectionClass */
                $param_class = $param->getClass();
            } catch (\ReflectionException $e) {
                // do nothing
            }

            if ($param_class) {
                $param_type_string = (string)$param_class->getName();
            }
        }

        $is_nullable = false;

        $is_optional = (bool)$param->isOptional();

        try {
            $is_nullable = $param->getDefaultValue() === null;

            if ($param_type_string && $is_nullable) {
                $param_type_string .= '|null';
            }
        } catch (\ReflectionException $e) {
            // do nothing
        }

        $param_name = (string)$param->getName();
        $param_type = $param_type_string ? Type::parseString($param_type_string) : Type::getMixed();

        return new FunctionLikeParameter(
            $param_name,
            (bool)$param->isPassedByReference(),
            $param_type,
            null,
            $is_optional,
            $is_nullable
        );
    }

    /**
     * @param  string       $return_type
     * @param  string|null  $fq_class_name
     * @param  string       $namespace
     * @param  array        $aliased_classes
     * @return string
     */
    public static function fixUpLocalType($return_type, $fq_class_name, $namespace, array $aliased_classes)
    {
        if (strpos($return_type, '[') !== false) {
            $return_type = Type::convertSquareBrackets($return_type);
        }

        $return_type_tokens = Type::tokenize($return_type);

        foreach ($return_type_tokens as $i => &$return_type_token) {
            if ($return_type_token[0] === '\\') {
                $return_type_token = substr($return_type_token, 1);
                continue;
            }

            if (in_array($return_type_token, ['<', '>', '|', '?', ',', '{', '}', ':'])) {
                continue;
            }

            if (isset($return_type_tokens[$i + 1]) && $return_type_tokens[$i + 1] === ':') {
                continue;
            }

            $return_type_token = Type::fixScalarTerms($return_type_token);

            if ($return_type_token[0] === strtoupper($return_type_token[0])) {
                if ($return_type_token[0] === '$') {
                    if ($return_type === '$this') {
                        $return_type_token = 'static';
                    }

                    continue;
                }

                $return_type_token = ClassLikeChecker::getFQCLNFromString(
                    $return_type_token,
                    $namespace,
                    $aliased_classes
                );
            }
        }

        return implode('', $return_type_tokens);
    }

    /**
     * Does the input param type match the given param type
     *
     * @param  Type\Union $input_type
     * @param  Type\Union $param_type
     * @param  bool       &$has_scalar_match
     * @param  bool       &$type_coerced    whether or not there was type coercion involved
     * @return bool
     */
    public static function doesParamMatch(
        Type\Union $input_type,
        Type\Union $param_type,
        &$has_scalar_match = null,
        &$type_coerced = null
    ) {
        $has_scalar_match = true;

        if ($param_type->isMixed()) {
            return true;
        }

        $type_match_found = false;
        $has_type_mismatch = false;

        foreach ($input_type->types as $input_type_part) {
            if ($input_type_part->isNull()) {
                continue;
            }

            $type_match_found = false;
            $scalar_type_match_found = false;

            foreach ($param_type->types as $param_type_part) {
                if ($param_type_part->isNull()) {
                    continue;
                }

                if ($input_type_part->value === $param_type_part->value ||
                    ClassChecker::classExtendsOrImplements($input_type_part->value, $param_type_part->value) ||
                    ExpressionChecker::isMock($input_type_part->value)
                ) {
                    $type_match_found = true;
                    break;
                }

                if ($input_type_part->value === 'false' && $param_type_part->value === 'bool') {
                    $type_match_found = true;
                }

                if ($input_type_part->value === 'int' && $param_type_part->value === 'float') {
                    $type_match_found = true;
                }

                if ($input_type_part->value === 'Closure' && $param_type_part->value === 'callable') {
                    $type_match_found = true;
                }

                if ($param_type_part->isNumeric() && $input_type_part->isNumericType()) {
                    $type_match_found = true;
                }

                if ($param_type_part->isGenericArray() && $input_type_part->isObjectLike()) {
                    $type_match_found = true;
                }

                if ($param_type_part->isIterable() &&
                    (
                        $input_type_part->isArray() ||
                        ClassChecker::classExtendsOrImplements($input_type_part->value, 'Traversable')
                    )
                ) {
                    $type_match_found = true;
                }

                if ($param_type_part->isScalar() && $input_type_part->isScalarType()) {
                    $type_match_found = true;
                }

                if ($param_type_part->isCallable() &&
                    ($input_type_part->value === 'string' || $input_type_part->value === 'array')
                ) {
                    // @todo add value checks if possible here
                    $type_match_found = true;
                }

                if ($input_type_part->isNumeric()) {
                    if ($param_type_part->isNumericType()) {
                        $scalar_type_match_found = true;
                    }
                }

                if ($input_type_part->isScalarType() || $input_type_part->isScalar()) {
                    if ($param_type_part->isScalarType()) {
                        $scalar_type_match_found = true;
                    }
                } elseif ($param_type_part->isObject() &&
                    !$input_type_part->isArray() &&
                    !$input_type_part->isResource()
                ) {
                    $type_match_found = true;
                }

                if (ClassChecker::classExtendsOrImplements($param_type_part->value, $input_type_part->value)) {
                    $type_coerced = true;
                    $type_match_found = true;
                    break;
                }
            }

            if (!$type_match_found) {
                if (!$scalar_type_match_found) {
                    $has_scalar_match = false;
                }

                return false;
            }
        }

        return true;
    }

    /**
     * @param  string                       $method_id
     * @param  array<PhpParser\Node\Arg>    $args
     * @param  string                       $file_name
     * @return array<int,FunctionLikeParameter>
     */
    public static function getParamsById($method_id, array $args, $file_name)
    {
        $fq_class_name = strpos($method_id, '::') !== false ? explode('::', $method_id)[0] : null;

        if ($fq_class_name && ClassLikeChecker::isUserDefined($fq_class_name)) {
            /** @var array<\Psalm\FunctionLikeParameter> */
            return MethodChecker::getMethodParams($method_id);
        } elseif (!$fq_class_name && FunctionChecker::inCallMap($method_id)) {
            /** @var array<array<FunctionLikeParameter>> */
            $function_param_options = FunctionChecker::getParamsFromCallMap($method_id);
        } elseif ($fq_class_name) {
            if ($method_params = MethodChecker::getMethodParams($method_id)) {
                // fall back to using reflected params anyway
                return $method_params;
            }

            $declaring_method_id = MethodChecker::getDeclaringMethodId($method_id);

            $method_id = $declaring_method_id ?: $method_id;

            if (!FunctionChecker::inCallMap($method_id)) {
                throw new \InvalidArgumentException('Cannot get params for ' . $method_id);
            }

            /** @var array<array<FunctionLikeParameter>> */
            $function_param_options = FunctionChecker::getParamsFromCallMap($method_id);
        } else {
            return FunctionChecker::getParams(strtolower($method_id), $file_name);
        }

        $function_params = null;

        if (count($function_param_options) === 1) {
            return $function_param_options[0];
        }

        foreach ($function_param_options as $possible_function_params) {
            $all_args_match = true;

            $last_param = count($possible_function_params)
                ? $possible_function_params[count($possible_function_params) - 1]
                : null;

            $mandatory_param_count = count($possible_function_params);

            foreach ($possible_function_params as $i => $possible_function_param) {
                if ($possible_function_param->is_optional) {
                    $mandatory_param_count = $i;
                    break;
                }
            }

            if ($mandatory_param_count > count($args)) {
                continue;
            }

            foreach ($args as $argument_offset => $arg) {
                if (count($possible_function_params) <= $argument_offset &&
                    (!$last_param || substr($last_param->name, 0, 3) !== '...')
                ) {
                    $all_args_match = false;
                    break;
                }

                $param_type = $possible_function_params[$argument_offset]->type;

                if (!isset($arg->value->inferredType)) {
                    continue;
                }

                if ($arg->value->inferredType->isMixed()) {
                    continue;
                }

                if (FunctionLikeChecker::doesParamMatch($arg->value->inferredType, $param_type)) {
                    continue;
                }

                $all_args_match = false;
                break;
            }

            if ($all_args_match) {
                return $possible_function_params;
            }
        }

        // if we don't succeed in finding a match, set to the first possible and wait for issues below
        return $function_param_options[0];
    }
}