注文グリッドコレクションをMagento2のカスタムテーブルに結合する方法

12

Magento 2.0の注文グリッドに新しい列を追加しようとしています。だから、私はグリッドコレクションの注文に参加する必要があります。どうすればこれを達成できますか？なぜなら、magento2では、グリッドはUIコンポーネントを使用するからです。

magento2  uicomponent 
— プラディープクマール
ソース

回答:

12

Magento 2は注文グリッドにカスタム列を追加し、

参加する

Magento \ Sales \ Order \ Grid \ Collection

どのテーブルに対しても、プラグインを使用するのが最善のオプションです。これは、書き換えに依存せず、コードを無駄のないものにするためです。

モジュールのetc / di.xmlにプラグインを作成します

<type name="Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory">
    <plugin name="sales_order_additional_columns" type="Vendor\ModuleName\Plugins\AddColumnsSalesOrderGridCollection" sortOrder="100" disabled="false" />
</type>

だから、私たちは傍受しています

Magento \ Framework \ View \ Element \ UiComponent \ DataProvider \ CollectionFactory

あなたが見てみると

Magento \ Sales \ etc \ di.xml

あなたが見るでしょう

Magento \ Sales \ Order \ Grid \ Collection

に注入されました

Magento \ Framework \ View \ Element \ UiComponent \ DataProvider \ CollectionFactory

モジュールにプラグインフォルダーとプラグインクラスを作成する

<?php namespace Vendor\ModuleName\Plugins;

use Magento\Framework\Message\ManagerInterface as MessageManager;
use Magento\Sales\Model\ResourceModel\Order\Grid\Collection as SalesOrderGridCollection;

class AddColumnsSalesOrderGridCollection
{
    private $messageManager;
    private $collection;

    public function __construct(MessageManager $messageManager,
        SalesOrderGridCollection $collection
    ) {

        $this->messageManager = $messageManager;
        $this->collection = $collection;
    }

    public function aroundGetReport(
        \Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory $subject,
        \Closure $proceed,
        $requestName
    ) {
        $result = $proceed($requestName);
        if ($requestName == 'sales_order_grid_data_source') {
            if ($result instanceof $this->collection
            ) {
                $select = $this->collection->getSelect();
                $select->join(
                    ["soi" => "sales_order_item"],
                    'main_table.entity_id = soi.order_id AND soi.product_type="simple"',
                    array('weight', 'product_type')
                )
                    ->distinct();

                $select->join(
                    ["soa" => "sales_order_address"],
                    'main_table.entity_id = soa.parent_id AND soa.address_type="shipping"',
                    array('email', 'country_id', 'postcode', 'city', 'telephone')
                )
                    ->distinct();
            }

        }
        return $this->collection;
    }
}

ここでは、getReport（）メソッドの周りのイベントを監視しています。

コピーする

vendor / magento / module-sales / view / adminhtml / ui_component / sales_order_grid.xml

あなたのモジュールのスコープに

Vendor / ModuleName / view / adminhtml / ui_component / sales_order_grid.xml

すべてのコンテンツを上書きしたくないので、コピーしたsales_order_grid.xmlのすべてのコンテンツを削除します。

