XhtmlXpert

I have a client’s requirement to add a new custom attribute in the company module of the B2B extension.

The need was to add a unique SAP ID in the Account Information section of the company form

To achieve this requirement we follow below steps

Step 1

Create a new module app/code/XHTMLXPERT/Company

Step 2

Add new field sap_id in company table using declarative schema under app/code/XHTMLXPERT/Company/etc/db_schema.xml

<?xml version="1.0" ?>
<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema.xsd">
    <table name="company">
        <column name="sap_id" nullable="true" xsi:type="varchar" comment="company SAP ID" length="255"/>
        <constraint xsi:type="unique" referenceId="UNQIQUE_SAP_ID">
            <column name="sap_id"/>
        </constraint>
    </table>
</schema>

Step 3

Add SAP ID field in the company form

To achieve this create file app/code/XHTMLXPERT/Company/view/base/ui_component/company_form.xml
fieldset name should remain information, if you want to show the field in any other section change name accordingly

<?xml version="1.0" ?>
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
	<fieldset name="information">
		<field name="sap_id" formElement="input">
			<argument name="data" xsi:type="array">
				<item name="config" xsi:type="array">
					<item name="source" xsi:type="string">sap_id</item>
				</item>
			</argument>
			<settings>
				<label translate="true">SAP ID</label>
				<dataType>text</dataType>
				<validation>
					<rule name="required-entry" xsi:type="boolean">true</rule>
				</validation>
			</settings>
		</field>
	</fieldset>
</form>

Step 4

To show the field in Companies grid

Create file app/code/XHTMLXPERT/Company/view/adminhtml/ui_component/company_listing.xml and copy and paste the below xml in the same file

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="company_columns">
        <column name="sap_id" sortOrder="230">
            <settings>
                <filter>text</filter>
                <label translate="true">SAP ID</label>
                <visible>true</visible>
            </settings>
        </column>
    </columns>
</listing>

Step 5

Add Extension Attribute

app/code/XHTMLXPERT/Company/etc/extension_attributes.xml

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
	<extension_attributes for="Magento\Company\Api\Data\CompanyInterface">
		<attribute code="sap_id" type="string"/>
	</extension_attributes>
</config>

Step 6

To save and retrieve SAP ID it is required to create the below plugin’s

Create app/code/XHTMLXPERT/Company/etc/di.xml

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
	<type name="Magento\Company\Model\Company\DataProvider">
		<plugin name="XHTMLXPERT_Company_Plugin_Magento_Company_Model_Company_DataProvider" type="XHTMLXPERT\Company\Plugin\Magento\Company\Model\Company\DataProvider" sortOrder="10" disabled="false"/>
	</type>
	<type name="Magento\Company\Controller\Adminhtml\Index\Save">
		<plugin name="XHTMLXPERT_Company_Plugin_Magento_Company_Controller_Adminhtml_Index_Save" type="XHTMLXPERT\Company\Plugin\Magento\Company\Controller\Adminhtml\Index\Save" sortOrder="20" disabled="false"/>
	</type>
	<type name="Magento\Company\Api\CompanyRepositoryInterface">
		<plugin name="XHTMLXPERT_Company_Plugin_Magento_Company_Api_CompanyRepositoryInterface" type="XHTMLXPERT\Company\Plugin\Magento\Company\Api\CompanyRepositoryInterface" sortOrder="10" disabled="false"/>
	</type>
</config>

To save the unique values in the database create the below plugin

app/code/XHTMLXPERT/Company/Plugin/Magento/Company/Controller/Adminhtml/Index/Save.php

<?php

declare(strict_types=1);

namespace XHTMLXPERT\Company\Plugin\Magento\Company\Controller\Adminhtml\Index;

use Magento\Company\Api\CompanyRepositoryInterface;
use Magento\Company\Controller\Adminhtml\Index\Save as ParentSave;
use Magento\Framework\Api\FilterBuilder;
use Magento\Framework\Api\Search\FilterGroupBuilder;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\App\ResponseFactory;
use Magento\Framework\Controller\Result\RedirectFactory;
use Magento\Framework\Message\ManagerInterface;
use Magento\Framework\UrlInterface;

class Save
{

    /**
     * @var SearchCriteriaBuilder
     */
    private SearchCriteriaBuilder $searchCriteriaBuilder;

    /**
     * @var FilterBuilder
     */
    private FilterBuilder $filterBuilder;

    /**
     * @var FilterGroupBuilder
     */
    private FilterGroupBuilder $filterGroupBuilder;

    /**
     * @var \Magento\Framework\App\ResponseFactory
     */
    private $responseFactory;

    /**
     * @var \Magento\Framework\UrlInterface
     */
    private $url;

    /**
     * @var ManagerInterface
     */
    private $messageManager;

    public function __construct(
        SearchCriteriaBuilder $searchCriteriaBuilder,
        FilterBuilder $filterBuilder,
        FilterGroupBuilder $filterGroupBuilder,
        CompanyRepositoryInterface $companyRepository,
        ResponseFactory $responseFactory,
        UrlInterface $url,
        ManagerInterface $messageManager
    ) {
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->filterBuilder = $filterBuilder;
        $this->filterGroupBuilder = $filterGroupBuilder;
        $this->companyRepository = $companyRepository;
        $this->responseFactory = $responseFactory;
        $this->url = $url;
        $this->messageManager = $messageManager;
    }

