Mrthdrb

I have some problem to save custom customer entity attribute in database.

I've created a Patch to add this attribute to the customer entity. The attribute is shown correctly in the backend, but when I try to save it, the value doesn't save in the database.

My code is the following:

<?php
declare(strict_types=1);

namespace PedReferralSetupPatchData;

use MagentoCustomerModelCustomer;
use MagentoCustomerSetupCustomerSetupFactory;
use MagentoEavApiAttributeRepositoryInterface;
use MagentoEavModelEntityAttributeSetFactory as AttributeSetFactory;
use MagentoFrameworkSetupModuleDataSetupInterface;
use MagentoFrameworkSetupPatchDataPatchInterface;
use MagentoEavSetupEavSetupFactory;

class AddCustomerReferralCodeAttribute implements DataPatchInterface
void
 * @throws MagentoFrameworkExceptionLocalizedException
 * @throws MagentoFrameworkExceptionStateException
 */
 public function apply()
 
 $this->removeReferralCodeAttribute();
 $this->addReferralCodeAttribute();
 

 /**
 * Remove referral_code customer attribute
 */
 private function removeReferralCodeAttribute()
 
 $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
 $eavSetup->removeAttribute(Customer::ENTITY, 'referral_code');
 

 /**
 * Add referral_code customer attribute
 * @throws MagentoFrameworkExceptionLocalizedException
 * @throws MagentoFrameworkExceptionStateException
 */
 private function addReferralCodeAttribute()
 
 $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);

 $customerEntity = $customerSetup->getEavConfig()->getEntityType('customer');
 $attributeSetId = $customerEntity->getDefaultAttributeSetId();

 $attributeSet = $this->attributeSetFactory->create();
 $attributeGroupId = $attributeSet->getDefaultGroupId($attributeSetId);

 $customerSetup->addAttribute(
 Customer::ENTITY,
 'referral_code',
 [
 'type' => 'varchar',
 'label' => 'Referral Code',
 'input' => 'text',
 'required' => false,
 'sort_order' => 999,
 'position' => 999,
 'visible' => true,
 'default' => '',
 'user_defined' => true,
 'system' => 0,
 'unique' => true,
 ]
 );

 $referralCodeAttribute = $customerSetup->getEavConfig()
 ->getAttribute(Customer::ENTITY, 'referral_code')
 ->addData([
 'attribute_set_id' => $attributeSetId,
 'attribute_group_id' => $attributeGroupId,
 'used_in_forms' => ['adminhtml_customer'],
 ]);

 $this->attributeRepository->save($referralCodeAttribute);
 

If I replace $this->attributeRepository->save($referralCodeAttribute); with $referralCodeAttribute->save() all works properly, but I don't want to use the save() method of attribute entity, because is deprecated.

I know that now I should use the resource model/api interface to save attribute, but in both cases, the attribute is showing on the admin panel, but when I try to save, it doesn't work. Why?

How can I use the resource model/api interface correctly to save the custom attribute?

Try this one using MagentoEavApiAttributeSetRepositoryInterface:

<?php
/*declare(strict_types=1);*/

namespace PedReferralSetupPatchData;

use MagentoCustomerModelCustomer;
use MagentoCustomerSetupCustomerSetupFactory;
use MagentoEavApiAttributeRepositoryInterface;
use MagentoEavModelEntityAttributeSetFactory as AttributeSetFactory;
use MagentoFrameworkSetupModuleDataSetupInterface;
use MagentoFrameworkSetupPatchDataPatchInterface;
use MagentoEavSetupEavSetupFactory;
//add this AttributeSetRepositoryInterface
use MagentoEavApiAttributeSetRepositoryInterface;