モジュールの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">

        <!-- sales_order_item weight -->
        <column name="weight">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Weight</item>
                    <item name="sortOrder" xsi:type="number">222</item>
                    <item name="align" xsi:type="string">right</item>
                    <item name="filter" xsi:type="string">text</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <!--<item name="bodyTmpl" xsi:type="string">ui/grid/cells/html</item>-->
                </item>
            </argument>
        </column>

        <!-- sales_order_item product_type-->
        <column name="product_type">
            <argument name="data" xsi:type="array">
                <item name="options" xsi:type="object">Vendor\ModuleName\Ui\Component\Listing\Column\ProductTypes</item>
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Product Type</item>
                    <item name="sortOrder" xsi:type="number">232</item>
                    <item name="align" xsi:type="string">right</item>
                    <!--<item name="filter" xsi:type="string">select</item>-->
                    <item name="component" xsi:type="string">Magento_Ui/js/grid/columns/select</item>
                    <item name="dataType" xsi:type="string">select</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <!--<item name="bodyTmpl" xsi:type="string">ui/grid/cells/html</item>-->
                </item>
            </argument>
        </column>

        <!-- sales_order_address country_id -->
        <column name="country_id">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Country ID</item>
                    <item name="sortOrder" xsi:type="number">242</item>
                    <item name="align" xsi:type="string">right</item>
                    <item name="filter" xsi:type="string">text</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <!--<item name="bodyTmpl" xsi:type="string">ui/grid/cells/html</item>-->
                </item>
            </argument>
        </column>

        <!-- sales_order_address post_code -->
        <column name="postcode">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Postcode</item>
                    <item name="sortOrder" xsi:type="number">252</item>
                    <item name="align" xsi:type="string">right</item>
                    <item name="filter" xsi:type="string">text</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <!--<item name="bodyTmpl" xsi:type="string">ui/grid/cells/html</item>-->
                </item>
            </argument>
        </column>

        <!-- sales_order_address city -->
        <column name="city">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">City</item>
                    <item name="sortOrder" xsi:type="number">252</item>
                    <item name="align" xsi:type="string">right</item>
                    <item name="filter" xsi:type="string">text</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <!--<item name="bodyTmpl" xsi:type="string">ui/grid/cells/html</item>-->
                </item>
            </argument>
        </column>

        <!-- sales_order_address telephone -->
        <column name="telephone">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Telephone</item>
                    <item name="sortOrder" xsi:type="number">252</item>
                    <item name="align" xsi:type="string">right</item>
                    <item name="filter" xsi:type="string">text</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <!--<item name="bodyTmpl" xsi:type="string">ui/grid/cells/html</item>-->
                </item>
            </argument>
        </column>

    </columns>

</listing>

次に、var / cacheフォルダーからキャッシュを削除するか、キャッシュを更新します。追加された列は、販売注文グリッドに表示されます。

— Asrar
ソース
その1つに感謝します（Magento 2.2.0での）私の唯一の問題は、行["soi" => "sales_order_item"]とにテーブルプレフィックスを追加する必要があることでした["soa" => "sales_order_address"]。
— デビッド
うまく機能していると思いましたが、請求書グリッドもごちゃごちゃしているようです。モジュールが有効になっていると、請求書グリッドで注文IDとステータスが奇妙に空になります。
— デビッド
この情報をありがとう、それは私が会社名を追加するのに役立ちました。しかし、発送だけでなく、請求および発送の情報をどのように表示しますか？私は1か一方を表示することができますが、私はsales_order_grid.xmlで使用するために「billing_company」と「shipping_company」を言うために「会社」を名前を変更するように見えることはできません
— RLTcode
1
プラグインクラスを使用すると、CMSページ、CMSブロック、顧客、およびクレジットメモグリッドでエラーが発生します。グリッドコレクションを変更する別の解決策があるかどうかをお知らせください。
— Vishal
請求書グリッドなどでどのようなエラーが見られますか？
— Asrar
9

\Magento\Framework\Data\Collection\AbstractDbmagento2自体を見ると、コレクションにフック操作を提供します。

protected function _renderFilters()
{
    if ($this->_isFiltersRendered) {
        return $this;
    }

    $this->_renderFiltersBefore(); // Hook for operations before rendering filters

    ....................
}

したがって、コレクションに追加するだけでこれを行うために必要なもの[ NAMESPACE\MODULENAME\Model\ResourceModel\YOUR_CLASSNAME\Grid\Collection]

