add support for hover rpc action + documentation for it with eldoc (#102)

Author: kermorgant

README.org

@@ -35,10 +35,23 @@ Alternatively, you can install Phpactor on your own and configure `phpactor-exec
 
 
 ** Configuration
+*** eldoc integration
+
+#+BEGIN_SRC elisp
+  (add-hook 'php-mode-hook
+            (lambda ()
+              (make-local-variable 'eldoc-documentation-function)
+              (setq eldoc-documentation-function
+                    'phpactor-hover)))
+#+END_SRC
+
+*** phpactor itself
 See https://phpactor.github.io/phpactor/configuration.html
 
 ** Troubleshooting
 
 You can run ``phpactor-status`` while visiting a project file.
 
 If needed, configure [[https://github.com/emacs-php/php-mode/blob/1f04813f46219e626b385d0d96abefad914bfae0/php-project.el#L54][the way the project root is detected]] via .dir-locals.el
+
+"*Phpactor Output*" buffer might also contain useful informations.

phpactor.el

@@ -764,5 +764,12 @@ function."
   (let ((arguments (phpactor--command-argments :source :offset :path)))
     (apply #'phpactor-action-dispatch (phpactor--rpc "extract_constant" arguments))))
 
+;;;###autoload
+(defun phpactor-hover ()
+  "Execute Phpactor RPC hover action."
+  (interactive)
+  (let ((arguments (phpactor--command-argments :source :offset)))
+    (apply #'phpactor-action-dispatch (phpactor--rpc "hover" arguments))))
+
 (provide 'phpactor)
 ;;; phpactor.el ends here