Php-language-server: Automatically add use statement

[longrunningprocess]

When adding a class in the code, it would be great if the use statement was automatically written into the top of the file. Thanks for considering!

[felixfbecker]

I would love to have this, and it is not even hard that hard to implement.

[longrunningprocess]

Glad to hear it wouldn't be difficult. I hope you'll forgive me for not contributing beyond the request 0:-)

[arturolinares]

:+1:

[felixfbecker]

Please don't +1 issues. It clutters the thread without adding value to the discussion and spams maintainers with notifications. Use GitHub reactions to upvote features.

[sugarmaster]

Here is the sublime equivalent if it helps.
https://github.com/erichard/SublimePHPCompanion/blob/master/php_companion/commands/find_use_command.py

[jens1o]

@felixfbecker Is there any protocol I can use?

[felixfbecker]

yeah, you can return additionalTextEdits from textDocument/completion

[jens1o]

@felixfbecker How to get the positon of the first php start tag after the namespace definition? I don't have any (serious) idea. Should I set a variable in PhpDocument with the place to enter while parsing the thing?

[felixfbecker]

Theres a getClosestNode() in helpers which you can use to find the closest namespace Node, then you can easily get the first statement inside it.

[jens1o]

Beautiful. I thought I need to implement this functionality myself.

[jens1o]

Ah, there is a bug. getClosestNode will return void instead of null. Short pull request comes...

[felixfbecker]

Functions that return nothing return null.

[jens1o]

This does not. That's the bug.

[felixfbecker]

function foo() {
}

$f = foo();

var_dump($f); // NULL

[jens1o]

It's better to return that from the code, isn't it?

[felixfbecker]

It makes not difference

[jens1o]

okay.

[jens1o]

How is the PHP start tag called in php-parser? I'd looked in the files, but I couldn't find anything related.
Node\Stmt\Namespace_ is for Namespaces
??? is for the PHP start tag?

[felixfbecker]

There is no PHP start tag, only InlineHtml

[jens1o]

But I can't rely on that, can I? I need to find the first "save" location where I can insert the use statement. At the moment I'm searching for a fallback when there is no namespace statement.

[staabm]

before the first class definition?

[jens1o]

yes, and maybe behind the declare node(implemented). But I need a fallback.

[felixfbecker]

The fallback would just be at the root? Which is the $stmts array

[jens1o]

But then it may be possible to get a use statement right after inline html?

[thoresuenert]

@jens1o how is it going?
do you need help?
Where to contribute?

[jens1o]

Hmm, I didn't continued, since I have school again and I'm writing lots of exams... So yeah, I need some help. In the evening, I'll push my tries, maybe you can contribute..

[Munsio]

@jens1o where can we find the branch?

[jens1o]

On my old pc. Dammit. I'm again in exam phase, I'm sorry. Even though, I would have to write it again because of the new parser. Before I can do that, I would like to push forward foreach support.