Signature help

fixtures/signatureHelp/funcClosed.php

@@ -0,0 +1,7 @@
+<?php
+
+function helpFunc1(int $count = 0)
+{
+}
+
+helpFunc1()

fixtures/signatureHelp/funcNotClosed.php

@@ -0,0 +1,7 @@
+<?php
+
+function helpFunc2(int $count = 0)
+{
+}
+
+helpFunc2(

fixtures/signatureHelp/methodClosed.php

@@ -0,0 +1,15 @@
+<?php
+
+class HelpClass1
+{
+    public function method(string $param = "")
+    {
+    }
+    public function test()
+    {
+        $this->method();
+    }
+}
+
+$a = new HelpClass1;
+$a->method();

fixtures/signatureHelp/methodNotClosed.php

@@ -0,0 +1,17 @@
+<?php
+
+class HelpClass2
+{
+    protected function method(string $param = "")
+    {
+    }
+    public function test()
+    {
+        $this->method(1,1);
+    }
+}
+$a = new HelpClass2;
+$a
+    ->method(
+        1,
+        array(),

fixtures/signatureHelp/staticClosed.php

@@ -0,0 +1,10 @@
+<?php
+
+class HelpClass3
+{
+    public static function method(string $param = "")
+    {
+    }
+}
+
+HelpClass3::method()

fixtures/signatureHelp/staticNotClosed.php

@@ -0,0 +1,10 @@
+<?php
+
+class HelpClass4
+{
+    public static function method(string $param = "")
+    {
+    }
+}
+
+HelpClass4::method(1

src/Definition.php

@@ -89,4 +89,11 @@ class Definition
      * @var string
      */
     public $documentation;
+
+    /**
+     * Parameters array (for methods and functions), for use in textDocument/signatureHelp
+     *
+     * @var string[]
+     */
+    public $parameters;
 }

src/DefinitionResolver.php

@@ -7,6 +7,7 @@
 use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use phpDocumentor\Reflection\{Types, Type, Fqsen, TypeResolver};
 use LanguageServer\Protocol\SymbolInformation;
+use LanguageServer\Protocol\ParameterInformation;
 use LanguageServer\Index\ReadableIndex;
 
 class DefinitionResolver
@@ -131,6 +132,18 @@ public function createDefinitionFromNode(Node $node, string $fqn = null): Defini
         $def->type = $this->getTypeFromNode($node);
         $def->declarationLine = $this->getDeclarationLineFromNode($node);
         $def->documentation = $this->getDocumentationFromNode($node);
+        $def->parameters = [];
+        if ($node instanceof Node\FunctionLike) {
+            foreach ($node->getParams() as $param) {
+                if (!$param->getAttribute('parentNode')) {
+                    $param->setAttribute('parentNode', $node);
+                }
+                $def->parameters[] = new ParameterInformation(
+                    $this->prettyPrinter->prettyPrint([$param]),
+                    $this->getDocumentationFromNode($param)
+                );
+            }
+        }
         return $def;
     }
 

src/LanguageServer.php

@@ -12,7 +12,8 @@
     InitializeResult,
     SymbolInformation,
     TextDocumentIdentifier,
-    CompletionOptions
+    CompletionOptions,
+    SignatureHelpOptions
 };
 use LanguageServer\FilesFinder\{FilesFinder, ClientFilesFinder, FileSystemFilesFinder};
 use LanguageServer\ContentRetriever\{ContentRetriever, ClientContentRetriever, FileSystemContentRetriever};
@@ -247,6 +248,9 @@ public function initialize(ClientCapabilities $capabilities, string $rootPath =
             $serverCapabilities->completionProvider = new CompletionOptions;
             $serverCapabilities->completionProvider->resolveProvider = false;
             $serverCapabilities->completionProvider->triggerCharacters = ['$', '>'];
+            // Support "Signature Help"
+            $serverCapabilities->signatureHelpProvider = new SignatureHelpOptions;
+            $serverCapabilities->signatureHelpProvider->triggerCharacters = ['(',','];
             // Support global references
             $serverCapabilities->xworkspaceReferencesProvider = true;
             $serverCapabilities->xdefinitionProvider = true;

src/Protocol/ParameterInformation.php

@@ -23,4 +23,14 @@ class ParameterInformation
      * @var string|null
      */
     public $documentation;
+
+    /**
+     * @param string                 $label         The label of this signature. Will be shown in the UI.
+     * @param string|null            $documentation The human-readable doc-comment of this signature.
+     */
+    public function __construct(string $label = null, string $documentation = null)
+    {
+        $this->label = $label;
+        $this->documentation = $documentation;
+    }
 }

src/Protocol/SignatureHelp.php

@@ -29,4 +29,16 @@ class SignatureHelp
      * @var int|null
      */
     public $activeParameter;
+
+    /**
+     * @param SignatureInformation[] $signatures      The signatures.
+     * @param int|null               $activeSignature The active signature.
+     * @param int|null               $activeParameter The active parameter of the active signature.
+     */
+    public function __construct(array $signatures = [], int $activeSignature = null, int $activeParameter = null)
+    {
+        $this->signatures = $signatures;
+        $this->activeSignature = $activeSignature;
+        $this->activeParameter = $activeParameter;
+    }
 }

src/Protocol/SignatureInformation.php

@@ -31,4 +31,16 @@ class SignatureInformation
      * @var ParameterInformation[]|null
      */
     public $parameters;
+
+    /**
+     * @param string                      $label         The label of this signature. Will be shown in the UI.
+     * @param string|null                 $documentation The human-readable doc-comment of this signature.
+     * @param ParameterInformation[]|null $parameters    The parameters of this signature.
+     */
+    public function __construct(string $label = null, string $documentation = null, array $parameters = [])
+    {
+        $this->label = $label;
+        $this->documentation = $documentation;
+        $this->parameters = $parameters;
+    }
 }

src/Server/TextDocument.php

@@ -5,7 +5,7 @@
 
 use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use PhpParser\{Node, NodeTraverser};
-use LanguageServer\{LanguageClient, PhpDocumentLoader, PhpDocument, DefinitionResolver, CompletionProvider};
+use LanguageServer\{LanguageClient, PhpDocumentLoader, PhpDocument, DefinitionResolver, CompletionProvider, SignatureHelpProvider};
 use LanguageServer\NodeVisitor\VariableReferencesCollector;
 use LanguageServer\Protocol\{
     SymbolLocationInformation,
@@ -63,6 +63,11 @@ class TextDocument
      */
     protected $completionProvider;
 
+    /**
+     * @var SignatureHelpProvider
+     */
+    protected $signatureHelpProvider;
+
     /**
      * @var ReadableIndex
      */
@@ -99,6 +104,7 @@ public function __construct(
         $this->prettyPrinter = new PrettyPrinter();
         $this->definitionResolver = $definitionResolver;
         $this->completionProvider = new CompletionProvider($this->definitionResolver, $index);
+        $this->signatureHelpProvider = new SignatureHelpProvider($this->definitionResolver, $index);
         $this->index = $index;
         $this->composerJson = $composerJson;
         $this->composerLock = $composerLock;
@@ -343,6 +349,14 @@ public function completion(TextDocumentIdentifier $textDocument, Position $posit
         });
     }
 
+    public function signatureHelp(TextDocumentIdentifier $textDocument, Position $position): Promise
+    {
+        return coroutine(function () use ($textDocument, $position) {
+            $document = yield $this->documentLoader->getOrLoad($textDocument->uri);
+            return $this->signatureHelpProvider->provideSignature($document, $position);
+        });
+    }
+
     /**
      * This method is the same as textDocument/definition, except that
      *