Magento2 - programowo dodaj opcje atrybutów produktu

32

Jaki jest właściwy (oficjalny) sposób na programowe dodanie opcji atrybutu produktu w M2? Np. Dla manufactureratrybutu produktu. Oczywiście istniejącej opcji towarzyszyłaby wartość tytułu „Administrator”.

werd
źródło

Odpowiedzi:

55

Oto zaproponowane przeze mnie podejście do obsługi opcji atrybutów. Klasa pomocnicza:

<?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;
    }
}

Następnie, w tej samej klasie lub włączając ją poprzez wstrzyknięcie zależności, możesz dodać lub uzyskać identyfikator opcji, dzwoniąc createOrGetId($attributeCode, $label).

Na przykład, jeśli wstrzykniesz My\Module\Helper\Datajako $this->moduleHelper, możesz zadzwonić:

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

Jeśli „ABC Corp” jest istniejącym producentem, pobierze identyfikator. Jeśli nie, doda to.

ZAKTUALIZOWANO 09.09.2016: Per Ruud N., oryginalne rozwiązanie wykorzystało CatalogSetup, co spowodowało błąd w Magento 2.1. To zmienione rozwiązanie omija ten model, tworząc wyraźnie opcję i etykietę. Powinno działać na wersji 2.0+.

Ryan Hoerr
źródło
3
To jest tak oficjalne, jak to tylko możliwe. Wszystkie wyszukiwania i dodawanie opcji przechodzą przez rdzeń Magento. Moja klasa to tylko opakowanie dla tych podstawowych metod, które ułatwiają ich użycie.
Ryan Hoerr
1
Cześć Ryan, nie powinieneś ustawiać wartości dla tej opcji, jest to wewnętrzny identyfikator używany przez magento i dowiedziałem się na własnej skórze, że jeśli ustawisz wartość na wartość ciągu z wiodącą liczbą, taką jak „123 abc corp”, spowoduje to poważne problemy związane z wdrożeniem Magento\Eav\Model\ResourceModel\Entity\Attribute::_processAttributeOptions. Przekonaj się, jeśli usuniesz $option->setValue($label);instrukcję ze swojego kodu, zapisze ona opcję, a następnie po jej pobraniu Magento zwróci wartość z automatycznego przyrostu na eav_attribute_optionstole.
szybka zmiana
2
jeśli dodam to w funkcji foreach, w drugiej iteracji otrzymam błąd „Magento \ Eav \ Model \ Entity \ Attribute \ OptionManagement :: setOptionValue () musi być typu ciąg, obiekt podany”
JELLEJ
1
Tak, ten kod nie działa
Sourav
2
@JELLEJ Jeśli pojawia się problem Uncaught TypeError: Argument 3 przekazany do Magento \ Eav \ Model \ Entity \ Attribute \ OptionManagement :: setOptionValue () musi być typu ciąg, obiekt podany w funkcji foreach, a następnie zmień $ option-> setLabel ( $ optionLabel); na $ opcja-> setLabel (etykieta $); na linii 102
Nadeem0035
11

testowane na Magento 2.1.3.

Nie znalazłem żadnego praktycznego sposobu, jak utworzyć atrybut z opcjami jednocześnie. Tak więc początkowo musimy utworzyć atrybut, a następnie dodać dla niego opcje.

Wstrzyknąć następującą klasę \ Magento \ Eav \ Setup \ EavSetupFactory

 $setup->startSetup();

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

Utwórz nowy atrybut:

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

Dodaj niestandardowe opcje.

Funkcja addAttributenie zwraca niczego przydatnego, z czego można by skorzystać w przyszłości. Po utworzeniu atrybutu musimy sami pobrać obiekt atrybutu. !!! Ważne Potrzebujemy tego, ponieważ funkcja oczekuje tylko attribute_id, ale nie chce z nią pracowaćattribute_code .

W takim przypadku musimy go pobrać attribute_idi przekazać do funkcji tworzenia atrybutów.

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

Następnie musimy wygenerować tablicę opcji zgodnie z oczekiwaniami magento:

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

Jako przykład:

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

I przekaż to do funkcji:

$eavSetup->addAttributeOption($options);
zhartaunik
źródło
Trzeci parametr addAttribute może przyjąć parametr tablicy [„opcja”]
DWils,
10

Korzystanie z Magento \ Eav \ Setup \ EavSetupFactory lub nawet z \ Magento \ Catalog \ Setup \ CategorySetupFactory może prowadzić do następującego problemu: https://github.com/magento/magento2/issues/4896 .

Klasy, których powinieneś użyć:

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;
 }

Następnie w swojej funkcji wykonaj coś takiego:

 $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);
Ruud N.
źródło
1
Dzięki, masz rację. Zaktualizowałem odpowiednio swoją odpowiedź. Zauważ, że $attributeOptionLabeli $optionsą to klasy ORM; nie należy ich wstrzykiwać bezpośrednio. Właściwym podejściem jest wstrzyknięcie klasy fabrycznej, a następnie utworzenie instancji w razie potrzeby. Pamiętaj też, że nie korzystasz konsekwentnie z interfejsów danych API.
Ryan Hoerr
3
Cześć @ Rudd, zobacz mój komentarz do odpowiedzi Ryana. Nie chcesz dzwonić, $option->setValue()ponieważ dotyczy to wewnętrznego option_idpola magento na eav_attribute_optionstole.
szybka zmiana
Dziękuję Ci. Tego też się dowiedziałem. Odpowiednio zmodyfikuje moją odpowiedź.
Ruud N.
0

W przypadku Magento 2.3.3 odkryłem, że możesz zastosować podejście Magento DevTeam.

  • Dodaj łatkę
bin/magento setup:db-declaration:generate-patch Vendor_Module PatchName
  • Dodaj CategorySetupFactory do konstruktora
public function __construct(
        ModuleDataSetupInterface $moduleDataSetup,
        Factory $configFactory
        CategorySetupFactory $categorySetupFactory
    ) {
        $this->moduleDataSetup = $moduleDataSetup;
        $this->configFactory = $configFactory;
        $this->categorySetupFactory = $categorySetupFactory;
}
  • Dodaj atrybut w funkcji 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
źródło
Uhmm, właśnie się dowiedziałem, że chciałem dodać tę odpowiedź do innego pytania. Po prostu go tu przeżyję i dodam tam odniesienie do tej odpowiedzi. Mam nadzieję, że jest ok. To jest również częściowa odpowiedź na to pytanie :)
em00
-4

To NIE jest odpowiedź. Tylko obejście.

Zakłada się, że masz dostęp do Magento Backend za pomocą przeglądarki i jesteś na stronie atrybutu edycji (adres URL wygląda jak admin / catalog / product_attribute / edit / attribute_id / XXX / key ..)

Przejdź do konsoli przeglądarki (CTRL + SHIFT + J na chrome) i wklej następujący kod po zmianie mimim tablicy .

$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);
});

- testowane na Magento 2.2.2

Szczegółowy artykuł - https://tutes.in/how-to-manage-magento-2-product-attribute-values-options-using-console/

th3pirat3
źródło
1
To okropne długoterminowe rozwiązanie. Nie można niezawodnie oczekiwać, że te selektory pozostaną takie same. Jest to w najlepszym razie obejście, jeśli faktycznie działa zgodnie z oczekiwaniami.
domdambrogia
@domdambrogia się zgadza. Jest to obejście.
th3pirat3