Magentoグリッドコンポーネントが正しくソートされない

16

Magentoでグリッドコンポーネントを設定しましたが、ソート動作が壊れているようです。javascriptレベルでどこでデバッグできますか？

グリッドを一度ソートすると、ajaxリクエストが行われ、すべてが正しくソートされます。

ただし、2番目の並べ替えは、ajaxリクエストなしで、すべて同じIDでグリッドをレンダリングします。

この動作はMagentoのコアグリッドでは繰り返されないため、これが私がやっていることだと確信しています。私はUIコンポーネントシステムをよく知らないので、これをどこからデバッグするかを知ることができません。

— アラン・ストーム
ソース

21

さて、私はまだその理由を理解するふりをすることはできませんが、問題はdata私のdataProvider議論の議論でした。

<!-- ... -->
<argument name="dataProvider" xsi:type="configurableObject">
    <!-- ... --->
    <argument name="data" xsi:type="array">
        <item name="config" xsi:type="array">
            <item name="update_url" xsi:type="url" path="mui/index/render"/>
        </item>
    </argument>
    <!-- ... -->
</argument>
<!-- ... -->

これをいくつかのコアグリッドと比較すると、モデルの主キーを持つサブノードを持つノードdataが引数にありませんでした。storageConfigindexField

<argument name="data" xsi:type="array">
    <item name="config" xsi:type="array">
        <item name="update_url" xsi:type="url" path="mui/index/render"/>
        <item name="storageConfig" xsi:type="array">
            <item name="indexField" xsi:type="string">pulsestorm_commercebug_log_id</item>
        </item>                    

    </item>                          
</argument>

これらのノードを追加すると、並べ替え機能が復元されました。

— アラン・ストーム
ソース

ちょうど同じ問題に出くわしました。データ行IDではなく行インデックスによってストレージから値がフォールバックまたはロードされていると思いますが、データが複製される理由はわかりません。答えてくれてありがとう。

— LM_Fielding

7

TL; DR

これは確かに興味深い問題です。

システムの理解方法は次のとおりですが、完全に正しいとは限りません。

ヘッダー列をクリックすると、次のルートへのAJAXリクエストが生成され/admin_key/mui/index/renderます：

フィルター[プレースホルダー]
isAjax
名前空間
ページング[現在]
ページング[ページサイズ]
探す
並べ替え[方向]
ソート[フィールド]

最後のフィールドは、グリッドを並べ替えるフィールドです。

このルートは、デフォルトでapp/code/Magento/Ui/view/base/ui_component/etc/definition.xml次で宣言されています。

<insertListing class="Magento\Ui\Component\Container">
    <argument name="data" xsi:type="array">
        <item name="config" xsi:type="array">
            <item name="component" xsi:type="string">Magento_Ui/js/form/components/insert-listing</item>
            <item name="update_url" xsi:type="url" path="mui/index/render"/>
            <item name="render_url" xsi:type="url" path="mui/index/render"/>
            <item name="autoRender" xsi:type="boolean">false</item>
            <item name="dataLinks" xsi:type="array">
                <item name="imports" xsi:type="boolean">true</item>
                <item name="exports" xsi:type="boolean">false</item>
            </item>
            <item name="realTimeLink" xsi:type="boolean">true</item>
        </item>
    </argument>
</insertListing>

しかし、リストui_component XMLでは、次のようにも宣言されています。

        <argument name="data" xsi:type="array">
            <item name="config" xsi:type="array">
                <item name="component" xsi:type="string">Magento_Ui/js/grid/provider</item>
                <item name="update_url" xsi:type="url" path="mui/index/render"/>
                <item name="storageConfig" xsi:type="array">
                    <item name="indexField" xsi:type="string">page_id</item>
                </item>
            </item>
        </argument>

このルートはapp/code/Magento/Ui/Controller/Adminhtml/Index/Render.php、名前空間パラメーター（通常はUIコンポーネントの名前）に基づいて処理されます

public function execute()
{
    if ($this->_request->getParam('namespace') === null) {
        $this->_redirect('admin/noroute');
        return;
    }

    $component = $this->factory->create($this->_request->getParam('namespace'));
    $this->prepareComponent($component);
    $this->_response->appendBody((string) $component->render());
}

