Merge pull request #3865 from craftcms/4.8

4.8

Author: brandonkelly

CHANGELOG.md

@@ -2,10 +2,22 @@
 
 ## Unreleased
 
+### Store Management
+- Archived gateways are now listed on the Gateways index page. ([#3839](https://github.com/craftcms/commerce/issues/3839))
 - Improved Craft Commerce navigation and breadcrumb labels.
 
+### Extensibility
+- Added support for registering custom tax ID validators.
+- Added `\craft\commerce\services\Taxes::getEnabledTaxIdValidators()`.
+- Added `\craft\commerce\services\Taxes::getTaxIdValidators()`.
+- Added `craft\commerce\base\TaxIdValidatorInterface`.
+- Added `craft\commerce\services\Gateways\getAllArchivedGateways()`.
+- Added `craft\commerce\services\Taxes::EVENT_REGISTER_TAX_ID_VALIDATORS`.
+- Added `craft\commerce\taxidvalidators\EuVatIdValidator`.
+
 ## 4.7.3 - 2025-01-22
 
+- Improved the performance of recalculating shipping method prices. ([#3841](https://github.com/craftcms/commerce/pull/3841))
 - Fixed a bug where users products had a “Save as a new product” action even if a plugin was preventing duplication via `craft\services\Elements::EVENT_AUTHORIZE_DUPLICATE`. ([#3819](https://github.com/craftcms/commerce/issues/3819))
 - Fixed a PHP error that could occur when updating a cart. ([#3842](https://github.com/craftcms/commerce/issues/3842))
 - Fixed a PHP error that could occur when adding an invalid address to a cart. ([#3848](https://github.com/craftcms/commerce/issues/3848))

example-templates/dist/shop/_private/address/fields.twig

@@ -199,11 +199,11 @@ Outputs address form fields for editing an address.
     <hr class="my-2">
     <div class="my-2">
       {{ hiddenInput('isPrimaryBilling', 0) }}
-      <label>{{ input('checkbox', 'isPrimaryBilling', 1, { checked: address.isPrimaryBilling }) }} {{ 'Use as the primary billing address'|t('commerce') }}</label>
+      <label>{{ input('checkbox', 'isPrimaryBilling', 1, { checked: address.isPrimaryBilling }) }} {{ 'Use as the primary billing address'|t }}</label>
     </div>
     <div class="my-2">
       {{ hiddenInput('isPrimaryShipping', 0) }}
-      <label>{{ input('checkbox', 'isPrimaryShipping', 1, { checked: address.isPrimaryShipping }) }} {{ 'Use as the primary shipping address'|t('commerce') }}</label>
+      <label>{{ input('checkbox', 'isPrimaryShipping', 1, { checked: address.isPrimaryShipping }) }} {{ 'Use as the primary shipping address'|t }}</label>
     </div>
   {% endif %}
 </div>
@@ -251,4 +251,4 @@ document.querySelector('select#{{ 'countryCode'|namespaceInputId(addressName) }}
 });
 
 document.querySelector('select#{{ 'countryCode'|namespaceInputId(addressName) }}').dispatchEvent(new Event('change'));
-{% endjs %}
+{% endjs %}

example-templates/src/shop/_private/address/fields.twig

@@ -199,11 +199,11 @@ Outputs address form fields for editing an address.
     <hr class="my-2">
     <div class="my-2">
       {{ hiddenInput('isPrimaryBilling', 0) }}
-      <label>{{ input('checkbox', 'isPrimaryBilling', 1, { checked: address.isPrimaryBilling }) }} {{ 'Use as the primary billing address'|t('commerce') }}</label>
+      <label>{{ input('checkbox', 'isPrimaryBilling', 1, { checked: address.isPrimaryBilling }) }} {{ 'Use as the primary billing address'|t }}</label>
     </div>
     <div class="my-2">
       {{ hiddenInput('isPrimaryShipping', 0) }}
-      <label>{{ input('checkbox', 'isPrimaryShipping', 1, { checked: address.isPrimaryShipping }) }} {{ 'Use as the primary shipping address'|t('commerce') }}</label>
+      <label>{{ input('checkbox', 'isPrimaryShipping', 1, { checked: address.isPrimaryShipping }) }} {{ 'Use as the primary shipping address'|t }}</label>
     </div>
   {% endif %}
 </div>
@@ -251,4 +251,4 @@ document.querySelector('select#{{ 'countryCode'|namespaceInputId(addressName) }}
 });
 
 document.querySelector('select#{{ 'countryCode'|namespaceInputId(addressName) }}').dispatchEvent(new Event('change'));
-{% endjs %}
+{% endjs %}

src/Plugin.php

@@ -210,7 +210,7 @@ public static function editions(): array
     /**
      * @inheritDoc
      */
-    public string $schemaVersion = '4.7.0.1';
+    public string $schemaVersion = '4.8.0.0';
 
     /**
      * @inheritdoc

src/adjusters/Tax.php

@@ -10,13 +10,16 @@
 use Craft;
 use craft\base\Component;
 use craft\commerce\base\AdjusterInterface;
+use craft\commerce\base\TaxIdValidatorInterface;
 use craft\commerce\elements\Order;
 use craft\commerce\helpers\Currency;
 use craft\commerce\models\OrderAdjustment;
 use craft\commerce\models\TaxAddressZone;
 use craft\commerce\models\TaxRate;
 use craft\commerce\Plugin;
 use craft\commerce\records\TaxRate as TaxRateRecord;
+use craft\commerce\services\Taxes;
+use craft\commerce\taxidvalidators\EuVatIdValidator;
 use craft\elements\Address;
 use DvK\Vat\Validator;
 use Exception;
@@ -35,11 +38,6 @@ class Tax extends Component implements AdjusterInterface
 {
     public const ADJUSTMENT_TYPE = 'tax';
 
-    /**
-     * @var Validator|null
-     */
-    private ?Validator $_vatValidator = null;
-
     /**
      * @var Order
      */
@@ -118,17 +116,17 @@ private function _adjustInternal(): array
     private function _getAdjustments(TaxRate $taxRate): array
     {
         $adjustments = [];
-        $hasValidEuVatId = false;
+        $hasValidTaxId = false;
 
         $zoneMatches = $taxRate->getIsEverywhere() || ($taxRate->getTaxZone() && $this->_matchAddress($taxRate->getTaxZone()));
 
-        if ($zoneMatches && $taxRate->isVat) {
-            $hasValidEuVatId = $this->organizationTaxId();
+        if ($zoneMatches && $taxRate->hasTaxIdValidators()) {
+            $hasValidTaxId = $this->organizationTaxIdIsValidTaxId($taxRate->getSelectedEnabledTaxIdValidators());
         }
 
         $removeIncluded = (!$zoneMatches && $taxRate->removeIncluded);
-        $removeDueToVat = ($zoneMatches && $hasValidEuVatId && $taxRate->removeVatIncluded);
-        if ($removeIncluded || $removeDueToVat) {
+        $removeDueToVatId = ($zoneMatches && $hasValidTaxId && $taxRate->removeVatIncluded);
+        if ($removeIncluded || $removeDueToVatId) {
 
             // Is this an order level tax rate?
             if (in_array($taxRate->taxable, TaxRateRecord::ORDER_TAXABALES, false)) {
@@ -195,7 +193,7 @@ private function _getAdjustments(TaxRate $taxRate): array
             return $adjustments;
         }
 
-        if (!$zoneMatches || ($taxRate->isVat && $hasValidEuVatId)) {
+        if (!$zoneMatches || ($taxRate->hasTaxIdValidators() && $hasValidTaxId)) {
             return [];
         }
 
@@ -323,7 +321,7 @@ private function _matchAddress(TaxAddressZone $zone): bool
     /**
      * @return bool
      */
-    private function organizationTaxId(): bool
+    private function organizationTaxIdIsValidTaxId(array $validators): bool
     {
         if (!$this->_address) {
             return false;
@@ -340,7 +338,7 @@ private function organizationTaxId(): bool
 
         // If we do not have a valid VAT ID in cache, see if we can get one from the API
         if (!$validOrganizationTaxId) {
-            $validOrganizationTaxId = $this->validateVatNumber($this->_address->organizationTaxId);
+            $validOrganizationTaxId = $this->validateTaxIdNumber($this->_address->organizationTaxId, $validators);
         }
 
         if ($validOrganizationTaxId) {
@@ -355,25 +353,34 @@ private function organizationTaxId(): bool
     /**
      * @param string $businessVatId
      * @return bool
+     * @deprecated in 4.8.0. Use `validateTaxIdNumber()` instead, passing the validators you want to check the ID with.
      */
     protected function validateVatNumber(string $businessVatId): bool
+    {
+        $oldValidator = [new EuVatIdValidator()];
+        return $this->validateTaxIdNumber($businessVatId, $oldValidator);
+    }
+
+    /**
+     * @param string $organizationTaxId
+     * @param TaxIdValidatorInterface[] $validators
+     * @return bool
+     */
+    protected function validateTaxIdNumber(string $organizationTaxId, array $validators = []): bool
     {
         try {
-            return $this->_getVatValidator()->validate($businessVatId);
+            foreach ($validators as $validator) {
+                if ($validator->validate($organizationTaxId)) {
+                    return true;
+                }
+            }
         } catch (Exception $e) {
             Craft::error('Communication with VAT API failed: ' . $e->getMessage(), __METHOD__);
 
             return false;
         }
-    }
-
-    private function _getVatValidator(): Validator
-    {
-        if ($this->_vatValidator === null) {
-            $this->_vatValidator = new Validator();
-        }
 
-        return $this->_vatValidator;
+        return false;
     }
 
     private function _createAdjustment(TaxRate $rate): OrderAdjustment

src/base/TaxIdValidatorInterface.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\commerce\base;
+
+/**
+ * Interface for Tax ID Validators.
+ *
+ * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
+ * @since 4.8.0
+ */
+interface TaxIdValidatorInterface
+{
+    /**
+     * The display name of this tax ID type.
+     *
+     * @return string
+     * @since 4.8.0
+     */
+    public static function displayName(): string;
+
+    /**
+     * Tests if the ID looks generally correct. This would usually be something like a regex check.
+     *
+     * @param string $idNumber
+     * @return bool
+     * @since 4.8.0
+     */
+    public function validateFormat(string $idNumber): bool;
+
+    /**
+     * Tests if the ID exists as valid in the country's tax system. This would usually be an API call.
+     *
+     * @param string $idNumber
+     * @return bool
+     * @since 4.8.0
+     */
+    public function validateExistence(string $idNumber): bool;
+
+    /**
+     * This would usually just call validateFormat() and then validateExistence() and return the result.
+     *
+     * @param string $idNumber
+     * @return bool
+     * @since 4.8.0
+     */
+    public function validate(string $idNumber): bool;
+
+    /**
+     * Tests if the validator is available for use by tax rates.
+     * This would usually be a check against the existence or settings or API keys so that the validator can be used.
+     *
+     * @return bool
+     * @since 4.8.0
+     */
+    public static function isEnabled(): bool;
+}

src/behaviors/ValidateOrganizationTaxIdBehavior.php

@@ -6,7 +6,6 @@
 use craft\commerce\Plugin;
 use craft\elements\Address;
 use craft\events\DefineRulesEvent;
-use DvK\Vat\Validator;
 use Exception;
 use RuntimeException;
 use yii\base\Behavior;
@@ -16,11 +15,6 @@ class ValidateOrganizationTaxIdBehavior extends Behavior
     /** @var Address */
     public $owner;
 
-    /**
-     * @var Validator
-     */
-    private Validator $_vatValidator;
-
     /**
      * @inheritdoc
      */
@@ -89,23 +83,16 @@ public function validateOrganizationTaxId(): void
     private function _validateVatNumber(string $businessVatId): bool
     {
         try {
-            return $this->_getVatValidator()->validate($businessVatId);
+            $validators = Plugin::getInstance()->getTaxes()->getEnabledTaxIdValidators();
+            foreach ($validators as $validator) {
+                if ($validator->validate($businessVatId)) {
+                    return true;
+                }
+            }
         } catch (Exception $e) {
-            Craft::error('Communication with VAT API failed: ' . $e->getMessage(), __METHOD__);
-
-            return false;
-        }
-    }
-
-    /**
-     * @return Validator
-     */
-    private function _getVatValidator(): Validator
-    {
-        if (!isset($this->_vatValidator)) {
-            $this->_vatValidator = new Validator();
+            Craft::error('Communication with Tax ID validators failed: ' . $e->getMessage(), __METHOD__);
         }
 
-        return $this->_vatValidator;
+        return false;
     }
 }

src/console/controllers/UpgradeController.php

@@ -438,7 +438,11 @@ private function _customField(string $oldAttribute, string $label, ?string $pref
 
             $field = new PlainText();
             $field->groupId = ArrayHelper::firstValue(Craft::$app->getFields()->getAllGroups())->id;
-            $field->columnType = Schema::TYPE_STRING;
+            if ($oldAttribute == 'notes') {
+                $field->columnType = Schema::TYPE_TEXT;
+            } else {
+                $field->columnType = Schema::TYPE_STRING;
+            }
             $field->handle = $this->prompt('Field handle:', [
                 'required' => true,
                 'validator' => function($handle) use ($handlePattern, $fieldsService) {

src/controllers/GatewaysController.php

@@ -8,12 +8,16 @@
 namespace craft\commerce\controllers;
 
 use Craft;
+use craft\base\MissingComponentInterface;
 use craft\commerce\base\Gateway;
 use craft\commerce\base\GatewayInterface;
+use craft\commerce\db\Table;
 use craft\commerce\gateways\Dummy;
 use craft\commerce\helpers\DebugPanel;
 use craft\commerce\Plugin;
+use craft\db\Query;
 use craft\errors\DeprecationException;
+use craft\helpers\Html;
 use craft\helpers\Json;
 use yii\base\Exception;
 use yii\base\InvalidConfigException;
@@ -32,9 +36,33 @@ class GatewaysController extends BaseAdminController
     public function actionIndex(): Response
     {
         $gateways = Plugin::getInstance()->getGateways()->getAllGateways();
+        $archivedGateways = Plugin::getInstance()->getGateways()->getAllArchivedGateways();
+
+        if (!empty($archivedGateways)) {
+            $gatewayIdsWithTransactions = (new Query())
+                ->select(['gatewayId'])
+                ->from(Table::TRANSACTIONS)
+                ->groupBy(['gatewayId'])
+                ->column();
+
+            foreach ($archivedGateways as &$gateway) {
+                $missing = $gateway instanceof MissingComponentInterface;
+                $gateway = [
+                    'id' => $gateway->id,
+                    'title' => Craft::t('site', $gateway->name),
+                    'handle' => Html::encode($gateway->handle),
+                    'type' => [
+                        'missing' => $missing,
+                        'name' => $missing ? $gateway->expectedType : $gateway->displayName(),
+                    ],
+                    'hasTransactions' => in_array($gateway->id, $gatewayIdsWithTransactions),
+                ];
+            }
+        }
 
         return $this->renderTemplate('commerce/settings/gateways/index', [
             'gateways' => $gateways,
+            'archivedGateways' => array_values($archivedGateways),
         ]);
     }