リポジトリで組み立てているQueryBuilderをカスタマイズする機構を実装

[kiy0taka]

概要(Overview・Refs Issue)

• リポジトリで組み立てているQueryBuilderに対してソート順や検索条件をカスタマイズできる機構を追加

実装例

/**
 * @QueryExtension(ProductRepository::QUERY_KEY_SEARCH_ADMIN)
 */
class AdminProductListCustomizer extends OrderByCustomizer
{
    /**
     * 常に商品IDでソートする。
     *
     * @param array $params
     * @return OrderByClause[]
     */
    protected function createStatements($params)
    {
        return [new OrderByClause('p.id')];
    }
}

方針(Policy)

• カスタマイズするためのインターフェイスとしては以下を提供

インターフェイス/クラス	概要
QueryCustomizer	QueryBuilderを自由に変更
OrderByCustomizer	ソート順を変更する
WhereCustomizer	検索条件を追加する
JoinCustomizer	結合するテーブルを追加する

テスト（Test)

• 管理画面の商品マスターのソート順を商品IDに固定するサンプル
  • Acme\Entity\AdminProductListCustomizer

相談（Discussion）

• QueryExtensionアノテーションに指定するキーを各リポジトリで定義しておくのか、どこかにまとめて定義したほうがいいのかどうか。