class AddCustomerReferralCodeAttribute implements DataPatchInterface
void
 * @throws MagentoFrameworkExceptionLocalizedException
 * @throws MagentoFrameworkExceptionStateException
 */
 public function apply()
 
 $this->removeReferralCodeAttribute();
 $this->addReferralCodeAttribute();
 

 /**
 * Remove referral_code customer attribute
 */
 private function removeReferralCodeAttribute()
 
 $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
 $eavSetup->removeAttribute(Customer::ENTITY, 'referral_code');
 

 /**
 * @throws MagentoFrameworkExceptionInputException
 * @throws MagentoFrameworkExceptionLocalizedException
 * @throws MagentoFrameworkExceptionNoSuchEntityException
 */
 private function addReferralCodeAttribute()
 
 $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);

 $customerEntity = $customerSetup->getEavConfig()->getEntityType('customer');
 $attributeSetId = $customerEntity->getDefaultAttributeSetId();

 $attributeSet = $this->attributeSetFactory->create();
 $attributeGroupId = $attributeSet->getDefaultGroupId($attributeSetId);

 $customerSetup->addAttribute(
 Customer::ENTITY,
 'referral_code',
 [
 'type' => 'varchar',
 'label' => 'Referral Code',
 'input' => 'text',
 'required' => false,
 'sort_order' => 999,
 'position' => 999,
 'visible' => true,
 'default' => '',
 'user_defined' => true,
 'system' => 0,
 'unique' => true,
 ]
 );

 $referralCodeAttribute = $customerSetup->getEavConfig()
 ->getAttribute(Customer::ENTITY, 'referral_code')
 ->addData([
 'attribute_set_id' => $attributeSetId,
 'attribute_group_id' => $attributeGroupId,
 'used_in_forms' => ['adminhtml_customer'],
 ]);

 //$this->attributeRepository->save($referralCodeAttribute);
 $this->attribute->save($referralCodeAttribute);
 

I found the solution by dump the ResourceModel classname used by the save() method that was deprecated in favor of service contract. The resource model that I should used is MagentoCustomerModelResourceModelAttribute. Here the complete code:

<?php 
namespace PedReferralSetupPatchData;

use MagentoCustomerModelCustomer;
use MagentoCustomerModelResourceModelAttribute as AttributeResourceModel;
use MagentoCustomerSetupCustomerSetupFactory;
use MagentoEavModelEntityAttributeSetFactory as AttributeSetFactory;
use MagentoEavSetupEavSetupFactory;
use MagentoFrameworkSetupModuleDataSetupInterface;
use MagentoFrameworkSetupPatchDataPatchInterface;

class AddCustomerReferralCodeAttribute implements DataPatchInterface

 private const REFERRAL_CODE_FIELD_NAME = 'referral_code';

 /**
 * @var ModuleDataSetupInterface
 */
 private $moduleDataSetup;

 /**
 * @var CustomerSetupFactory
 */
 private $customerSetupFactory;

 /**
 * @var AttributeSetFactory
 */
 private $attributeSetFactory;

 /**
 * @var EavSetupFactory
 */
 private $eavSetupFactory;

 /**
 * @var AttributeResourceModel
 */
 private $attributeResourceModel;

 public function __construct(
 ModuleDataSetupInterface $moduleDataSetup,
 CustomerSetupFactory $customerSetupFactory,
 AttributeSetFactory $attributeSetFactory,
 EavSetupFactory $eavSetupFactory,
 AttributeResourceModel $attributeResourceModel
 ) 
 $this->moduleDataSetup = $moduleDataSetup;
 $this->customerSetupFactory = $customerSetupFactory;
 $this->attributeSetFactory = $attributeSetFactory;
 $this->eavSetupFactory = $eavSetupFactory;
 $this->attributeResourceModel = $attributeResourceModel;
 

 /**
 * @inheritdoc
 */
 public static function getDependencies()
 
 return [];
 

 /**
 * @inheritdoc
 */
 public function getAliases()
 
 return [];
 

 /**
 * @inheritdoc
 * @throws MagentoFrameworkExceptionLocalizedException
 */
 public function apply()
 
 $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);

 $customerEntity = $customerSetup->getEavConfig()->getEntityType(Customer::ENTITY);
 $attributeSetId = $customerEntity->getDefaultAttributeSetId();

 $attributeSet = $this->attributeSetFactory->create();
 $attributeGroupId = $attributeSet->getDefaultGroupId($attributeSetId);

 $customerSetup->addAttribute(
 Customer::ENTITY,
 static::REFERRAL_CODE_FIELD_NAME,
 [
 'type' => 'varchar',
 'label' => 'Referral Code',
 'input' => 'text',
 'required' => false,
 'sort_order' => 999,
 'position' => 999,
 'visible' => true,
 'default' => '',
 'user_defined' => true,
 'system' => 0,
 'unique' => true,
 ]
 );

 $referralCodeAttribute = $customerSetup->getEavConfig()
 ->getAttribute(Customer::ENTITY, static::REFERRAL_CODE_FIELD_NAME)
 ->addData([
 'attribute_set_id' => $attributeSetId,
 'attribute_group_id' => $attributeGroupId,
 'used_in_forms' => ['adminhtml_customer'],
 ]);

 $this->attributeResourceModel->save($referralCodeAttribute);