Magento 2 Jak dodać nową kolumnę do siatki zamówień


20

Dodałem nową kolumnę do tabeli o sales_ordernazwie export_status, teraz chcę dodać nową kolumnę siatki zamówień z danymi z nowej sales_orderkolumny.

Udało mi się dodać kolumnę do the sales_order_gridtabeli.

$installer->getConnection()->addColumn($installer->getTable("sales_order_grid"), "xml_exported", [
     'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
     'comment' => 'XML Exported'
]);

Jak mogę teraz sprawić, by faktycznie wyświetlał się w siatce zamówień z wartością z sales_order export_statuskolumny?



Myślę, że jest lepszy sposób na zrobienie tego bez konieczności wdrażania obserwatora i używania zdarzeń.
André Ferraz,

W tym artykule opisano krok po kroku dodawanie kolumny do siatki zamówień sprzedaży: sivaschenko.com/magento2/2016/03/05/…
Sergii Ivashchenko

Wypróbuj rozwiązanie tutaj Ta metoda używa wtyczki do dodawania kolumn.
Asrar

Myślę, że powinieneś to sprawdzić: dobry tutorial sivaschenko.com/magento2-sales-order-grid-column
Abid Malik

Odpowiedzi:


42

Po wielu kopaniach w rdzennym kodzie Magento znalazłem rozwiązanie mojego pytania. Zamiast dodawać kolumnę do siatki za pośrednictwem bazy danych, utworzyłem komponent interfejsu użytkownika sales_order_grid.xmlpod[COMPANY]/[MODULE]/view/adminhtml/ui_component/sales_order_grid.xml

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="sales_order_columns">
        <column name="export_status" class="[COMPANY]\[MODULE]\Ui\Component\Listing\Column\Status">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="visible" xsi:type="boolean">true</item>
                    <item name="label" xsi:type="string" translate="true">XML Exported</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

Następnie utworzył klasę interfejsu użytkownika [COMPANY]/[MODULE]/Ui/Component/Listing/Column/Status.php

namespace [COMPANY]\[MODULE]\Ui\Component\Listing\Column;

use \Magento\Sales\Api\OrderRepositoryInterface;
use \Magento\Framework\View\Element\UiComponent\ContextInterface;
use \Magento\Framework\View\Element\UiComponentFactory;
use \Magento\Ui\Component\Listing\Columns\Column;
use \Magento\Framework\Api\SearchCriteriaBuilder;

class Status extends Column
{
    protected $_orderRepository;
    protected $_searchCriteria;

    public function __construct(ContextInterface $context, UiComponentFactory $uiComponentFactory, OrderRepositoryInterface $orderRepository, SearchCriteriaBuilder $criteria, array $components = [], array $data = [])
    {
        $this->_orderRepository = $orderRepository;
        $this->_searchCriteria  = $criteria;
        parent::__construct($context, $uiComponentFactory, $components, $data);
    }

    public function prepareDataSource(array $dataSource)
    {
        if (isset($dataSource['data']['items'])) {
            foreach ($dataSource['data']['items'] as & $item) {

                $order  = $this->_orderRepository->get($item["entity_id"]);
                $status = $order->getData("export_status");

                switch ($status) {
                    case "0":
                        $export_status = "No";
                        break;
                    case "1";
                        $export_status = "Yes";
                        break;
                    default:
                        $export_status = "Failed";
                        break;

                }

                // $this->getData('name') returns the name of the column so in this case it would return export_status
                $item[$this->getData('name')] = $export_status;
            }
        }

        return $dataSource;
    }
}

To działało świetnie. Mam do czynienia z problemem, w którym to dostosowanie powoduje, że pasek narzędzi siatki zamówień jest renderowany po siatce. Czy napotkałeś ten problem?
Ian

@Ian Nie miałem tego problemu. Jakiej wersji Magento 2 używasz?
André Ferraz,

2
CE 2.1.1. Ustaliłem problem. Mój moduł pojawił się przed Magento_Sales alfabetycznie. Dodałem <sekwencja> z zależnością do Magento_Sales, wyłączyłem mój moduł, a następnie ponownie go włączyłem. To rozwiązało problem.
Ian

1
Czy to działa również w przypadku opcji eksportu? W moim przypadku wyeksportowane dane miały puste wartości.
MagePsycho

1
Podobnie Magento 1, w filter_condition_callbackktórym możesz dodać własny filtr niestandardowy według pola. Nie mów „Co masz na myśli?” tym razem;)
MagePsycho

33

