From 61ac68fd5e9f84d16a435f4f7b678195538151d9 Mon Sep 17 00:00:00 2001
From: Samuel Georges <sam@daftspunk.com>
Date: Sat, 6 Aug 2016 13:14:46 +1000
Subject: [PATCH] Allows relationRender to specify readOnly mode Fixes #2245

---
 .../backend/behaviors/RelationController.php  | 54 +++++++++++++++----
 .../partials/_container.htm                   |  7 +--
 2 files changed, 47 insertions(+), 14 deletions(-)

diff --git a/modules/backend/behaviors/RelationController.php b/modules/backend/behaviors/RelationController.php
index 1bd618578..63a275995 100644
--- a/modules/backend/behaviors/RelationController.php
+++ b/modules/backend/behaviors/RelationController.php
@@ -30,6 +30,11 @@ class RelationController extends ControllerBehavior
      */
     const PARAM_MODE = '_relation_mode';
 
+    /**
+     * @var const Postback parameter for read only mode.
+     */
+    const PARAM_READ_ONLY = '_relation_read_only';
+
     /**
      * @var Backend\Classes\WidgetBase Reference to the search widget object.
      */
@@ -237,6 +242,7 @@ class RelationController extends ControllerBehavior
         $this->vars['relationViewWidget'] = $this->viewWidget;
         $this->vars['relationViewModel'] = $this->viewModel;
         $this->vars['relationPivotWidget'] = $this->pivotWidget;
+        $this->vars['relationReadOnly'] = $this->readOnly ? 1 : 0;
         $this->vars['relationSessionKey'] = $this->relationGetSessionKey();
     }
 
@@ -310,7 +316,6 @@ class RelationController extends ControllerBehavior
         $this->relationObject = $this->model->{$field}();
         $this->relationModel = $this->relationObject->getRelated();
 
-        $this->readOnly = $this->getConfig('readOnly');
         $this->deferredBinding = $this->getConfig('deferredBinding') || !$this->model->exists;
         $this->toolbarButtons = $this->evalToolbarButtons();
         $this->viewMode = $this->evalViewMode();
@@ -358,6 +363,13 @@ class RelationController extends ControllerBehavior
                 $this->pivotWidget->bindToController();
             }
         }
+
+        /*
+         * Read only mode
+         */
+        if (post(self::PARAM_READ_ONLY, $this->getConfig('readOnly'))) {
+            $this->makeReadOnly();
+        }
     }
 
     /**
@@ -374,8 +386,6 @@ class RelationController extends ControllerBehavior
             $options = ['sessionKey' => $options];
         }
 
-        $this->prepareVars();
-
         /*
          * Session key
          */
@@ -383,6 +393,15 @@ class RelationController extends ControllerBehavior
             $this->sessionKey = $options['sessionKey'];
         }
 
+        /*
+         * Read only mode
+         */
+        if (isset($options['readOnly']) && $options['readOnly']) {
+            $this->makeReadOnly();
+        }
+
+        $this->prepareVars();
+
         /*
          * Determine the partial to use based on the supplied section option
          */
@@ -506,11 +525,9 @@ class RelationController extends ControllerBehavior
         /*
          * Add buttons to toolbar
          */
-        $defaultButtons = null;
-
-        if (!$this->readOnly && $this->toolbarButtons) {
-            $defaultButtons = '~/modules/backend/behaviors/relationcontroller/partials/_toolbar.htm';
-        }
+        $defaultButtons = $this->toolbarButtons
+            ? '~/modules/backend/behaviors/relationcontroller/partials/_toolbar.htm'
+            : null;
 
         $defaultConfig['buttons'] = $this->getConfig('view[toolbarPartial]', $defaultButtons);
 
@@ -578,7 +595,7 @@ class RelationController extends ControllerBehavior
             $config->showSorting = $this->getConfig('view[showSorting]', true);
             $config->defaultSort = $this->getConfig('view[defaultSort]');
             $config->recordsPerPage = $this->getConfig('view[recordsPerPage]');
-            $config->showCheckboxes = $this->getConfig('view[showCheckboxes]', !$this->readOnly);
+            $config->showCheckboxes = $this->getConfig('view[showCheckboxes]', true);
             $config->recordUrl = $this->getConfig('view[recordUrl]', null);
 
             $defaultOnClick = sprintf(
@@ -1416,10 +1433,9 @@ class RelationController extends ControllerBehavior
             case 'morphMany':
                 if ($this->eventTarget == 'button-add') return 'list';
                 else return 'form';
-			case 'morphMany':
+            case 'morphMany':
                 return 'form';
         }
-        
     }
 
     /**
@@ -1444,6 +1460,22 @@ class RelationController extends ControllerBehavior
         return $context;
     }
 
+    /**
+     * Apply read only mode.
+     */
+    protected function makeReadOnly()
+    {
+        $this->readOnly = true;
+
+        if ($this->toolbarWidget && !$this->getConfig('view[toolbarPartial]', false)) {
+            $this->toolbarWidget->buttons = null;
+        }
+
+        if ($this->viewWidget && $this->viewMode == 'multi' && !$this->getConfig('view[showCheckboxes]', false)) {
+            $this->viewWidget->showCheckboxes = false;
+        }
+    }
+
     /**
      * Returns the configuration for a mode (view, manage, pivot) for an
      * expected type (list, form). Uses fallback configuration.
diff --git a/modules/backend/behaviors/relationcontroller/partials/_container.htm b/modules/backend/behaviors/relationcontroller/partials/_container.htm
index 9b2ddc976..e23b39885 100644
--- a/modules/backend/behaviors/relationcontroller/partials/_container.htm
+++ b/modules/backend/behaviors/relationcontroller/partials/_container.htm
@@ -1,11 +1,12 @@
 <div
-    data-request-data="_relation_field: '<?= $relationField ?>'" id="<?= $this->relationGetId() ?>"
+    id="<?= $this->relationGetId() ?>"
+    data-request-data="_relation_field: '<?= $relationField ?>', _relation_read_only: <?= $relationReadOnly ?>"
     class="relation-behavior relation-view-<?= $relationViewMode ?>">
 
     <?php if ($toolbar = $this->relationRenderToolbar()): ?>
         <!-- Relation Toolbar -->
         <div id="<?= $this->relationGetId('toolbar') ?>" class="relation-toolbar">
-            <?=  $toolbar ?>
+            <?= $toolbar ?>
         </div>
     <?php endif ?>
 
@@ -14,4 +15,4 @@
         <?= $this->relationRenderView() ?>
     </div>
 
-</div>
\ No newline at end of file
+</div>