Move php-project-get-root-dir and some variables into php-project.el

By dividing these functions into separate files rather than a single
file, it improves interoperability with other modes and functions.
In the future this file will be independent as a separate package.

Author: zonuexe

php-mode.el

@@ -83,6 +83,7 @@
 (require 'etags)
 (require 'speedbar)
 (require 'imenu)
+(require 'php-project nil t)
 
 (require 'cl-lib)
 (require 'mode-local)
@@ -388,30 +389,8 @@ This variable can take one of the following symbol values:
   (message "PHP Mode %s of %s"
            php-mode-version-number php-mode-modified))
 
-(defvar php-available-project-root-files
-  '((projectile ".projectile")
-    (composer   "composer.json" "composer.lock")
-    (git        ".git")
-    (mercurial  ".hg")
-    (subversion ".svn")
-    ;; NOTICE: This method does not detect the top level of .editorconfig
-    ;;         However, we can integrate it by adding the editorconfig.el's API.
-    ;;(editorconfig . ".editorconfig")
-    ))
-
 ;;;###autoload
-(progn
-  (defvar php-project-root 'auto
-    "Method of searching for the top level directory.
-
-`auto' (default)
-      Try to search file in order of `php-available-project-root-files'.
-
-SYMBOL
-      Key of `php-available-project-root-files'.")
-  (make-variable-buffer-local 'php-project-root)
-  (put 'php-project-root 'safe-local-variable
-       #'(lambda (v) (assq v php-available-project-root-files))))
+(define-obsolete-variable-alias 'php-available-project-root-files 'php-project-available-root-files "1.19.0")
 
 (defvar php-mode-map
   (let ((map (make-sparse-keymap)))
@@ -1743,18 +1722,6 @@ The output will appear in the buffer *PHP*."
     (when (re-search-backward re-pattern nil t)
       (match-string-no-properties 1))))
 
-;;;###autoload
-(defun php-project-get-root-dir ()
-  "Return path to current PHP project."
-  (let ((detect-method (if (stringp php-project-root)
-                           (list php-project-root)
-                         (if (eq php-project-root 'auto)
-                             (cl-loop for m in php-available-project-root-files
-                                      append (cdr m))
-                           (cdr-safe (assq php-project-root php-available-project-root-files))))))
-    (cl-loop for m in detect-method
-             thereis (locate-dominating-file default-directory m))))
-
 ;;;###autoload
 (defun php-current-class ()
   "Insert current class name if cursor in class context."

php-project.el

@@ -25,19 +25,58 @@
 ;;; Commentary:
 
 ;; Define project specific functions and variables for PHP application.
+;;
+;; ## API
+;;
+;; ### `php-project-get-root-dir()'
+;;
+;; Return root directory of current buffer file.  The root directory is
+;; determined by several marker file or directory.
+;;
 
 ;;; Code:
-
 
 ;; Variables
-
-
+(defvar php-project-available-root-files
+  '((projectile ".projectile")
+    (composer   "composer.json" "composer.lock")
+    (git        ".git")
+    (mercurial  ".hg")
+    (subversion ".svn")
+    ;; NOTICE: This method does not detect the top level of .editorconfig
+    ;;         However, we can integrate it by adding the editorconfig.el's API.
+    ;;(editorconfig . ".editorconfig")
+    ))
 
 ;; Buffer local variables
 
+;;;###autoload
+(progn
+  (defvar php-project-root 'auto
+    "Method of searching for the top level directory.
+
+`auto' (default)
+      Try to search file in order of `php-project-available-root-files'.
+
+SYMBOL
+      Key of `php-project-available-root-files'.")
+  (make-variable-buffer-local 'php-project-root)
+  (put 'php-project-root 'safe-local-variable
+       #'(lambda (v) (assq v php-project-available-root-files))))
 
 ;; Functions
 
+;;;###autoload
+(defun php-project-get-root-dir ()
+  "Return path to current PHP project."
+  (let ((detect-method (if (stringp php-project-root)
+                           (list php-project-root)
+                         (if (eq php-project-root 'auto)
+                             (cl-loop for m in php-project-available-root-files
+                                      append (cdr m))
+                           (cdr-safe (assq php-project-root php-project-available-root-files))))))
+    (cl-loop for m in detect-method
+             thereis (locate-dominating-file default-directory m))))
 
 (provide 'php-project)
 ;;; php-project.el ends here