Moje rozwiązanie może być nieco bardziej wydajne, ponieważ jest zgodne z natywnym sposobem dodawania kolumny do siatki i nie trzeba ładować każdego zamówienia wyświetlanego na stronie, aby uzyskać dane kolumny ( zamiast tego należy użyć tabeli Sales_order_grid ). Powyższe jest doskonałym przykładem tworzenia niestandardowego mechanizmu renderującego.

vendor / [vendor] / [package] /view/adminhtml/ui_component/sales_order_grid.xml

<!-- Add the column "my_column" (My Column) to the sales order grid. -->
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
<columns name="sales_order_columns">
    <column name="my_column">
        <argument name="data" xsi:type="array">
            <item name="config" xsi:type="array">
                <item name="filter" xsi:type="string">text</item>
                <item name="label" xsi:type="string" translate="true">My Column</item>
            </item>
        </argument>
    </column>
</columns>

Pamiętaj, że musisz włączyć kolumnę za pomocą rozwijanego widżetu nad siatką zamówień, zanim się pojawi.

vendor / [vendor] / [package] /etc/di.xml

<!-- Sync the column "my_column" between the sales_order and sales_order_grid tables -->
<virtualType name="Magento\Sales\Model\ResourceModel\Order\Grid" type="Magento\Sales\Model\ResourceModel\Grid">
    <arguments>
        <argument name="columns">
            <item name="my_column" xsi:type="string">sales_order.my_column</item>
        </argument>
    </arguments>
</virtualType>

Przykładowy kod instalacyjny, aby dodać kolumnę do tabeli sales_order_grid (użyj tego w skrypcie instalacyjnym / aktualizacyjnym). Nawiasem mówiąc, ten sam kod działa dla tabeli sales_order.

$setup->getConnection()->addColumn(
        $setup->getTable('sales_order_grid'),
        'my_column',
        [
            'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
            'length' => 255,
            'nullable' => true,
            'comment' => 'My Column'
        ]
    );

Mam nadzieję, że to pomoże! :-)


Ta odpowiedź wymaga, aby kolumna to tabela Sales_order_grid, prawda?
Tero Lahtinen

@MageParts, kiedy ten skrypt zadziała?
SagarPPanchal

1
pracował dla mnie, dzięki: 3 btw, w sales_order_grid.xmlktórym powinieneś zamknąć swój tag <listing> </listing>, w przeciwnym razie zwróci błąd xml
fudu

<nazwa argumentu = "kolumny"> należy zastąpić <nazwa argumentu = "kolumny" xsi: type = "array"> w pliku di: xml. W przeciwnym razie zwróci następujący błąd. Nieprawidłowy „argument” elementu dokumentu: definicja typu jest abstrakcyjna.
saiid

1

Aby utworzyć nową kolumnę w siatce zamówień, odsyłam do Magento Default Module vendor / magento / module-customer-balance

W moim przypadku kolumna „custom_column” już istnieje w tabeli Sales_order.

Muszę pokazać kolumnę „custom_column” w siatce zamówień

Krok 1: Dodaj nową kolumnę w tabeli sales_order_grid

        $connection = $installer->getConnection();
        if ($connection->isTableExists('sales_order_grid')) {
            $connection->addColumn(
                $connection->getTableName('sales_order_grid'),
                'custom_column',
                [
                    "type"      =>  Table::TYPE_TEXT,
                    'default'   =>  null,
                    "comment"   =>  'Custom Column'
                ]
            );
    }

Krok 2: Plik di.xml w app \ code [Vendor] [NameSpace] \ etc \ di.xml

 <!-- Adding Columns in sales_order_grid-->
    <virtualType name="Magento\Sales\Model\ResourceModel\Order\Grid">
        <arguments>
            <argument name="columns" xsi:type="array">
                <item name="custom_column" xsi:type="string">sales_order.custom_column</item>
            </argument>
        </arguments>
    </virtualType>
    <virtualType name="Magento\SalesArchive\Model\ResourceModel\Order\Grid">
        <arguments>
            <argument name="columns" xsi:type="array">
                <item name="custom_column" xsi:type="string">sales_order.custom_column</item>
            </argument>
        </arguments>
    </virtualType>

Krok 3: Utwórz plik układu sales_order_grid.xml w app \ code [Vendor] [NameSpace] \ view \ adminhtml \ ui_component

<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="sales_order_columns">
        <column name="custom_column">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="filter" xsi:type="string">text</item>
                    <item name="label" xsi:type="string" translate="true">Custom Column</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

Uwaga: Zostało to przetestowane w wersji 2.2.6 Magento


0

