Merge pull request #4159 from craftcms/nathaniel/com-493-5x-product-type-settings

[5.5] Add "Product type settings" action menu item to edit product screens

Author: lukeholder

CHANGELOG-WIP.md

@@ -8,6 +8,7 @@
 - Added preview targets for products. ([#4128](https://github.com/craftcms/commerce/pull/4128))
 - Added slug translation options to product types. ([#4088](https://github.com/craftcms/commerce/pull/4088))
 - Gateway condition rules now allow multiple gateways to be selected. ([#4112](https://github.com/craftcms/commerce/issues/4112))
+- Product action menus now have “Product type settings” action, for admin users on environments that allow admin changes. ([#4157](https://github.com/craftcms/commerce/issues/4157))
 
 ### Development
 - Orders now have a `dateFirstPaid` property that records the date and time when the order was first paid in full.

src/controllers/ProductTypesController.php

@@ -67,46 +67,55 @@ public function actionEditProductType(int $productTypeId = null, ProductType $pr
         if (!empty($variables['productTypeId'])) {
             $variables['title'] = $variables['productType']->name;
         } else {
-            $variables['title'] = Craft::t('commerce', 'Create a Product Type');
+            $variables['title'] = Craft::t('commerce', 'Create a new product type');
         }
 
         DebugPanel::prependOrAppendModelTab(model: $variables['productType'], prepend: true);
 
-        $tabs = [
-            'productTypeSettings' => [
-                'label' => Craft::t('commerce', 'Settings'),
-                'url' => '#product-type-settings',
-            ],
-            'taxAndShipping' => [
-                'label' => Craft::t('commerce', 'Tax & Shipping'),
-                'url' => '#tax-and-shipping',
-            ],
-            'productFields' => [
-                'label' => Craft::t('commerce', 'Product Fields'),
-                'url' => '#product-fields',
-            ],
-            'variantFields' => [
-                'label' => Craft::t('commerce', 'Variant Fields'),
-                'url' => '#variant-fields',
-            ],
-        ];
-
-        $variables['tabs'] = $tabs;
         $variables['selectedTab'] = 'productTypeSettings';
 
         $this->getView()->registerAssetBundle(EditSectionAsset::class);
 
         $variables['readOnly'] = $this->isReadOnlyScreen();
 
-        return $this->renderTemplate('commerce/settings/producttypes/_edit', $variables);
+        return $this->asCpScreen()
+            ->title($variables['title'])
+            ->crumbs([
+                ['label' => Craft::t('commerce', 'Commerce'), 'url' => 'commerce'],
+                ['label' => Craft::t('app', 'Settings'), 'url' => 'commerce/settings', 'ariaLabel' => Craft::t('commerce', 'Commerce Settings')],
+                ['label' => Craft::t('commerce', 'Product Types'), 'url' => 'commerce/settings/producttypes'],
+            ])
+            ->tabs([
+                'productTypeSettings' => [
+                    'label' => Craft::t('commerce', 'Settings'),
+                    'url' => '#product-type-settings',
+                ],
+                'taxAndShipping' => [
+                    'label' => Craft::t('commerce', 'Tax & Shipping'),
+                    'url' => '#tax-and-shipping',
+                ],
+                'productFields' => [
+                    'label' => Craft::t('commerce', 'Product Fields'),
+                    'url' => '#product-fields',
+                ],
+                'variantFields' => [
+                    'label' => Craft::t('commerce', 'Variant Fields'),
+                    'url' => '#variant-fields',
+                ],
+            ])
+            ->selectedSubnavItem('settings')
+            ->action('commerce/product-types/save-product-type')
+            ->submitButtonLabel(Craft::t('app', 'Save'))
+            ->redirectUrl('commerce/settings/producttypes')
+            ->contentTemplate('commerce/settings/producttypes/_edit', $variables);
     }
 
     /**
      * @throws HttpException
      * @throws Throwable
      * @throws BadRequestHttpException
      */
-    public function actionSaveProductType(): void
+    public function actionSaveProductType(): ?Response
     {
         $currentUser = Craft::$app->getUser()->getIdentity();
 
@@ -199,16 +208,15 @@ public function actionSaveProductType(): void
 
         // Save it
         if (Plugin::getInstance()->getProductTypes()->saveProductType($productType)) {
-            $this->setSuccessFlash(Craft::t('commerce', 'Product type saved.'));
-            $this->redirectToPostedUrl($productType);
-        } else {
-            $this->setFailFlash(Craft::t('commerce', 'Couldn’t save product type.'));
+            return $this->asSuccess(Craft::t('commerce', 'Product type saved.'), redirect: $this->getPostedRedirectUrl($productType));
         }
 
         // Send the productType back to the template
         Craft::$app->getUrlManager()->setRouteParams([
             'productType' => $productType,
         ]);
+
+        return $this->asModelFailure($productType, Craft::t('commerce', 'Couldn’t save product type.'), 'productType');
     }
 
     /**

src/elements/Product.php

@@ -463,6 +463,42 @@ protected static function defineActions(string $source = null): array
         return $actions;
     }
 
+    /**
+     * @inheritdoc
+     */
+    protected function safeActionMenuItems(): array
+    {
+        $actions = parent::safeActionMenuItems();
+
+        if (
+            Craft::$app->getUser()->getIsAdmin() &&
+            Craft::$app->getConfig()->getGeneral()->allowAdminChanges
+        ) {
+            // Product type settings
+            $productTypeEditId = sprintf('edit-product-type-%s', mt_rand());
+            $actions[] = [
+                'id' => $productTypeEditId,
+                'icon' => 'gear',
+                'label' => Craft::t('commerce', 'Product type settings'),
+            ];
+
+            $view = Craft::$app->getView();
+            $view->registerJsWithVars(fn($id, $params) => <<<JS
+(() => {
+  $('#' + $id).on('activate', function() {
+    const params = $params;
+    new Craft.CpScreenSlideout('commerce/product-types/edit-product-type', {params});
+  });
+})();
+JS, [
+                $view->namespaceInputId($productTypeEditId),
+                ['productTypeId' => $this->typeId],
+            ]);
+        }
+
+        return $actions;
+    }
+
     /**
      * @inheritdoc
      */

src/templates/settings/producttypes/_edit.twig

@@ -1,12 +1,3 @@
-{% extends "commerce/_layouts/cp" %}
-{% set title = productType.id ? productType.name : 'Create a new product type'|t('commerce') %}
-
-{% set crumbs = [
-    { label: 'Commerce'|t('commerce'), url: url('commerce') },
-    { label: 'Settings'|t('app'), url: url('commerce/settings'), ariaLabel: 'Commerce Settings'|t('commerce') },
-    { label: "Product Types"|t('commerce'), url: url('commerce/settings/producttypes') },
-] %}
-
 {% set selectedSubnavItem = 'settings' %}
 
 {% set headlessMode = craft.app.config.general.headlessMode %}

src/translations/en/commerce.php

@@ -883,6 +883,7 @@
     'Product Variant' => 'Product Variant',
     'Product Variants' => 'Product Variants',
     'Product type saved.' => 'Product type saved.',
+    'Product type settings' => 'Product type settings',
     'Product' => 'Product',
     'Products and Variants deleted.' => 'Products and Variants deleted.',
     'Products not restored.' => 'Products not restored.',