Merge branch 'master' into translation-controller

core/CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file. This projec
 ## 1.0.11 (in progress)
 
 + [#1840](https://github.com/luyadev/luya/issues/1840) Convert mail message into alt body automatically.
++ [#1816](https://github.com/luyadev/luya/issues/1816) View mapping to change the view folder of actions inside modules.
 + [#1844](https://github.com/luyadev/luya/pull/1844) Added translation command to add easier a new record to the translation files. This command is used in the luya-env-dev project in order to develop on the LUYA modules or create your own extensions/modules.
 
 ## 1.0.10 (18. July 2018)

core/base/Module.php

@@ -146,7 +146,26 @@ public function getUrlRules()
      *
      */
     public $useAppViewPath = false;
-
+
+    /**
+     * @var array mapping from action ID to view configurations.
+     * Each name-value pair specifies the configuration of a specifed oder wildcard action to a single view folder.
+     * The first match
+     * For example,
+     *
+     * ```php
+     * [
+     *   'default/index' => '@app/views/mymodule/default',
+     *   'login/info' => '@app/views/mymodule/login',
+     *   'default/*' => '@app/views/mymodule/default',
+     *   '*' => '@app/views/mymodule',
+     * ]
+     * ```
+     *
+     * @since 1.0.11
+     */
+    public $viewMap = [];
+
     /**
      * @var string if this/the module is included via another module (parent module), the parent module will write its
      * name inside the child modules $context variable. For example the cms includes the news module, the context variable

core/web/Controller.php

@@ -31,10 +31,25 @@ public function registerAsset($className)
      */
     public function getViewPath()
     {
-        if ($this->module instanceof Module && $this->module->useAppViewPath) {
-            return '@app/views/'.$this->module->id.'/'.$this->id;
+        if ($this->module instanceof Module) {
+
+            if ($this->module->useAppViewPath) {
+                return '@app/views/' . $this->module->id . '/' . $this->id;
+            } elseif (is_array($this->module->viewMap)) {
+
+                $currentAction = $this->id . '/' . ($this->action ? $this->action->id : $this->defaultAction);
+                foreach ($this->module->viewMap as $action => $viewPath) {
+
+                    // Special case for map all views of controller
+                    if ($action === '*') {
+                        return $viewPath . '/' . $this->id;
+                    } elseif (fnmatch($action, $currentAction)) {
+                        return $viewPath;
+                    }
+                }
+            }
         }
-        
+
         return parent::getViewPath();
     }
 

tests/core/ModuleApplicationTest.php

@@ -26,4 +26,18 @@ public function testApp()
         $this->assertEquals('baz', Yii::$app->runAction('unitmodule/other/baz', []));
         $this->assertEquals('baz', Yii::$app->runAction('unitmodule/other/baz/', []));
     }
+
+    public function testViewMap()
+    {
+        // Works only with disabled $useAppViewPath
+        Yii::$app->getModule('unitmodule')->useAppViewPath = false;
+
+        // Test ViewmapController
+        $this->assertEquals('viewmap1', Yii::$app->runAction('unitmodule/viewmap/viewmap1'));
+        $this->assertEquals('viewmap2', Yii::$app->runAction('unitmodule/viewmap/viewmap2'));
+        $this->assertEquals('viewmap3', Yii::$app->runAction('unitmodule/viewmap/viewmap3'));
+
+        // Test ViewmapAllController
+        $this->assertEquals('viewmapAll', Yii::$app->runAction('unitmodule/viewmap-all'));
+    }
 }

tests/data/configs/webmoduleapp.php

@@ -6,6 +6,10 @@
     'remoteToken' => 'testtoken',
     'basePath' => dirname(__DIR__),
     'defaultRoute' => 'unitmodule',
+    'aliases' => [
+        '@runtime' => dirname(__DIR__) . '/runtime',
+        '@luyatests' => dirname(__DIR__) . '/../',
+    ],
     'modules' => [
         'unitmodule' => [
             'class' => 'luyatests\data\modules\unitmodule\Module',

tests/data/modules/unitmodule/Module.php

@@ -8,6 +8,13 @@
 class Module extends \luya\base\Module implements CoreModuleInterface
 {
     public $useAppViewPath = true;
+
+    // Map all viewmap actions to viewmodule
+    public $viewMap = [
+        'viewmap/viewmap3' =>   '@luyatests/data/modules/viewmodule/views/stub',
+        'viewmap/*' =>          '@luyatests/data/modules/viewmodule/views/viewmap',
+        '*' =>                  '@luyatests/data/modules/viewmodule/views',
+    ];
 
     public $defaultRoute = 'test';
 

tests/data/modules/unitmodule/controllers/ViewmapAllController.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace luyatests\data\modules\unitmodule\controllers;
+
+class ViewmapAllController extends \luya\web\Controller
+{
+    public function actionIndex()
+    {
+        return $this->render('viewmapAll');
+    }
+}

tests/data/modules/unitmodule/controllers/ViewmapController.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace luyatests\data\modules\unitmodule\controllers;
+
+class ViewmapController extends \luya\web\Controller
+{
+    public function actionViewmap1()
+    {
+        return $this->render('viewmap1');
+    }
+
+    public function actionViewmap2()
+    {
+        return $this->render('viewmap2');
+    }
+
+    public function actionViewmap3()
+    {
+        return $this->render('viewmap3');
+    }
+}

tests/data/modules/viewmodule/views/stub/viewmap3.php

@@ -0,0 +1 @@
+viewmap3

tests/data/modules/viewmodule/views/viewmap-all/viewmapAll.php

@@ -0,0 +1 @@
+viewmapAll

tests/data/modules/viewmodule/views/viewmap/viewmap1.php

@@ -0,0 +1 @@
+viewmap1

tests/data/modules/viewmodule/views/viewmap/viewmap2.php

@@ -0,0 +1 @@
+viewmap2