[5.1] Use Dialog field for Modal_Category (#42293)

Changing Modal_Category field to use new modal dialog.
Category field extends ModalSelectField - #40462

administrator/components/com_categories/layouts/joomla/form/field/modal-select/extra-buttons.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  Layout
+ *
+ * @copyright   (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+
+extract($displayData);
+
+/**
+ * Layout variables
+ * -----------------
+ * @var   string   $autocomplete    Autocomplete attribute for the field.
+ * @var   boolean  $autofocus       Is autofocus enabled?
+ * @var   string   $class           Classes for the input.
+ * @var   string   $description     Description of the field.
+ * @var   boolean  $disabled        Is this field disabled?
+ * @var   string   $group           Group the field belongs to. <fields> section in form XML.
+ * @var   boolean  $hidden          Is this field hidden in the form?
+ * @var   string   $hint            Placeholder for the field.
+ * @var   string   $id              DOM id of the field.
+ * @var   string   $label           Label of the field.
+ * @var   string   $labelclass      Classes to apply to the label.
+ * @var   boolean  $multiple        Does this field support multiple values?
+ * @var   string   $name            Name of the input field.
+ * @var   string   $onchange        Onchange attribute for the field.
+ * @var   string   $onclick         Onclick attribute for the field.
+ * @var   string   $pattern         Pattern (Reg Ex) of value of the form field.
+ * @var   boolean  $readonly        Is this field read only?
+ * @var   boolean  $repeat          Allows extensions to duplicate elements.
+ * @var   boolean  $required        Is this field required?
+ * @var   integer  $size            Size attribute of the input.
+ * @var   boolean  $spellcheck      Spellcheck state for the form field.
+ * @var   string   $validate        Validation rules to apply.
+ * @var   string   $value           Value attribute of the field.
+ * @var   string   $dataAttribute   Miscellaneous data attributes preprocessed for HTML output
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*
+ * @var   string   $valueTitle
+ * @var   array    $canDo
+ * @var   string[] $urls
+ * @var   string[] $modalTitles
+ * @var   string   $language
+ */
+
+// Do nothing when propagate is disabled
+if (empty($canDo['propagate'])) {
+    return;
+}
+
+// Scripts for backward compatibility
+/** @var \Joomla\CMS\WebAsset\WebAssetManager $wa */
+$wa = Factory::getApplication()->getDocument()->getWebAssetManager();
+$wa->useScript('field.modal-fields');
+$wa->addInlineScript(
+    'window.jSelectCategory_' . $id . ' = function (id, title, object) {
+  window.processModalSelect("Category", "' . $id . '", id, title, "", object);
+}',
+    ['name' => 'inline.select_category_' . $id],
+    ['type' => 'module']
+);
+Text::script('JGLOBAL_ASSOCIATIONS_PROPAGATE_FAILED');
+
+// Language propagate callback name
+// Strip off language tag at the end
+$tagLength            = strlen($language);
+$callbackFunctionStem = substr("jSelectCategory_" . $id, 0, -$tagLength);
+
+?>
+
+<button type="button" class="btn btn-primary" <?php echo $value ? '' : 'hidden'; ?>
+        title="<?php echo $this->escape(Text::_('JGLOBAL_ASSOCIATIONS_PROPAGATE_TIP')); ?>"
+        data-show-when-value="1"
+        onclick="Joomla.propagateAssociation('<?php echo $id; ?>', '<?php echo $callbackFunctionStem; ?>')">
+    <span class="icon-sync" aria-hidden="true"></span> <?php echo Text::_('JGLOBAL_ASSOCIATIONS_PROPAGATE_BUTTON'); ?>
+</button>

administrator/components/com_categories/src/Controller/CategoryController.php

@@ -14,6 +14,7 @@
 use Joomla\CMS\MVC\Controller\FormController;
 use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
 use Joomla\CMS\MVC\Model\BaseDatabaseModel;
+use Joomla\CMS\Router\Route;
 use Joomla\CMS\Versioning\VersionableControllerTrait;
 use Joomla\Input\Input;
 use Joomla\Registry\Registry;
@@ -152,6 +153,15 @@ public function cancel($key = null)
         $newKey = $this->option . '.edit.category.' . substr($this->extension, 4) . '.data';
         $this->app->setUserState($newKey, null);
 
+        // When editing in modal then redirect to modalreturn layout
+        if ($result && $this->input->get('layout') === 'modal') {
+            $id     = $this->input->get('id');
+            $return = 'index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($id)
+                . '&layout=modalreturn&from-task=cancel';
+
+            $this->setRedirect(Route::_($return, false));
+        }
+
         return $result;
     }
 
@@ -243,5 +253,14 @@ protected function postSaveHook(BaseDatabaseModel $model, $validData = [])
             $registry       = new Registry($item->metadata);
             $item->metadata = (string) $registry;
         }
+
+        // When editing in modal then redirect to modalreturn layout
+        if ($this->input->get('layout') === 'modal' && $this->task === 'save') {
+            $id     = $item->id;
+            $return = 'index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($id)
+                . '&layout=modalreturn&from-task=save';
+
+            $this->setRedirect(Route::_($return, false));
+        }
     }
 }