Magento2 - программно добавить параметры атрибута продукта

32

Как правильно (официальный) способ программно добавить атрибут продукта в M2? Например, для manufacturerатрибута продукта. Очевидно, существующая опция будет соответствовать значению заголовка «Admin».

ВЕРД
источник

Ответы:

55

Вот подход, который я придумал для обработки параметров атрибута. Хелпер класс:

<?php
namespace My\Module\Helper;

class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
    /**
     * @var \Magento\Catalog\Api\ProductAttributeRepositoryInterface
     */
    protected $attributeRepository;

    /**
     * @var array
     */
    protected $attributeValues;

    /**
     * @var \Magento\Eav\Model\Entity\Attribute\Source\TableFactory
     */
    protected $tableFactory;

    /**
     * @var \Magento\Eav\Api\AttributeOptionManagementInterface
     */
    protected $attributeOptionManagement;

    /**
     * @var \Magento\Eav\Api\Data\AttributeOptionLabelInterfaceFactory
     */
    protected $optionLabelFactory;

    /**
     * @var \Magento\Eav\Api\Data\AttributeOptionInterfaceFactory
     */
    protected $optionFactory;

    /**
     * Data constructor.
     *
     * @param \Magento\Framework\App\Helper\Context $context
     * @param \Magento\Catalog\Api\ProductAttributeRepositoryInterface $attributeRepository
     * @param \Magento\Eav\Model\Entity\Attribute\Source\TableFactory $tableFactory
     * @param \Magento\Eav\Api\AttributeOptionManagementInterface $attributeOptionManagement
     * @param \Magento\Eav\Api\Data\AttributeOptionLabelInterfaceFactory $optionLabelFactory
     * @param \Magento\Eav\Api\Data\AttributeOptionInterfaceFactory $optionFactory
     */
    public function __construct(
        \Magento\Framework\App\Helper\Context $context,
        \Magento\Catalog\Api\ProductAttributeRepositoryInterface $attributeRepository,
        \Magento\Eav\Model\Entity\Attribute\Source\TableFactory $tableFactory,
        \Magento\Eav\Api\AttributeOptionManagementInterface $attributeOptionManagement,
        \Magento\Eav\Api\Data\AttributeOptionLabelInterfaceFactory $optionLabelFactory,
        \Magento\Eav\Api\Data\AttributeOptionInterfaceFactory $optionFactory
    ) {
        parent::__construct($context);

        $this->attributeRepository = $attributeRepository;
        $this->tableFactory = $tableFactory;
        $this->attributeOptionManagement = $attributeOptionManagement;
        $this->optionLabelFactory = $optionLabelFactory;
        $this->optionFactory = $optionFactory;
    }

    /**
     * Get attribute by code.
     *
     * @param string $attributeCode
     * @return \Magento\Catalog\Api\Data\ProductAttributeInterface
     */
    public function getAttribute($attributeCode)
    {
        return $this->attributeRepository->get($attributeCode);
    }

    /**
     * Find or create a matching attribute option
     *
     * @param string $attributeCode Attribute the option should exist in
     * @param string $label Label to find or add
     * @return int
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function createOrGetId($attributeCode, $label)
    {
        if (strlen($label) < 1) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Label for %1 must not be empty.', $attributeCode)
            );
        }

        // Does it already exist?
        $optionId = $this->getOptionId($attributeCode, $label);

        if (!$optionId) {
            // If no, add it.

            /** @var \Magento\Eav\Model\Entity\Attribute\OptionLabel $optionLabel */
            $optionLabel = $this->optionLabelFactory->create();
            $optionLabel->setStoreId(0);
            $optionLabel->setLabel($label);

            $option = $this->optionFactory->create();
            $option->setLabel($optionLabel);
            $option->setStoreLabels([$optionLabel]);
            $option->setSortOrder(0);
            $option->setIsDefault(false);

            $this->attributeOptionManagement->add(
                \Magento\Catalog\Model\Product::ENTITY,
                $this->getAttribute($attributeCode)->getAttributeId(),
                $option
            );

            // Get the inserted ID. Should be returned from the installer, but it isn't.
            $optionId = $this->getOptionId($attributeCode, $label, true);
        }

        return $optionId;
    }

    /**
     * Find the ID of an option matching $label, if any.
     *
     * @param string $attributeCode Attribute code
     * @param string $label Label to find
     * @param bool $force If true, will fetch the options even if they're already cached.
     * @return int|false
     */
    public function getOptionId($attributeCode, $label, $force = false)
    {
        /** @var \Magento\Catalog\Model\ResourceModel\Eav\Attribute $attribute */
        $attribute = $this->getAttribute($attributeCode);

        // Build option array if necessary
        if ($force === true || !isset($this->attributeValues[ $attribute->getAttributeId() ])) {
            $this->attributeValues[ $attribute->getAttributeId() ] = [];

            // We have to generate a new sourceModel instance each time through to prevent it from
            // referencing its _options cache. No other way to get it to pick up newly-added values.

            /** @var \Magento\Eav\Model\Entity\Attribute\Source\Table $sourceModel */
            $sourceModel = $this->tableFactory->create();
            $sourceModel->setAttribute($attribute);

            foreach ($sourceModel->getAllOptions() as $option) {
                $this->attributeValues[ $attribute->getAttributeId() ][ $option['label'] ] = $option['value'];
            }
        }

        // Return option ID if exists
        if (isset($this->attributeValues[ $attribute->getAttributeId() ][ $label ])) {
            return $this->attributeValues[ $attribute->getAttributeId() ][ $label ];
        }

        // Return false if does not exist
        return false;
    }
}

