Issue #2893967 by cbildstein, acromel, bojanz, AaronChristian, rszrama: Improve the UX of importing / creating currencies

Author: cbildstein

modules/price/commerce_price.links.action.yml

@@ -1,11 +1,11 @@
-entity.commerce_currency.add_form:
-  route_name: entity.commerce_currency.add_form
+entity.commerce_currency.import:
+  route_name: entity.commerce_currency.import
   title: 'Add currency'
   appears_on:
     - entity.commerce_currency.collection
 
-entity.commerce_currency.import:
-  route_name: entity.commerce_currency.import
-  title: 'Import currencies'
+entity.commerce_currency.add_form:
+  route_name: entity.commerce_currency.add_form
+  title: 'Add custom currency'
   appears_on:
     - entity.commerce_currency.collection

modules/price/commerce_price.routing.yml

@@ -1,7 +1,8 @@
+# The import URL and title use the "Add" verb to better match user expectations.
 entity.commerce_currency.import:
-  path: '/admin/commerce/config/currencies/import'
+  path: '/admin/commerce/config/currencies/add'
   defaults:
     _form: '\Drupal\commerce_price\Form\CurrencyImportForm'
-    _title: 'Import currencies'
+    _title: 'Add currency'
   requirements:
     _permission: 'administer commerce_currency'

modules/price/src/CurrencyRouteProvider.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Drupal\commerce_price;
+
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider;
+
+/**
+ * Provides routes for the Currency entity.
+ */
+class CurrencyRouteProvider extends DefaultHtmlRouteProvider {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getAddFormRoute(EntityTypeInterface $entity_type) {
+    $route = parent::getAddFormRoute($entity_type);
+    // Replace the "Add currency" title with "Add custom currency".
+    // The t() function is used to ensure the string is picked up for
+    // translation, even though _title is supposed to be untranslated.
+    $route->setDefault('_title_callback', '');
+    $route->setDefault('_title', t('Add custom currency')->getUntranslatedString());
+
+    return $route;
+  }
+
+}

modules/price/src/Entity/Currency.php

@@ -24,7 +24,7 @@
  *       "delete" = "Drupal\Core\Entity\EntityDeleteForm"
  *     },
  *     "route_provider" = {
- *       "default" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
+ *       "default" = "Drupal\commerce_price\CurrencyRouteProvider",
  *     },
  *     "list_builder" = "Drupal\commerce_price\CurrencyListBuilder",
  *   },
@@ -43,7 +43,7 @@
  *     "fractionDigits"
  *   },
  *   links = {
- *     "add-form" = "/admin/commerce/config/currencies/add",
+ *     "add-form" = "/admin/commerce/config/currencies/add-custom",
  *     "edit-form" = "/admin/commerce/config/currencies/{commerce_currency}",
  *     "delete-form" = "/admin/commerce/config/currencies/{commerce_currency}/delete",
  *     "collection" = "/admin/commerce/config/currencies"

modules/price/src/Form/CurrencyForm.php

@@ -45,12 +45,6 @@ public function form(array $form, FormStateInterface $form_state) {
     /** @var \Drupal\commerce_price\Entity\CurrencyInterface $currency */
     $currency = $this->entity;
 
-    $import_url = Url::fromRoute('entity.commerce_currency.import')->toString();
-    $form['message'] = [
-      '#type' => 'markup',
-      '#markup' => $this->t('This form is only intended for creating custom currencies. Real-world currencies should be <a href=":url">imported</a>.', [':url' => $import_url]),
-    ];
-
     $form['name'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Name'),

modules/price/src/Form/CurrencyImportForm.php

@@ -56,8 +56,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     else {
       $form['currency_codes'] = [
         '#type' => 'select',
-        '#title' => $this->t('Currencies'),
-        '#required' => TRUE,
+        '#title' => $this->t('Available currencies'),
         '#options' => $currencies,
         '#multiple' => TRUE,
         '#size' => 10,
@@ -67,7 +66,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
         '#type' => 'submit',
         '#button_type' => 'primary',
         '#name' => 'import',
-        '#value' => $this->t('Import'),
+        '#value' => $this->t('Add'),
         '#submit' => ['::submitForm'],
       ];
     }

modules/price/tests/src/Functional/CurrencyTest.php

@@ -17,11 +17,11 @@ class CurrencyTest extends CommerceBrowserTestBase {
    * Tests importing a currency.
    */
   public function testCurrencyImport() {
-    $this->drupalGet('admin/commerce/config/currencies/import');
+    $this->drupalGet('admin/commerce/config/currencies/add');
     $edit = [
       'currency_codes[]' => ['CHF'],
     ];
-    $this->submitForm($edit, 'Import');
+    $this->submitForm($edit, 'Add');
 
     $url = Url::fromRoute('entity.commerce_currency.collection');
     $this->assertEquals($this->getUrl(), $this->getAbsoluteUrl($url->toString()));
@@ -35,11 +35,11 @@ public function testCurrencyImport() {
   }
 
   /**
-   * Tests creating a currency.
+   * Tests adding a currency.
    */
   public function testCurrencyCreation() {
     $this->drupalGet('admin/commerce/config/currencies');
-    $this->getSession()->getPage()->clickLink('Add currency');
+    $this->getSession()->getPage()->clickLink('Add custom currency');
     $edit = [
       'name' => 'Test currency',
       'currencyCode' => 'XXX',