protected function _renderFiltersBefore() {
    $joinTable = $this->getTable('catalog_product_entity_varchar');
    $this->getSelect()->join($joinTable.' as cpev','main_table.entity_id = cpev.entity_id', array('*'));
    parent::_renderFiltersBefore();
}
— Keyur Shah
ソース
カスタムテーブルフィールドをグリッドで表示する必要があります。
— Pradeep Kumar
@Keyur Shahありがとうございます。
— Rohit Goel 2016年
@RohitGoel Keepが他のコミュニティメンバーを支援することを嬉しく思います
— Keyur Shah
確かに:) @KeyurShahコミュニティを支援するのが大好きです。UIコンポーネントなしでグリッドを作成しています。その中にエクスポート機能を追加する方法を教えてください。
— Rohit Goel 2016年
1
の代わりに_renderFiltersBefore、オーバーライド/拡張​​することもできます_initSelect。
— ジャニスElmeris
3

2つのカスタムテーブルを結合する管理グリッドを作成しました。仮想タイプis di.xmlを使用してこれを行うことはできないため、以下の手順に従って更新する必要があります。

etc / di.xml、

Model / Resource / Modulename / Collection.php add join in this file、

Model / Resource / Modulename / Grid / Collection.php、

etc / di.xml

<type name="Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory">
        <arguments>
            <argument name="collections" xsi:type="array">
                <item name="namespace_modulename_listing_data_source" xsi:type="string">Namespace\Modulename\Model\Resource\Modulename\Grid\Collection</item>
            </argument>
        </arguments>
</type>
<type name="Namespace\Modulename\Model\Resource\Modulename\Grid\Collection">
    <arguments>
        <argument name="mainTable" xsi:type="string">tablename</argument>
        <argument name="eventPrefix" xsi:type="string">namespace_modulename_grid_collection</argument>
        <argument name="eventObject" xsi:type="string">namespace_grid_collection</argument>
        <argument name="resourceModel" xsi:type="string">Namespace\Modulename\Model\Resource\Modulename</argument>
    </arguments>
</type>

Model / Resource / Modulename / Collection.php

<?php
namespace Namespace\Modulename\Model\Resource\Modulename;

use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;

class Collection extends AbstractCollection
{
    /**
     * Define model & resource model
     */
    const YOUR_TABLE = 'tablename';

    public function __construct(
        \Magento\Framework\Data\Collection\EntityFactoryInterface $entityFactory,
        \Psr\Log\LoggerInterface $logger,
        \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy,
        \Magento\Framework\Event\ManagerInterface $eventManager,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        \Magento\Framework\DB\Adapter\AdapterInterface $connection = null,
        \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null
    ) {
        $this->_init(
            'Namespace\Modulename\Model\Modulename',
            'Namespace\Modulename\Model\Resource\Modulename'
        );
        parent::__construct(
            $entityFactory, $logger, $fetchStrategy, $eventManager, $connection,
            $resource
        );
        $this->storeManager = $storeManager;
    }
    protected function _initSelect()
    {
        parent::_initSelect();

        $this->getSelect()->joinLeft(
                ['secondTable' => $this->getTable('tablename')],
                'main_table.columnname = secondTable.columnname',
                ['columnname1','columnname2','columnname3']
            );
    }
}
?>

モデル/リソース/モジュール名/グリッド/Collection.php

<?php
namespace Namespace\Modulename\Model\Resource\Modulename\Grid;

use Magento\Framework\Api\Search\SearchResultInterface;
use Magento\Framework\Search\AggregationInterface;
use Namespace\Modulename\Model\Resource\Modulename\Collection as ModulenameCollection;

/**
 * Class Collection
 * Collection for displaying grid
 */
class Collection extends ModulenameCollection implements SearchResultInterface
{
    /**
     * Resource initialization
     * @return $this
     */
   public function __construct(
        \Magento\Framework\Data\Collection\EntityFactoryInterface $entityFactory,
        \Psr\Log\LoggerInterface $logger,
        \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy,
        \Magento\Framework\Event\ManagerInterface $eventManager,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        $mainTable,
        $eventPrefix,
        $eventObject,
        $resourceModel,
        $model = 'Magento\Framework\View\Element\UiComponent\DataProvider\Document',
        $connection = null,
        \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null
    ) {
        parent::__construct(
            $entityFactory,
            $logger,
            $fetchStrategy,
            $eventManager,
            $storeManager,
            $connection,
            $resource
        );
        $this->_eventPrefix = $eventPrefix;
        $this->_eventObject = $eventObject;
        $this->_init($model, $resourceModel);
        $this->setMainTable($mainTable);
    }