Затем, либо в том же классе, либо включив его через внедрение зависимостей, вы можете добавить или получить свой идентификатор опции с помощью вызова createOrGetId($attributeCode, $label).

Например, если вы вводите My\Module\Helper\Dataкак $this->moduleHelper, то вы можете позвонить:

$manufacturerId = $this->moduleHelper->createOrGetId('manufacturer', 'ABC Corp');

Если «ABC Corp» является существующим производителем, он получит идентификатор. Если нет, он добавит его.

ОБНОВЛЕНО 2016-09-09: Per Ruud N., оригинальное решение использовало CatalogSetup, что привело к ошибке, начинающейся в Magento 2.1. Это пересмотренное решение обходит эту модель, создавая опцию и явно помечая. Должно работать на 2.0+.

Райан Херр
источник
3
Это так официально, как вы собираетесь получить. Все поиски и добавление опций проходят через ядро ​​Magento. Мой класс - это просто оболочка для тех основных методов, которая облегчает их использование.
Райан Херр
1
Привет, Райан, тебе не следует устанавливать значение для параметра, это внутренний идентификатор, который использует magento, и я обнаружил, что если установить значение в строковое значение с ведущим числом, таким как «123 abc corp», это вызовет некоторые серьезные проблемы из-за реализации Magento\Eav\Model\ResourceModel\Entity\Attribute::_processAttributeOptions. Убедитесь сами: если вы удалите $option->setValue($label);оператор из своего кода, он сохранит параметр, а затем, когда вы его получите, Magento вернет значение из eav_attribute_optionтаблицы с автоматическим приращением .
quickshiftin
2
если я добавлю это в функцию foreach, во второй итерации я получу сообщение об ошибке «Magento \ Eav \ Model \ Entity \ Attribute \ OptionManagement :: setOptionValue () должен иметь тип строки, заданный объект»
JELLEJ
1
Да, этот код не работает
Сурав
2
@JELLEJ Если вы получаете проблему Uncaught TypeError: Аргумент 3 передается в Magento \ Eav \ Model \ Entity \ Attribute \ OptionManagement :: setOptionValue () должен быть строки типа, объект, указанный в функции foreach, затем изменить $ option-> setLabel ( $ optionLabel); $ option-> setLabel ($ label); на линии 102
Nadeem0035
11

проверено на Magento 2.1.3.

Я не нашел работоспособного способа создать атрибут с опциями сразу. Поэтому сначала нам нужно создать атрибут, а затем добавить параметры для него.

Вставьте следующий класс \ Magento \ Eav \ Setup \ EavSetupFactory

 $setup->startSetup();

 /** @var \Magento\Eav\Setup\EavSetup $eavSetup */
 $eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);

Создать новый атрибут:

$eavSetup->addAttribute(
    'catalog_product',
    $attributeCode,
    [
        'type' => 'varchar',
        'input' => 'select',
        'required' => false,
        ...
    ],
);

Добавить пользовательские параметры.

Функция addAttributeне возвращает ничего полезного, что может быть использовано в будущем. Таким образом, после создания атрибута нам нужно самостоятельно извлечь объект атрибута. !!! Важно Нам это нужно, потому что функция ожидает только attribute_id, но не хочет работать attribute_code.

В этом случае нам нужно получить attribute_idи передать его в функцию создания атрибутов.

$attributeId = $eavSetup->getAttributeId('catalog_product', 'attribute_code');

Затем нам нужно сгенерировать массив параметров так, как ожидает magento:

$options = [
        'values' => [
        'sort_order1' => 'title1',
        'sort_order2' => 'title2',
        'sort_order3' => 'title3',
    ],
    'attribute_id' => 'some_id',
];

Как пример:

$options = [
        'values' => [
        '1' => 'Red',
        '2' => 'Yellow',
        '3' => 'Green',
    ],
    'attribute_id' => '32',
];

И передать его функции:

$eavSetup->addAttributeOption($options);
zhartaunik
источник
3-й параметр addAttribute может принимать параметр массива ['option']
DWils
10

Использование Magento \ Eav \ Setup \ EavSetupFactory или даже класса \ Magento \ Catalog \ Setup \ CategorySetupFactory может привести к следующей проблеме: https://github.com/magento/magento2/issues/4896 .

Классы, которые вы должны использовать:

protected $_logger;

protected $_attributeRepository;

protected $_attributeOptionManagement;

protected $_option;

