magic methods do not appear in autocomplete

[Bleksak]

PHPantom version

phpantom_lsp 0.7.0-58-g27e9a1a

Installation method

Built from source

Operating system

Linux x86_64

Editor

Neovim

Bug description

I think some magic methods like __invoke and __toString should be visible in autocomplete.

Steps to reproduce

file:

<?php

declare(strict_types=1);


namespace Bleksak\MagoTest;

class X {
    public function __invoke():void {}
    public function __test(): void {}
    public function __toString(): string { return 'a'; }
}

$x = new X();
$x->_; // <-- put cursor at _ and trigger autocompletion

Error output or panic trace

.phpantom.toml

Additional context

No response

[AJenbo]

This is actually intentional, magic methods should not be called directly. Instead they should be triggered by the language when you do dynamic operations on the object.

$x = new X();
$x();
$x->magic = 42;
if (!isset($x->magic)) return null;
echo (string)$x;
$x->doSomething();
return $x->magic;

@calebdw am I crazy for thinking this?

[Bleksak]

But then we should be able to analyze the arguments passed to __invoke for example:

$sponsor = ($this->sponsorCreateService)($dto);

which would be for example located in: https://github.com/Bleksak/vytrvalec-server/blob/sponsors-in-db/src/Controller/ApiResource/Sponsor/CreateController.php#L33

instead of the manual __invoke() call

I think having __invoke in the autocompletion should maybe autocomplete into ($x)() call? It would serve as documentation. Or maybe autocomplete __invoke normally, and provide a diagnostic + code action to convert into something else?

[calebdw]

@calebdw am I crazy for thinking this?

Yes and no, nothing in the language prevents the methods from being called manually. I've seen Laravel manually call __invoke()/__toString()/__call()/etc

Additionally, you do call __construct() manually when creating lazy objects

For the purpose of autocomplete, if the user types ->__ then I see nothing wrong with offering completions for the magic methods