Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Customer\Ui\Component\Listing;
use Magento\Customer\Ui\Component\Listing\Filter\FilterConfigProviderInterface;
use Magento\Framework\View\Element\UiComponent\ContextInterface;
use Magento\Customer\Ui\Component\ColumnFactory;
use Magento\Customer\Api\Data\AttributeMetadataInterface as AttributeMetadata;
use Magento\Framework\View\Element\UiComponentInterface;
use Magento\Customer\Ui\Component\Listing\Column\InlineEditUpdater;
use Magento\Customer\Api\CustomerMetadataInterface;
/**
* Columns component
*/
class Columns extends \Magento\Ui\Component\Listing\Columns
{
/**
* @var int
*/
protected $columnSortOrder;
/**
* @var \Magento\Customer\Ui\Component\Listing\AttributeRepository
*/
protected $attributeRepository;
/**
* @var \Magento\Customer\Ui\Component\Listing\Column\InlineEditUpdater
*/
protected $inlineEditUpdater;
/**
* @var ColumnFactory
*/
private $columnFactory;
/**
* @var array
*/
protected $filterMap = [
'default' => 'text',
'select' => 'select',
'boolean' => 'select',
'multiselect' => 'select',
'date' => 'dateRange',
];
/**
* @var FilterConfigProviderInterface[]
*/
private $filterConfigProviders;
/**
* @param ContextInterface $context
* @param ColumnFactory $columnFactory
* @param AttributeRepository $attributeRepository
* @param InlineEditUpdater $inlineEditor
* @param array $components
* @param array $data
* @param FilterConfigProviderInterface[] $filterConfigProviders
*/
public function __construct(
ContextInterface $context,
ColumnFactory $columnFactory,
AttributeRepository $attributeRepository,
InlineEditUpdater $inlineEditor,
array $components = [],
array $data = [],
array $filterConfigProviders = []
) {
parent::__construct($context, $components, $data);
$this->columnFactory = $columnFactory;
$this->attributeRepository = $attributeRepository;
$this->inlineEditUpdater = $inlineEditor;
$this->filterConfigProviders = $filterConfigProviders;
$this->updateComponentsFilters($components);
}
/**
* Return default sort order
*
* @return int
*/
protected function getDefaultSortOrder()
{
$max = 0;
foreach ($this->components as $component) {
$config = $component->getData('config');
if (isset($config['sortOrder']) && $config['sortOrder'] > $max) {
$max = $config['sortOrder'];
}
}
return ++$max;
}
/**
* Update actions column sort order
*
* @return void
*/
protected function updateActionColumnSortOrder()
{
if (isset($this->components['actions'])) {
$component = $this->components['actions'];
$component->setData(
'config',
array_merge($component->getData('config'), ['sortOrder' => ++$this->columnSortOrder])
);
}
}
/**
* @inheritdoc
*/
public function prepare()
{
$this->columnSortOrder = $this->getDefaultSortOrder();
foreach ($this->attributeRepository->getList() as $newAttributeCode => $attributeData) {
if (isset($this->components[$newAttributeCode])) {
$this->updateColumn($attributeData, $newAttributeCode);
} elseif (!$attributeData[AttributeMetadata::BACKEND_TYPE] != 'static'
&& $attributeData[AttributeMetadata::IS_USED_IN_GRID]
) {
$this->addColumn($attributeData, $newAttributeCode);
}
}
$this->updateActionColumnSortOrder();
parent::prepare();
}
/**
* Add column to the component
*
* @param array $attributeData
* @param string $columnName
* @return void
*/
public function addColumn(array $attributeData, $columnName)
{
$config['sortOrder'] = ++$this->columnSortOrder;
if ($attributeData[AttributeMetadata::IS_FILTERABLE_IN_GRID]) {
$config['filter'] = $this->getFilterConfig(
$attributeData,
$this->getFilterType($attributeData[AttributeMetadata::FRONTEND_INPUT])
);
}
$column = $this->columnFactory->create($attributeData, $columnName, $this->getContext(), $config);
$column->prepare();
$this->addComponent($attributeData[AttributeMetadata::ATTRIBUTE_CODE], $column);
}
/**
* Update column in component
*
* @param array $attributeData
* @param string $newAttributeCode
* @return void
*/
public function updateColumn(array $attributeData, $newAttributeCode)
{
$component = $this->components[$attributeData[AttributeMetadata::ATTRIBUTE_CODE]];
$this->addOptions($component, $attributeData);
if ($attributeData[AttributeMetadata::BACKEND_TYPE] != 'static') {
if ($attributeData[AttributeMetadata::IS_USED_IN_GRID]) {
$config = array_merge(
$component->getData('config'),
[
'name' => $newAttributeCode,
'dataType' => $attributeData[AttributeMetadata::BACKEND_TYPE],
'visible' => (bool)$attributeData[AttributeMetadata::IS_VISIBLE_IN_GRID]
]
);
if ($attributeData[AttributeMetadata::IS_FILTERABLE_IN_GRID]) {
$config['filter'] = $this->getFilterConfig(
$attributeData,
$this->getFilterType($attributeData[AttributeMetadata::FRONTEND_INPUT])
);
}
$component->setData('config', $config);
}
} else {
if ($attributeData['entity_type_code'] == CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER
&& !empty($component->getData('config')['editor'])
) {
$this->inlineEditUpdater->applyEditing(
$component,
$attributeData[AttributeMetadata::FRONTEND_INPUT],
$attributeData[AttributeMetadata::VALIDATION_RULES],
$attributeData[AttributeMetadata::REQUIRED]
);
}
$component->setData(
'config',
array_merge(
$component->getData('config'),
['visible' => (bool)$attributeData[AttributeMetadata::IS_VISIBLE_IN_GRID]]
)
);
}
}
/**
* Add options to component
*
* @param UiComponentInterface $component
* @param array $attributeData
* @return void
*/
public function addOptions(UiComponentInterface $component, array $attributeData)
{
$config = $component->getData('config');
if (count($attributeData[AttributeMetadata::OPTIONS]) && !isset($config[AttributeMetadata::OPTIONS])) {
$component->setData(
'config',
array_merge($config, [AttributeMetadata::OPTIONS => $attributeData[AttributeMetadata::OPTIONS]])
);
}
}
/**
* Retrieve filter type by $frontendInput
*
* @param string $frontendInput
* @return string
*/
protected function getFilterType($frontendInput)
{
return $this->filterMap[$frontendInput] ?? $this->filterMap['default'];
}
/**
* Update components filters configurations
*
* @param UiComponentInterface[] $components
* @return void
*/
private function updateComponentsFilters(array $components): void
{
$attributes = $this->attributeRepository->getList();
foreach ($components as $name => $component) {
if (isset($attributes[$name])) {
$config = $component->getData('config');
if (isset($config['filter'])) {
$filterConfig = !is_array($config['filter'])
? ['filterType' => $config['filter']]
: $config['filter'];
if (is_string($filterConfig['filterType'])) {
$filterConfig += $this->getFilterConfig(
$attributes[$name],
$filterConfig['filterType']
);
$config['filter'] = $filterConfig;
}
}
$component->setData('config', $config);
}
}
}
/**
* Returns the filter config
*
* @param array $attributeData
* @param string $filterType
* @return array
*/
private function getFilterConfig(array $attributeData, string $filterType): array
{
$filterConfig = [
'filterType' => $filterType
];
if (isset($this->filterConfigProviders[$filterType])) {
$filterConfigProvider = $this->filterConfigProviders[$filterType];
$filterConfig = array_merge($filterConfig, $filterConfigProvider->getConfig($attributeData));
}
return $filterConfig;
}
}