Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-customer/Model/ |
<?php
declare(strict_types=1);
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Customer\Model;
use Magento\Customer\Api\Data\AddressInterface;
use Magento\Customer\Api\Data\CustomerInterface;
use Magento\Customer\Model\Config\Share as ShareConfig;
use Magento\Customer\Model\ResourceModel\Address\Attribute\Source\CountryWithWebsites;
use Magento\Eav\Api\Data\AttributeInterface;
use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
use Magento\Eav\Model\Entity\Type;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\View\Element\UiComponent\ContextInterface;
use Magento\Ui\Component\Form\Field;
use Magento\Ui\DataProvider\EavValidationRules;
/**
* Class to build meta data of the customer or customer address attribute
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class AttributeMetadataResolver
{
/**
* EAV attribute properties to fetch from meta storage
* @var array
*/
private static $metaProperties = [
'dataType' => 'frontend_input',
'visible' => 'is_visible',
'required' => 'is_required',
'label' => 'frontend_label',
'sortOrder' => 'sort_order',
'notice' => 'note',
'default' => 'default_value',
'size' => 'multiline_count',
'attributeId' => 'attribute_id',
];
/**
* Form element mapping
*
* @var array
*/
private static $formElement = [
'text' => 'input',
'hidden' => 'input',
'boolean' => 'checkbox',
];
/**
* @var CountryWithWebsites
*/
private $countryWithWebsiteSource;
/**
* @var EavValidationRules
*/
private $eavValidationRules;
/**
* @var FileUploaderDataResolver
*/
private $fileUploaderDataResolver;
/**
* @var ContextInterface
*/
private $context;
/**
* @var ShareConfig
*/
private $shareConfig;
/**
* @var GroupManagement
*/
private $groupManagement;
/**
* @var AttributeWebsiteRequired|null
*/
private ?AttributeWebsiteRequired $attributeWebsiteRequired;
/**
* @param CountryWithWebsites $countryWithWebsiteSource
* @param EavValidationRules $eavValidationRules
* @param FileUploaderDataResolver $fileUploaderDataResolver
* @param ContextInterface $context
* @param ShareConfig $shareConfig
* @param GroupManagement|null $groupManagement
* @param AttributeWebsiteRequired|null $attributeWebsiteRequired
*/
public function __construct(
CountryWithWebsites $countryWithWebsiteSource,
EavValidationRules $eavValidationRules,
FileUploaderDataResolver $fileUploaderDataResolver,
ContextInterface $context,
ShareConfig $shareConfig,
?GroupManagement $groupManagement = null,
?AttributeWebsiteRequired $attributeWebsiteRequired = null
) {
$this->countryWithWebsiteSource = $countryWithWebsiteSource;
$this->eavValidationRules = $eavValidationRules;
$this->fileUploaderDataResolver = $fileUploaderDataResolver;
$this->context = $context;
$this->shareConfig = $shareConfig;
$this->groupManagement = $groupManagement ?? ObjectManager::getInstance()->get(GroupManagement::class);
$this->attributeWebsiteRequired = $attributeWebsiteRequired ??
ObjectManager::getInstance()->get(AttributeWebsiteRequired::class);
}
/**
* Get meta data of the customer or customer address attribute
*
* @param AbstractAttribute $attribute
* @param Type $entityType
* @param bool $allowToShowHiddenAttributes
* @return array
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function getAttributesMeta(
AbstractAttribute $attribute,
Type $entityType,
bool $allowToShowHiddenAttributes
): array {
$meta = $this->modifyBooleanAttributeMeta($attribute);
$this->modifyGroupAttributeMeta($attribute);
// use getDataUsingMethod, since some getters are defined and apply additional processing of returning value
foreach (self::$metaProperties as $metaName => $origName) {
$value = $attribute->getDataUsingMethod($origName);
if ($metaName === 'label') {
$meta['arguments']['data']['config'][$metaName] = __($value);
$meta['arguments']['data']['config']['__disableTmpl'] = [$metaName => true];
} else {
$meta['arguments']['data']['config'][$metaName] = $value;
}
if ('frontend_input' === $origName) {
$meta['arguments']['data']['config']['formElement'] = self::$formElement[$value] ?? $value;
}
}
if ($attribute->usesSource()) {
if ($attribute->getAttributeCode() === AddressInterface::COUNTRY_ID) {
$meta['arguments']['data']['config']['options'] = $this->countryWithWebsiteSource
->getAllOptions();
} else {
$options = $attribute->getSource()->getAllOptions();
array_walk(
$options,
function (&$item) {
$item['__disableTmpl'] = ['label' => true];
}
);
$meta['arguments']['data']['config']['options'] = $options;
}
}
$rules = $this->eavValidationRules->build($attribute, $meta['arguments']['data']['config']);
if (!empty($rules)) {
$meta['arguments']['data']['config']['validation'] = $rules;
}
$meta['arguments']['data']['config']['componentType'] = Field::NAME;
$meta['arguments']['data']['config']['visible'] = $this->canShowAttribute(
$attribute,
$allowToShowHiddenAttributes
);
$this->fileUploaderDataResolver->overrideFileUploaderMetadata(
$entityType,
$attribute,
$meta['arguments']['data']['config']
);
return $meta;
}
/**
* Detect can we show attribute on specific form or not
*
* @param AbstractAttribute $customerAttribute
* @param bool $allowToShowHiddenAttributes
* @return bool
*/
private function canShowAttribute(
AbstractAttribute $customerAttribute,
bool $allowToShowHiddenAttributes
) {
return $allowToShowHiddenAttributes && (bool) $customerAttribute->getIsUserDefined()
? true
: (bool) $customerAttribute->getIsVisible();
}
/**
* Modify boolean attribute meta data
*
* @param AttributeInterface $attribute
* @return array
*/
private function modifyBooleanAttributeMeta(AttributeInterface $attribute): array
{
$meta = [];
if ($attribute->getFrontendInput() === 'boolean') {
$meta['arguments']['data']['config']['prefer'] = 'toggle';
$meta['arguments']['data']['config']['valueMap'] = [
'true' => '1',
'false' => '0',
];
}
return $meta;
}
/**
* Modify group attribute meta data
*
* @param AttributeInterface $attribute
* @return void
*/
private function modifyGroupAttributeMeta(AttributeInterface $attribute): void
{
if ($attribute->getAttributeCode() === 'group_id') {
$defaultGroup = $this->groupManagement->getDefaultGroup();
$defaultGroupId = $defaultGroup->getId();
$attribute->setDataUsingMethod(self::$metaProperties['default'], $defaultGroupId);
}
}
/**
* Add global scope parameter and filter options to website meta
*
* @param array $meta
* @return void
*/
public function processWebsiteMeta(&$meta): void
{
if (isset($meta[CustomerInterface::WEBSITE_ID]) && $this->shareConfig->isGlobalScope()) {
$meta[CustomerInterface::WEBSITE_ID]['arguments']['data']['config']['isGlobalScope'] = 1;
}
if (isset($meta[AddressInterface::COUNTRY_ID]) && !$this->shareConfig->isGlobalScope()) {
$meta[AddressInterface::COUNTRY_ID]['arguments']['data']['config']['filterBy'] = [
'target' => 'customer_form.customer_form_data_source:data.customer.website_id',
'field' => 'website_ids'
];
}
if (isset($meta[CustomerInterface::WEBSITE_ID])) {
$this->processWebsiteIsRequired($meta);
}
}
/**
* Adds attribute 'required' validation according to the scope.
*
* @param array $meta
* @return void
*/
private function processWebsiteIsRequired(&$meta): void
{
$attributeIds = array_values(
array_map(
function ($attribute) {
return $attribute['arguments']['data']['config']['attributeId'];
},
array_filter(
$meta,
function ($attribute) {
return isset($attribute['arguments']['data']['config']['attributeId']);
}
)
)
);
$websiteIds = array_values(
array_map(
function ($option) {
return (int)$option['value'];
},
$meta[CustomerInterface::WEBSITE_ID]['arguments']['data']['config']['options']
)
);
$websiteRequired = $this->attributeWebsiteRequired->get($attributeIds, $websiteIds);
array_walk(
$meta,
function (&$attribute) use ($websiteRequired) {
$id = $attribute['arguments']['data']['config']['attributeId'];
unset($attribute['arguments']['data']['config']['attributeId']);
if (!empty($websiteRequired[$id])) {
$attribute['arguments']['data']['config']
['validation']['required-entry-website'] = $websiteRequired[$id];
}
}
);
}
}