refactor: locateFile

refactor: locateFile

Author: ddevsr

system/Autoloader/FileLocator.php

@@ -44,23 +44,23 @@ public function __construct(Autoloader $autoloader)
      * Attempts to locate a file by examining the name for a namespace
      * and looking through the PSR-4 namespaced files that we know about.
      *
-     * @param non-empty-string $file   The relative file path or namespaced file to
-     *                                 locate. If not namespaced, search in the app
-     *                                 folder.
-     * @param non-empty-string $folder The folder within the namespace that we should
-     *                                 look for the file. If $file does not contain
-     *                                 this value, it will be appended to the namespace
-     *                                 folder.
-     * @param string           $ext    The file extension the file should have.
+     * @param non-empty-string      $file   The relative file path or namespaced file to
+     *                                      locate. If not namespaced, search in the app
+     *                                      folder.
+     * @param non-empty-string|null $folder The folder within the namespace that we should
+     *                                      look for the file. If $file does not contain
+     *                                      this value, it will be appended to the namespace
+     *                                      folder.
+     * @param string                $ext    The file extension the file should have.
      *
      * @return false|non-empty-string The path to the file, or false if not found.
      */
-    public function locateFile(string $file, string $folder = '', string $ext = 'php')
+    public function locateFile(string $file, ?string $folder = null, string $ext = 'php')
     {
         $file = $this->ensureExt($file, $ext);
 
         // Clears the folder name if it is at the beginning of the filename
-        if ($folder !== '' && str_starts_with($file, $folder)) {
+        if ($folder !== null && str_starts_with($file, $folder)) {
             $file = substr($file, strlen($folder . '/'));
         }
 
@@ -110,7 +110,7 @@ public function locateFile(string $file, string $folder = '', string $ext = 'php
             // If we have a folder name, then the calling function
             // expects this file to be within that folder, like 'Views',
             // or 'libraries'.
-            if ($folder !== '' && ! str_contains($path . $filename, '/' . $folder . '/')) {
+            if ($folder !== null && ! str_contains($path . $filename, '/' . $folder . '/')) {
                 $path .= trim($folder, '/') . '/';
             }
 

system/Autoloader/FileLocatorCached.php

@@ -161,16 +161,18 @@ public function listNamespaceFiles(string $prefix, string $path): array
         return $files;
     }
 
-    public function locateFile(string $file, string $folder = '', string $ext = 'php'): false|string
+    public function locateFile(string $file, ?string $folder = null, string $ext = 'php'): false|string
     {
-        if (isset($this->cache['locateFile'][$file][$folder][$ext])) {
-            return $this->cache['locateFile'][$file][$folder][$ext];
+        $folderKey = $folder ?? '';
+
+        if (isset($this->cache['locateFile'][$file][$folderKey][$ext])) {
+            return $this->cache['locateFile'][$file][$folderKey][$ext];
         }
 
-        $files = $this->locator->locateFile($file, $folder, $ext);
+        $files = $this->locator->locateFile($file, $folderKey, $ext);
 
-        $this->cache['locateFile'][$file][$folder][$ext] = $files;
-        $this->cacheUpdated                              = true;
+        $this->cache['locateFile'][$file][$folderKey][$ext] = $files;
+        $this->cacheUpdated                                 = true;
 
         return $files;
     }

system/Autoloader/FileLocatorInterface.php

@@ -23,18 +23,18 @@ interface FileLocatorInterface
      * Attempts to locate a file by examining the name for a namespace
      * and looking through the PSR-4 namespaced files that we know about.
      *
-     * @param non-empty-string $file   The relative file path or namespaced file to
-     *                                 locate. If not namespaced, search in the app
-     *                                 folder.
-     * @param non-empty-string $folder The folder within the namespace that we should
-     *                                 look for the file. If $file does not contain
-     *                                 this value, it will be appended to the namespace
-     *                                 folder.
-     * @param string           $ext    The file extension the file should have.
+     * @param non-empty-string      $file   The relative file path or namespaced file to
+     *                                      locate. If not namespaced, search in the app
+     *                                      folder.
+     * @param non-empty-string|null $folder The folder within the namespace that we should
+     *                                      look for the file. If $file does not contain
+     *                                      this value, it will be appended to the namespace
+     *                                      folder.
+     * @param string                $ext    The file extension the file should have.
      *
      * @return false|non-empty-string The path to the file, or false if not found.
      */
-    public function locateFile(string $file, string $folder = '', string $ext = 'php');
+    public function locateFile(string $file, ?string $folder = null, string $ext = 'php');
 
     /**
      * Examines a file and returns the fully qualified class name.