Support magento2.4

Api/Data/CustomFieldsInterface.php

@@ -26,6 +26,14 @@ interface CustomFieldsInterface
     const CHECKOUT_GOODS_MARK = 'checkout_goods_mark';
     const CHECKOUT_COMMENT = 'checkout_comment';
 
+    const ATTRIBUTES = [
+        self::CHECKOUT_BUYER_EMAIL,
+        self::CHECKOUT_BUYER_NAME,
+        self::CHECKOUT_COMMENT,
+        self::CHECKOUT_GOODS_MARK,
+        self::CHECKOUT_PURCHASE_ORDER_NO,
+    ];
+
     /**
      * Get checkout buyer name
      *
@@ -105,4 +113,48 @@ public function setCheckoutGoodsMark(string $checkoutGoodsMark = null);
      * @return CustomFieldsInterface
      */
     public function setCheckoutComment(string $comment = null);
+
+    /**
+     * Checks if a field is enabled
+     *
+     * @param string $fieldName
+     *
+     * @return bool
+     */
+    public function isFieldEnabled(string $fieldName): bool;
+
+    /**
+     * Checks if buyer name field is enabled
+     *
+     * @return bool
+     */
+    public function isCheckoutBuyerNameEnabled(): bool;
+
+    /**
+     * Checks if buyer name field is enabled
+     *
+     * @return bool
+     */
+    public function isCheckoutBuyerEmailEnabled(): bool;
+
+    /**
+     * Checks if purchase order field is enabled
+     *
+     * @return bool
+     */
+    public function isCheckoutPurchaseOrderNoEnabled(): bool;
+
+    /**
+     * Checks if goods mark field is enabled
+     *
+     * @return bool
+     */
+    public function isCheckoutGoodsMarkEnabled(): bool;
+
+    /**
+     * Checks if comment field is enabled
+     *
+     * @return bool
+     */
+    public function isCheckoutCommentEnabled(): bool;
 }

Helper/Config.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Bodak\CheckoutCustomForm\Helper;
+
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
+use Psr\Log\LoggerInterface;
+
+class Config
+{
+    const LIMIT_NOT_SET = -1;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $config;
+
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * Config constructor.
+     *
+     * @param ScopeConfigInterface $config
+     * @param StoreManagerInterface $storeManager
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        ScopeConfigInterface $config,
+        StoreManagerInterface $storeManager,
+        LoggerInterface $logger
+    ) {
+        $this->config = $config;
+        $this->storeManager = $storeManager;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @return array
+     */
+    public function getEnabledFields()
+    {
+        return explode(',',
+            $this->config->getValue('bodak/checkout/enabled_fields',
+                ScopeInterface::SCOPE_STORE));
+    }
+
+    /**
+     * @param $attribute
+     *
+     * @return int
+     */
+    public function getAllowedLength($attribute)
+    {
+        $configPath = 'checkout/general/' . $attribute . '_limit';
+        try {
+            $allowedLength = $this->config->getValue($configPath, ScopeInterface::SCOPE_STORES,
+                $this->storeManager->getStore()->getId());
+        } catch (NoSuchEntityException $e) {
+            $this->logger->error('Cannot get allowed length for custom field. Falling back to default scope value.');
+            $this->logger->error($e->getMessage(), ['exception' => $e]);
+            $allowedLength = $this->config->getValue($configPath);
+        }
+
+        return (int)$allowedLength ?: self::LIMIT_NOT_SET;
+    }
+}

Model/Checkout/LayoutProcessor/Plugin.php