protected $_attributeOptionLabel;

 public function __construct(
    \Psr\Log\LoggerInterface $logger,
    \Magento\Eav\Model\AttributeRepository $attributeRepository,
    \Magento\Eav\Api\AttributeOptionManagementInterface $attributeOptionManagement,
    \Magento\Eav\Api\Data\AttributeOptionLabelInterface $attributeOptionLabel,
    \Magento\Eav\Model\Entity\Attribute\Option $option
  ){
    $this->_logger = $logger;
    $this->_attributeRepository = $attributeRepository;
    $this->_attributeOptionManagement = $attributeOptionManagement;
    $this->_option = $option;
    $this->_attributeOptionLabel = $attributeOptionLabel;
 }

Затем в вашей функции сделайте что-то вроде этого:

 $attribute_id = $this->_attributeRepository->get('catalog_product', 'your_attribute')->getAttributeId();
$options = $this->_attributeOptionManagement->getItems('catalog_product', $attribute_id);
/* if attribute option already exists, remove it */
foreach($options as $option) {
  if ($option->getLabel() == $oldname) {
    $this->_attributeOptionManagement->delete('catalog_product', $attribute_id, $option->getValue());
  }
}

/* new attribute option */
  $this->_option->setValue($name);
  $this->_attributeOptionLabel->setStoreId(0);
  $this->_attributeOptionLabel->setLabel($name);
  $this->_option->setLabel($this->_attributeOptionLabel);
  $this->_option->setStoreLabels([$this->_attributeOptionLabel]);
  $this->_option->setSortOrder(0);
  $this->_option->setIsDefault(false);
  $this->_attributeOptionManagement->add('catalog_product', $attribute_id, $this->_option);
Рууд Н.
источник
1
Спасибо, вы правы. Я обновил свой ответ соответственно. Обратите внимание, что $attributeOptionLabelи $optionявляются классами ORM; Вы не должны вводить их напрямую. Правильный подход состоит в том, чтобы внедрить их фабричный класс, а затем создать экземпляр по мере необходимости. Также обратите внимание, что вы не используете интерфейсы данных API постоянно.
Райан Херр
3
Привет @Rudd, см. Мой комментарий к ответу Райана. Вы не хотите звонить, $option->setValue()поскольку это для внутреннего option_idполя magento на eav_attribute_optionстоле.
quickshiftin
Спасибо. Об этом я тоже узнал. Отредактирую мой ответ соответственно.
Рууд Н.
0

Для Magento 2.3.3 я обнаружил, что вы можете использовать подход Magento DevTeam.

  • Добавить патч
bin/magento setup:db-declaration:generate-patch Vendor_Module PatchName
  • Добавить CategorySetupFactory в конструктор
public function __construct(
        ModuleDataSetupInterface $moduleDataSetup,
        Factory $configFactory
        CategorySetupFactory $categorySetupFactory
    ) {
        $this->moduleDataSetup = $moduleDataSetup;
        $this->configFactory = $configFactory;
        $this->categorySetupFactory = $categorySetupFactory;
}
  • Добавить атрибут в функцию apply ()

    public function apply()
    {
        $categorySetup = $this->categorySetupFactory->create(['setup' => $this->moduleDataSetup]);
    
        $categorySetup->addAttribute(
            \Magento\Catalog\Model\Product::ENTITY,
            'custom_layout',
            [
                'type' => 'varchar',
                'label' => 'New Layout',
                'input' => 'select',
                'source' => \Magento\Catalog\Model\Product\Attribute\Source\Layout::class,
                'required' => false,
                'sort_order' => 50,
                'global' => \Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface::SCOPE_STORE,
                'group' => 'Schedule Design Update',
                'is_used_in_grid' => true,
                'is_visible_in_grid' => false,
                'is_filterable_in_grid' => false
            ]
        );
    }
    
embed0
источник
хм, я просто узнаю, что я хотел добавить этот ответ к другому вопросу. Я просто буду жить здесь и добавить ссылку на этот ответ там. Я надеюсь, что это нормально. Это частичный ответ и на этот вопрос :)
embed0
-4

Это НЕ ответ. Просто обходной путь.

Предполагается, что у вас есть доступ к Magento Backend с помощью браузера, и вы находитесь на странице редактирования атрибута (URL выглядит как admin / catalog / product_attribute / edit / attribute_id / XXX / key ..)

Перейдите в консоль браузера (CTRL + SHIFT + J на ​​Chrome) и вставьте следующий код после изменения mimim массива .

$jq=new jQuery.noConflict();
var mimim=["xxx","yyy","VALUES TO BE ADDED"];
$jq.each(mimim,function(a,b){
$jq("#add_new_option_button").click();
$jq("#manage-options-panel tbody tr:last-child td:nth-child(3) input").val(b);
});

- проверено на Magento 2.2.2

Подробная статья - https://tutes.in/how-to-manage-magento-2-product-attribute-values-options-using-console/

th3pirat3
источник
1
Это ужасное долгосрочное решение. Вы не можете с уверенностью ожидать, что эти селекторы останутся прежними. В лучшем случае это обходной путь, если он действительно работает, как ожидалось.
Домдамброджа
@domdambrogia согласен. Это обходной путь.
th3pirat3