Optimize view paths for module views in theme folder (#1081)

* override \Igaster\LaravelTheme\themeViewFinder as a workaround until PR#133 in igaster/laravel-theme is merged

* fixup code style

* further code style fix

Co-authored-by: Andreas Palm <ap@ewsp.de>

app/Providers/AppServiceProvider.php

@@ -3,6 +3,7 @@
 namespace App\Providers;
 
 use App\Services\ModuleService;
+use App\Support\ThemeViewFinder;
 use App\Support\Utils;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Facades\Schema;
@@ -23,6 +24,14 @@ class AppServiceProvider extends ServiceProvider
      */
     public function register(): void
     {
+        $this->app->singleton('view.finder', function ($app) {
+            return new ThemeViewFinder(
+                $app['files'],
+                $app['config']['view.paths'],
+                null
+            );
+        });
+
         // Only load the IDE helper if it's included and enabled
         if (config('app.debug') === true) {
             /* @noinspection NestedPositiveIfStatementsInspection */

app/Support/ThemeViewFinder.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace App\Support;
+
+use Igaster\LaravelTheme\Facades\Theme;
+use Illuminate\Filesystem\Filesystem;
+use Illuminate\Support\Arr;
+
+class ThemeViewFinder extends \Igaster\LaravelTheme\themeViewFinder
+{
+    public function __construct(Filesystem $files, array $paths, array $extensions = null)
+    {
+        //$this->themeEngine = \App::make('igaster.themes');
+        parent::__construct($files, $paths, $extensions);
+    }
+
+    /*
+     * Override findNamespacedView() to add "Theme/vendor/..." paths
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function findNamespacedView($name)
+    {
+        // Extract the $view and the $namespace parts
+        list($namespace, $view) = $this->parseNamespaceSegments($name);
+
+        $paths = $this->addThemeNamespacePaths($namespace);
+
+        // Find and return the view
+        return $this->findInPaths($view, $paths);
+    }
+
+    public function addThemeNamespacePaths($namespace)
+    {
+        // This rule will remap all paths starting with $key to $value.
+        // For exapmle paths starting with 'resources/views/vendor' (relative to base_path())
+        // will be maped to path 'THEMENAME/vendor' (relative to current theme views-path)
+        $pathsMap = [
+            // 'resources/views/vendor/mail' => 'mail',
+            'resources/views/vendor'  => 'vendor',
+            'resources/views/modules' => 'modules',
+        ];
+
+        // Does $namespace exists?
+        if (!isset($this->hints[$namespace])) {
+            return [];
+        }
+
+        // Get the paths registered to the $namespace
+        $paths = $this->hints[$namespace];
+
+        // Search $paths array and remap paths that start with a key of $pathsMap array.
+        // replace with the value of $pathsMap array
+        $themeSubPaths = [];
+        foreach ($paths as $path) {
+            $pathRelativeToApp = substr($path, strlen(base_path()) + 1);
+            // Ignore paths in composer installed packages (paths inside vendor folder)
+            if (strpos($pathRelativeToApp, 'vendor') !== 0) {
+                // Remap paths definded int $pathsMap array
+                foreach ($pathsMap as $key => $value) {
+                    if (strpos($pathRelativeToApp, $key) === 0) {
+                        $pathRelativeToApp = str_replace($key, $value, $pathRelativeToApp);
+                        break;
+                    }
+                }
+                $themeSubPaths[] = $pathRelativeToApp;
+            }
+        }
+
+        // Prepend current theme's view path to the remaped paths
+        $newPaths = [];
+        $searchPaths = array_diff($this->paths, Theme::getLaravelViewPaths());
+        foreach ($searchPaths as $path1) {
+            foreach ($themeSubPaths as $path2) {
+                $newPaths[] = $path1.'/'.$path2;
+            }
+        }
+
+        // Add new paths in the beggin of the search paths array
+        foreach (array_reverse($newPaths) as $path) {
+            if (!in_array($path, $paths, true)) {
+                $paths = Arr::prepend($paths, $path);
+            }
+        }
+        return $paths;
+    }
+}