    /**
     * @return AggregationInterface
     */
    public function getAggregations()
    {
        return $this->aggregations;
    }

    /**
     * @param AggregationInterface $aggregations
     *
     * @return $this
     */
    public function setAggregations($aggregations)
    {
        $this->aggregations = $aggregations;
    }


    /**
     * Get search criteria.
     *
     * @return \Magento\Framework\Api\SearchCriteriaInterface|null
     */
    public function getSearchCriteria()
    {
        return null;
    }

    /**
     * Set search criteria.
     *
     * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
     *
     * @return $this
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function setSearchCriteria(
        \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null
    ) {
        return $this;
    }

    /**
     * Get total count.
     *
     * @return int
     */
    public function getTotalCount()
    {
        return $this->getSize();
    }

    /**
     * Set total count.
     *
     * @param int $totalCount
     *
     * @return $this
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function setTotalCount($totalCount)
    {
        return $this;
    }

    /**
     * Set items list.
     *
     * @param \Magento\Framework\Api\ExtensibleDataInterface[] $items
     *
     * @return $this
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function setItems(array $items = null)
    {
        return $this;
    }
}

?>
— エクタプリ
ソース
うまくいかなかった
— saravanavelu
私にとってはうまくいきます。エラーは何ですか？
— Ekta Puri 2016
内部サーバーエラー。コードをチェックして再フォーマットできますか
— saravanavelu
どこかでファイルを表示できますか？これは完全にうまくいったので、それでも再フォーマットを試みます
— Ekta Puri
etc / di.xml Model / Resource / Modulename / Collection di.xmlにはこのようなものはありません
— saravanavelu
2

UI定義xmlには、次のようなデータソースノードがあります

<dataSource name="listing_name_data_source">
    <argument name="dataProvider" xsi:type="configurableObject">
        <argument name="class" xsi:type="string">UniqueNameGridDataProvider</argument>
        <argument name="name" xsi:type="string">listing_name_data_source</argument>

どこlisting_name_data_sourceで定義するdi.xmlか、直接クラスを参照することができます。クラス自体は、カスタムコレクションから拡張されMagento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory、collections引数として持つ必要があります。そのコレクションクラスの_initSelect()メソッドでは、テーブルを結合できます。

— フーマンのクリストフ
ソース
1
sales di.xmlには、Magento \ Sales \ Model \ ResourceModel \ Order \ Grid \ Collectionが表示され、ファイル自体は存在しません。この場合、プラグインまたはイベントを書き換えることはできません。o方法は、sales diを確認して注文してくださいグリッドコレクションコード、それがもっと明らかになることを願っています
— Pradeep Kumar
これは、ここで定義されていますgithub.com/magento/magento2/blob/develop/app/code/Magento/Sales/...で、UIComponent \データプロバイダ\のSearchResult \ Magentoの\の枠組み\ビュー\要素から延びる仮想タイプである
— クリストフFoomanで
次に、そのクラスに結合を追加します。コード例を教えてください
— Pradeep Kumar
— クリストフ、フーマンで2016年
@KristofatFooman仮想タイプなので間違った例を示しますが、仮想タイプとして定義されたグリッドコレクションの例を挙げられますか？
— LucScu
2

@Asrarソリューションに問題がある場合は、次のようにします。

public function aroundGetReport(
    \Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory $subject,
    \Closure $proceed,
    $requestName
) {
    $result = $proceed($requestName);
    if ($requestName == 'sales_order_grid_data_source_firsty') {
        if ($result instanceof $this->collection
        ) {
            $select = $this->collection->getSelect();
            $select->join(
                ["soi" => "sales_order_item"],
                'main_table.entity_id = soi.order_id',
                array('sku', 'name','item_id')
            )
                ->distinct();
            return $this->collection;
        }

    }
    return $result;
}

これは私には問題なく動作しているようです。

— vbak
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.