    /**
     * @param ParentSave $subject
     * @param $result
     * @return mixed
     */
    public function afterSetCompanyRequestData(
        ParentSave $subject,
        $result
    ) {
            $companyExtension = $result->getExtensionAttributes();
            $companyExtension->setSapId($subject->getRequest()->getPostValue('information')['sap_id']);
            $result->setExtensionAttributes($companyExtension);

        return $result;
    }

    public function beforeExecute(
        ParentSave $subject
    ) {
        $request = $subject->getRequest();
        $id = $request->getParam('id') ? $request->getParam('id') : null;
        $sapID = $subject->getRequest()->getPostValue('information')['sap_id'] ??  $subject->getRequest()->getPostValue('information')['sap_id'];
        if($sapID) {
            $sapIdFilter = $this->filterBuilder
                ->setField('sap_id')
                ->setValue($sapID)
                ->setConditionType('eq')
                ->create();

            $sapIdFilterGroup = $this->filterGroupBuilder
                ->addFilter($sapIdFilter)
                ->create();

            $entityIdFilter = $this->filterBuilder
                ->setField('entity_id')
                ->setValue($id)
                ->setConditionType('neq')
                ->create();
            $entityIdFilterGroup = $this->filterGroupBuilder
                ->addFilter($entityIdFilter)
                ->create();
            if ($id) {
                $searchCriteria = $this->searchCriteriaBuilder
                    ->setFilterGroups([$sapIdFilterGroup, $entityIdFilterGroup])
                    ->create();
                $redirectionUrl = $this->url->getUrl('company/index/edit',['id' => $id]);
            } else {
                $searchCriteria = $this->searchCriteriaBuilder
                    ->setFilterGroups([$sapIdFilterGroup])
                    ->create();
                $redirectionUrl = $this->url->getUrl('company/index/new');
            }
            $items = $this->companyRepository->getList($searchCriteria);
            if ($items->getTotalCount()) {
                $this->messageManager->addErrorMessage('SAP ID already exist');
                $this->responseFactory->create()->setRedirect($redirectionUrl)->sendResponse();
                die();
            }
        }
        return [];
    }
}

create plugin app/code/XHTMLXPERT/Company/Plugin/Magento/Company/Model/Company/DataProvider.php

<?php

declare(strict_types=1);

namespace XHTMLXPERT\Company\Plugin\Magento\Company\Model\Company;

use Magento\Company\Model\Company\DataProvider as ParentDataProvider;
use Magento\Company\Api\Data\CompanyInterface;

class DataProvider
{
    private const SAP_ID = 'sap_id';

    /**
     * @param ParentDataProvider $subject
     * @param $result
     * @return mixed
     */
    public function afterGetInformationData(
        ParentDataProvider $subject,
        $result,
        CompanyInterface $company
    ) {
        $result[self::SAP_ID] = $company->getData('sap_id');
        return $result;
    }
}

create plugin app/code/XHTMLXPERT/Company/Plugin/Magento/Company/Api/CompanyRepositoryInterface.php

<?php

declare(strict_types=1);

namespace XHTMLXPERT\Company\Plugin\Magento\Company\Api;

use Magento\Company\Model\CompanyRepository;
use Magento\Company\Api\Data\CompanyExtensionFactory;
use Magento\Company\Api\CompanyRepositoryInterface as ParentCompanyRepositoryInterface;

class CompanyRepositoryInterface
{
    /**
     * @var CompanyExtensionFactory
     */
    protected $companyExtensionFactory;

    /**
     * @var CompanyRepository
     */
    protected $companyRepository;


    public function __construct(
        CompanyRepository $companyRepository,
        CompanyExtensionFactory $companyExtensionFactory
    ) {
        $this->companyRepository = $companyRepository;
        $this->companyExtensionFactory = $companyExtensionFactory;
    }

    /**
     * @param ParentCompanyRepositoryInterface $subject
     * @param $result
     * @return mixed
     */
    public function afterGet(
        ParentCompanyRepositoryInterface $subject,
        $result
    ) {
        $company = $result;
        $extensionAttributes = $company->getExtensionAttributes();
        $companyExtension = $extensionAttributes ? $extensionAttributes : $this->companyExtensionFactory->create();
        
        $companyExtension->setSapId($company->getData('sap_id'));

        $company->setExtensionAttributes($companyExtension);
        return $company;
    }

    /**
     * @param ParentCompanyRepositoryInterface $subject
     * @param $result
     * @return mixed
     */
    public function afterSave(
        ParentCompanyRepositoryInterface $subject,
        $result
    ) {
        $company = $result;
        $extensionAttributes = $company->getExtensionAttributes();
        if (!$extensionAttributes) {
            return $company;
        }
        
        $company->setData('sap_id', $extensionAttributes->getSapId());

        $company->save();
        return $company;
    }

    /**
     * @param ParentCompanyRepositoryInterface $subject
     * @param $result
     * @return mixed
     */
    public function afterGetList(
        ParentCompanyRepositoryInterface $subject,
        $result
    ) {
        foreach ($result->getItems() as $company) {
            $this->afterGet($subject, $company);
        }
        return $result;
    }
}