Demo / ExtendedGrid / view / adminhtml / ui_component / sales_order_grid.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
-->
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="sales_order_columns">
        <column name="new_column_name" class="Demo\ExtendedGrid\Ui\Component\Listing\Column\NewColumnStatus">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="sortable" xsi:type="boolean">false</item>
                    <item name="has_preview" xsi:type="string">1</item>
                    <item name="label" xsi:type="string" translate="true">New Column Name</item>
              </item>
            </argument>
        </column>
    </columns>
</listing>

Następnie utworzył klasę interfejsu użytkownika, aby ją wyrenderować.

Demo / ExtendedGrid / Ui / Component / Listing / Column / NewColumnStatus.php

<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Demo\ExtendedGrid\Ui\Component\Listing\Column;

/**
 * Class  NewColumnStatus
 */
class NewColumnStatus extends \Magento\Ui\Component\Listing\Columns\Column
{

    /**
     * @var string[]
     */
    protected $statuses;

   /**
     * Constructor
     *
     * @param ContextInterface $context
     * @param UiComponentFactory $uiComponentFactory
     * @param CollectionFactory $collectionFactory
     * @param array $components
     * @param array $data
     */
       public function __construct(
        \Magento\Framework\View\Element\UiComponent\ContextInterface $context,
        \Magento\Framework\View\Element\UiComponentFactory $uiComponentFactory,
        \Magento\Framework\UrlInterface $urlBuilder,
        array $components = [],
        array $data = []
    ) {
        $this->urlBuilder = $urlBuilder;
         parent::__construct($context, $uiComponentFactory, $components, $data);
    }


    /**
     * Prepare Data Source
     *
     * @param array $dataSource
     * @return void
     */
    public function prepareDataSource(array $dataSource)
    {
        if (isset($dataSource['data']['items'])) {
            foreach ($dataSource['data']['items'] as &$item) {

           //put  the logic here


            }
        }

        return $dataSource;
   }
}

Nie zapomnij wyczyścić pamięci podręcznej.


-1

Utworzyłem moduł niestandardowy, który doda niestandardowy atrybut w encji Zlecenie sprzedaży, a następnie pokaże w siatce Administracyjne zamówienie sprzedaży.

plik module.xml do zdefiniowania modułu. app \ code \ COMPANY \ MODULE \ etc \ module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
    <module name="COMPANY_MODULE" setup_version="1.0.0">
        <sequence>
            <module name="Magento_Sales"/>
            <module name="Magento_Quote"/>
            <module name="Magento_Checkout"/>
        </sequence>
    </module>
</config>

plik di.xml w app \ code \ COMPANY \ MODULE \ etc \ di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <virtualType name="Magento\Sales\Model\ResourceModel\Order\Grid" type="Magento\Sales\Model\ResourceModel\Grid">
        <arguments>
            <argument name="columns" xsi:type="array">
                <item name="export_status" xsi:type="string">sales_order.export_status</item>
            </argument>
        </arguments>
    </virtualType>
</config>

InstallData.php, aby dodać niestandardowy atrybut export_status do tabeli bazy danych

app \ code \ COMPANY \ MODULE \ Setup \ InstallData.php

<?php

namespace COMPANY\MODULE\Setup;

use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;

/**
 * @codeCoverageIgnore
 */
class InstallData implements InstallDataInterface
{
    /**
     * EAV setup factory
     *
     * @var EavSetupFactory
     */
    private $eavSetupFactory;

    /**
     * Init
     *
     * @param EavSetupFactory $eavSetupFactory
     */
    public function __construct(EavSetupFactory $eavSetupFactory)
    {
        $this->eavSetupFactory = $eavSetupFactory;
    }

    /**
     * {@inheritdoc}
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     */
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);
        if (version_compare($context->getVersion(), '1.0.0') < 0){      
            $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
            $salesSetup = $objectManager->create('Magento\Sales\Setup\SalesSetup');
            $salesSetup->addAttribute('order', 'export_status', ['type' =>'varchar']);
            $quoteSetup = $objectManager->create('Magento\Quote\Setup\QuoteSetup'); 
        }
    }
}

sales_order_grid.xml, aby dodać niestandardową kolumnę w siatce administracyjnej zlecenia sprzedaży.

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="sales_order_columns">
        <column name="export_status">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="filter" xsi:type="string">text</item>
                    <item name="label" xsi:type="string" translate="true">XML Exported</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

Możesz pobrać pełny moduł, klikając poniższy link http://vdcstaging.co.in/download/add-custom-culumn-to-admin-grid.zip

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.