prepareComponentメソッドが子コンポーネントで再帰的である場合：

protected function prepareComponent(UiComponentInterface $component)
{
    foreach ($component->getChildComponents() as $child) {
        $this->prepareComponent($child);
    }
    $component->prepare();
}

列コンポーネントが準備されると、列のソートは次のように処理されapp/code/Magento/Ui/Component/Listing/Columns/Column.phpます。

public function prepare()
{
    $this->addFieldToSelect();

    $dataType = $this->getData('config/dataType');
    if ($dataType) {
        $this->wrappedComponent = $this->uiComponentFactory->create(
            $this->getName(),
            $dataType,
            array_merge(['context' => $this->getContext()], (array) $this->getData())
        );
        $this->wrappedComponent->prepare();
        $wrappedComponentConfig = $this->getJsConfig($this->wrappedComponent);
        // Merge JS configuration with wrapped component configuration
        $jsConfig = array_replace_recursive($wrappedComponentConfig, $this->getJsConfig($this));
        $this->setData('js_config', $jsConfig);

        $this->setData(
            'config',
            array_replace_recursive(
                (array)$this->wrappedComponent->getData('config'),
                (array)$this->getData('config')
            )
        );
    }

    $this->applySorting();

    parent::prepare();
}

どこapplySorting()の方法は、ソートパラメータに基づいて、それは単にデータプロバイダにオーダーを追加しています。

protected function applySorting()
{
    $sorting = $this->getContext()->getRequestParam('sorting');
    $isSortable = $this->getData('config/sortable');
    if ($isSortable !== false
        && !empty($sorting['field'])
        && !empty($sorting['direction'])
        && $sorting['field'] === $this->getName()
    ) {
        $this->getContext()->getDataProvider()->addOrder(
            $this->getName(),
            strtoupper($sorting['direction'])
        );
    }
}

すべてのコンポーネントが準備されると、アクションクラスは応答に対してコンポーネントを（再び再帰的に）レンダリングします。

$this->_response->appendBody((string) $component->render());

これらは、ソート中に起こることの重要なPHPステップであると思います。

次に、JSに、definition.xml上記で宣言されたURLのレンダリングと更新が、次の要素に割り当てられapp/code/Magento/Ui/view/base/web/js/form/components/insert.jsます。

return Element.extend({
    defaults: {
        content: '',
        template: 'ui/form/insert',
        showSpinner: true,
        loading: false,
        autoRender: true,
        visible: true,
        contentSelector: '${$.name}',
        externalData: [],
        params: {
            namespace: '${ $.ns }'
        },
        renderSettings: {
            url: '${ $.render_url }',
            dataType: 'html'
        },
        updateSettings: {
            url: '${ $.update_url }',
            dataType: 'json'
        },
        imports: {},
        exports: {},
        listens: {},
        links: {
            value: '${ $.provider }:${ $.dataScope}'
        },
        modules: {
            externalSource: '${ $.externalProvider }'
        }
    }

このファイルにrequestDataは、AJAXデータを取得するために使用されるメソッドがまだあります。

    requestData: function (params, ajaxSettings) {
        var query = utils.copy(params);

        ajaxSettings = _.extend({
            url: this['update_url'],
            method: 'GET',
            data: query,
            dataType: 'json'
        }, ajaxSettings);

        this.loading(true);

        return $.ajax(ajaxSettings);
    }

メソッドが呼び出されると、このメソッドが呼び出されることがわかりますrender()。

        $.async({
            component: this.name,
            ctx: '.' + this.contentSelector
        }, function (el) {
            self.contentEl = $(el);
            self.startRender = true;
            params = _.extend({}, self.params, params || {});
            request = self.requestData(params, self.renderSettings);
            request
                .done(self.onRender)
                .fail(self.onError);
        });

これが完了すると、コールバックメソッドが呼び出されてデータが適用されます。それはonRender()：

    onRender: function (data) {
        this.loading(false);
        this.set('content', data);
        this.isRendered = true;
        this.startRender = false;
    }

それが新しいコンテンツが適用される場所だと思います。

— デジタルピアニズムのラファエル
ソース

コードコロンボ

— ...-LM_Fielding