【ECCUBE4系】マスタデータの扱いについて #eccube4

ECCUBEには、マスタデータと呼ばれるTBLが存在します。
一部を除くマスタTBLは、管理画面＞設定＞システム設定＞マスタデータ管理画面で確認することができます。

確認したいマスタTBLセレクトボックスから選択し、「選択」ボタンを押下するとデータが取得できます。

マスタTBLに新しくレコードを追加して、選択肢を増やすこともできます。
mtb_product_list_order_by TBLにレコードを追加してみましょう。
mtb_product_list_order_byに登録されている選択肢は、フロント側の商品一覧画面の商品並び替えの機能等で利用されています。

変更前
管理画面

フロント画面

変更後
管理画面

フロント画面

選択肢がちゃんと増えているのが確認できました。
しかし、これだけでは例に挙げた商品検索機能はうまく動作しません。
src/Eccube/Repository/ProductRepository.phpの185行目周辺を確認してみましょう。

        if (!empty($searchData['orderby']) && $searchData['orderby']->getId() == $config['eccube_product_order_price_lower']) {
            // @see http://doctrine-orm.readthedocs.org/en/latest/reference/dql-doctrine-query-language.html
            $qb->addSelect('MIN(pc.price02) as HIDDEN price02_min');
            $qb->innerJoin('p.ProductClasses', 'pc');
            $qb->andWhere('pc.visible = true');
            $qb->groupBy('p.id');
            $qb->orderBy('price02_min', 'ASC');
            $qb->addOrderBy('p.id', 'DESC');
        // 価格高い順
        } elseif (!empty($searchData['orderby']) && $searchData['orderby']->getId() == $config['eccube_product_order_price_higher']) {
            $qb->addSelect('MAX(pc.price02) as HIDDEN price02_max');
            $qb->innerJoin('p.ProductClasses', 'pc');
            $qb->andWhere('pc.visible = true');
            $qb->groupBy('p.id');
            $qb->orderBy('price02_max', 'DESC');
            $qb->addOrderBy('p.id', 'DESC');
        // 新着順
        } elseif (!empty($searchData['orderby']) && $searchData['orderby']->getId() == $config['eccube_product_order_newer']) {
            // 在庫切れ商品非表示の設定が有効時対応
            // @see https://github.com/EC-CUBE/ec-cube/issues/1998
            if ($this->getEntityManager()->getFilters()->isEnabled('option_nostock_hidden') == true) {
                $qb->innerJoin('p.ProductClasses', 'pc');
                $qb->andWhere('pc.visible = true');
            }
            $qb->orderBy('p.create_date', 'DESC');
            $qb->addOrderBy('p.id', 'DESC');
        } else {
            if ($categoryJoin === false) {
                $qb
                    ->leftJoin('p.ProductCategories', 'pct')
                    ->leftJoin('pct.Category', 'c');
            }
            $qb
                ->addOrderBy('p.id', 'DESC');
        }

$searchData['orderby']->getId()

ここでは、先ほどmtb_product_list_order_byに登録したIDが、1・2・3の時はデータの並び替え処理（Order By）の処理が記載されていますが、新規で追加したID4は処理が存在しません。

その為、QueryCustomizerを利用して、先ほどmtb_product_list_order_byに登録したID4のためのOrderByの処理を追加してあげなければなりません。

<?php

namespace Customize\Repository\Customizer;

use Doctrine\ORM\QueryBuilder;
use Eccube\Doctrine\Query\QueryCustomizer;
use Eccube\Repository\QueryKey;

class ProductSearchCustomizer implements QueryCustomizer
{
    /**
     * @inheritDoc
     */
    public function customize(QueryBuilder $builder, $params, $queryKey)
    {
        if (!empty($searchData['orderby']) && $searchData['orderby']->getId() == 4) {
            if ($this->getEntityManager()->getFilters()->isEnabled('option_nostock_hidden') == true) {
                $qb->innerJoin('p.ProductClasses', 'pc');
                $qb->andWhere('pc.visible = true');
            }
            $qb->orderBy('p.create_date', 'ASC');
            $qb->addOrderBy('p.id', 'ASC');
        }
    }

    /**
     * @inheritDoc
     */
    public function getQueryKey()
    {
        return QueryKey::PRODUCT_SEARCH;
    }
}

こんな感じでしょうか。。。？
マスタデータは不用意に編集してしまうと、思わぬ不具合を引き起こしてしまう場合があります。
管理画面から修正するよりは、マイグレーションファイルを作成して、追加したマスタデータの履歴がわりにgitにpushしておくと、より安心ですね。

今回は、ECCUBE4系におけるマスタデータのお話でした。