@@ -0,0 +1,140 @@
+<?php
+
+/**
+ * @package   Bodak\CheckoutCustomForm
+ * @author    Konrad Langenberg <k.langenberg@imi.de>
+ * @copyright © 2017 Slawomir Bodak
+ * @license   See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Bodak\CheckoutCustomForm\Model\Checkout\LayoutProcessor;
+
+use Bodak\CheckoutCustomForm\Api\Data\CustomFieldsInterface;
+use Bodak\CheckoutCustomForm\Helper\Config;
+
+class Plugin
+{
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @var array
+     */
+    private $fields = [
+        [
+            'dataScopeName' => CustomFieldsInterface::CHECKOUT_BUYER_NAME,
+            'label' => 'Buyer name',
+        ],
+        [
+            'dataScopeName' => CustomFieldsInterface::CHECKOUT_BUYER_EMAIL,
+            'label' => 'Buyer email',
+            'validation' => [
+                'validate-email' => true,
+            ],
+            'config' => [
+                'tooltip' => [
+                    'description' => 'We will send an order confirmation to this email address',
+                ],
+            ],
+        ],
+        [
+            'dataScopeName' => CustomFieldsInterface::CHECKOUT_PURCHASE_ORDER_NO,
+            'label' => 'Purchase order no.',
+        ],
+        [
+            'dataScopeName' => CustomFieldsInterface::CHECKOUT_GOODS_MARK,
+            'label' => 'Goods mark',
+        ],
+        [
+            'dataScopeName' => CustomFieldsInterface::CHECKOUT_COMMENT,
+            'label' => 'Comment',
+            'config' => [
+                'cols' => 15,
+                'rows' => 2,
+                'maxlength' => null,
+                'elementTmpl' => 'Bodak_CheckoutCustomForm/form/element/textarea',
+            ],
+            'showTitle' => false,
+        ],
+    ];
+
+    /**
+     * LayoutProcessor constructor.
+     *
+     * @param Config $config
+     */
+    public function __construct(Config $config)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * @param \Magento\Checkout\Block\Checkout\LayoutProcessor $subject
+     * @param array $jsLayout
+     *
+     * @return array
+     * @see \Magento\Checkout\Block\Checkout\LayoutProcessor::process
+     */
+    public function afterProcess(
+        \Magento\Checkout\Block\Checkout\LayoutProcessor $subject,
+        array $jsLayout
+    ) {
+        $config = $this->config->getEnabledFields();
+
+        $this->applyLengthLimitToFields();
+
+        foreach ($this->fields as $sortOrder => $field) {
+            if (!in_array($field['dataScopeName'], $config)) {
+                continue;
+            }
+            if (!isset($field['showTitle'])) {
+                $field['showTitle'] = true;
+            }
+
+            $formField = [
+                'component' => 'Magento_Ui/js/form/element/abstract',
+                'config' => [
+                    'customScope' => 'customCheckoutForm',
+                    'template' => 'ui/form/field',
+                    'elementTmpl' => 'ui/form/element/input',
+                ],
+                'provider' => 'checkoutProvider',
+                'dataScope' => 'customCheckoutForm.' . $field['dataScopeName'],
+                'label' => $field['showTitle'] ? __($field['label']) : '',
+                'sortOrder' => $sortOrder + 1,
+                'validation' => [],
+            ];
+
+            if (isset($field['config'])) {
+                $formField['config'] = array_merge($formField['config'], $field['config']);
+            }
+
+            if (isset($field['validation'])) {
+                $formField['validation'] = array_merge($formField['validation'], $field['validation']);
+            }
+
+            $jsLayout['components']['checkout']['children']['steps']['children']['shipping-step']
+            ['children']['shippingAddress']['children']['custom-checkout-form-container']
+            ['children']['custom-checkout-form-fieldset']['children'][$field['dataScopeName']] = $formField;
+        }
+
+        return $jsLayout;
+    }
+
+    private function applyLengthLimitToFields()
+    {
+        foreach ($this->fields as $key => $field) {
+            $fieldName = $field['dataScopeName'];
+            $allowedLength = $this->config->getAllowedLength($fieldName);
+            if ($allowedLength === Config::LIMIT_NOT_SET) {
+                continue;
+            }
+            $this->fields[$key]['config']['maxlength'] = $allowedLength;
+            $this->fields[$key]['validation']['max_text_length'] = $allowedLength;
+        }
+    }
+}

Model/Config/Source/Option.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @package   Bodak\CheckoutCustomForm
+ * @author    Konrad Langenberg <k.langenberg@imi.de>
+ * @copyright © 2017 Slawomir Bodak
+ * @license   See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Bodak\CheckoutCustomForm\Model\Config\Source;
+
+use \Magento\Framework\Option\ArrayInterface;
+use \Bodak\CheckoutCustomForm\Api\Data\CustomFieldsInterface;
+
+class Option implements ArrayInterface
+{
+    public function toOptionArray()
+    {
+        return [
+            ['value' => CustomFieldsInterface::CHECKOUT_BUYER_NAME, 'label' => 'Buyer Name'],
+            ['value' => CustomFieldsInterface::CHECKOUT_BUYER_EMAIL, 'label' => 'Buyer email'],
+            ['value' => CustomFieldsInterface::CHECKOUT_PURCHASE_ORDER_NO, 'label' => 'Purchase order no.'],
+            ['value' => CustomFieldsInterface::CHECKOUT_GOODS_MARK, 'label' => 'Goods mark'],
+            ['value' => CustomFieldsInterface::CHECKOUT_COMMENT, 'label' => 'Comment'],
+        ];
+    }
+}