【EC-CUBE 4】リポジトリで独自の商品検索メソッドを作成する方法

2025年2月21日

findBy()より複雑な条件で、商品を検索するには？: Repositoryに独自のメソッドを追加し、expr()メソッドを使ってレコードを取り出してみよう！

データベースから欲しい情報（レコード）を取り出すRepositoryには、find()やfindBy()といったメソッドが備わっています。以下記事で紹介したとおり、特にfindBy()は使い勝手がよく、これで十分な場合も多々あります。

まずはRepositoryを新規に作成する

EC-CUBE（Symfony）でデータベースから特定のレコードを取り出すには、取り出したいレコードが保存されているテーブルに対応したRepositoryを使います。

商品テーブルのようなデフォルトで用意されているRepositoryは「src/Eccube/Repository」下にまとめて保存されていますが（商品テーブル ⇒ ProductRepository.php）、src下のファイルには直接修正等加えない方がよいので、「app/Customize/Repository」下に以下のようなRepositoryファイルを新規作成します。

<?php

namespace Customize\Repository;

use Eccube\Entity\Product;
use Eccube\Repository\AbstractRepository;
use Symfony\Bridge\Doctrine\RegistryInterface;

/**
 * CustomProductRepository
 */
class CustomProductRepository extends AbstractRepository
{
    public function __construct(RegistryInterface $registry)
    {
        parent::__construct($registry, Product::class);
    }
}

ベースとなるシンプルなRepositoryファイルです。（こちらは商品テーブルに紐づくRepositoryです。必要に応じてEntityなどを変更してください。）

ここで作成したCustomProductRepositoryクラスに、オリジナルの検索条件をもつ新しいメソッドを追加していきます。

Exprクラスを使って複雑な検索条件を設定する

Exprクラスは、QueryBuilderで条件式を作成する際に使用され、SQLの演算子をクエリに組み込むために便利なメソッド：eq（等価）、neq（非等価）、lt（小なり）、gt（大なり）などの比較演算子を、簡単にクエリに組み込むことができます。

Exprクラスの基本的な使い方

下記コードは、引数に「商品名」を指定するとそれに合致したレコードを返してくれるメソッドです。

public function findByName($value)
{
    // QueryBuilderインスタンスの作成
    $builder = $this->createQueryBuilder('p');
    
    // where条件の指定
    return $builder
        ->where($builder->expr()->eq('p.name', '?1'))  // eqを使って比較式を作成
        ->setParameter(1, $value)                       // パラメータを設定
        ->getQuery()                                    // クエリを取得
        ->getResult();                                  // 結果を取得
}

$builder = $this->createQueryBuilder('p');

まずcreateQueryBuilderメソッドを使用して、QueryBuilderのインスタンスを作成します。'p'はエイリアスで、このクエリで操作する対象のエンティティ（この場合、Productエンティティ）を指定します。以降、クエリの中でpを使ってフィールド名を指定できるようになります。

->where($builder->expr()->eq('p.name', '?1'))

続いて、whereの引数に条件を指定します。ここではexpr()メソッドを使い、Exprクラスのインスタンスを取得します。これにより比較演算子が使えるようになるので、ここではeq（等価を意味する演算子）を利用し、nameフィールドが?1と等しいという条件eq('p.name', '?1')を作成します。すなわちこの検索条件は、「nameフィールド（商品名）＝ ?1」となります。

->setParameter(1, $value)

「setParameter」で、第二引数の値を第一引数にセットします。

$valueはこのメソッド（findByName）の引数なので、このメソッドをControllerで呼び出すときに指定した引数が「?1」となります。

->getQuery()
->getResult();

最後に「getQuery」メソッドでQueryクラスのインスタンスを取得し、その実行結果を「getResult」で取得します。

慣れないとちょっとややこしいかもしれませんが、この型さえ掴めれば、あとは検索したい条件に応じたexprのメソッドを呼び出すだけです。（exprがもつ代表的なメソッドは次項の通りです。）

Exprに用意されている主なメソッド一覧

前項の「->where($builder->expr()」に続くメソッドを以下の通り変えることで、色々な条件で検索できるようになります。

値が等しい: eq ( フィールド名, 値 )
値が異なる: neq ( フィールド名, 値 )
値より小さい: lt ( フィールド名, 値)
値以下: lte ( フィールド名, 値)
値より大きい: gt ( フィールド名, 値)
値以上: gte ( フィールド名, 値)
あいまい検索: like ( フィールド名, 値)
複数検索: in ( フィールド名, 配列)

あいまい検索

Exprのlikeメソッドを使うと「あいまい検索（キーワードの一部を含む場合に取得）」ができます。

public function findByLikeName($value)
{
  $builder = $this->createQueryBuilder('p');
  return $builder
  ->where($builder->expr()->like('p.name', '?1'))
  ->setParameter(1, '%' . $value . '%')
  ->getQuery()
  ->getResult();
}

setParameterに値をセットする方法が少し特殊です。

「%」はワイルドカードと呼ばれ、ここにはどのような文字（1字でも複数でも可）も当てはめることができます。この例では「%$value%」となり、メソッドの引数に指定した値が含まれるすべてのレコードを検索し、取得できます。

複数検索

Exprのinメソッドを使うと「複数検索」ができます。

public function findByNames($values)
{
  $builder = $this->createQueryBuilder('p');
  return $builder
  ->where($builder->expr()->in('p.name', $values))
  ->getQuery()
  ->getResult();
}

setParameterがなく、引数$values（配列）をそのままinメソッドの第二引数に指定します。
こうすることで、配列の値すべてが検索対象となります。

条件を複数設定する（AND / OR）

「andWhere」または「orWhere」を用いることで、条件を複数追加できます。

andWhere

設定した条件すべてに当てはまるもののみを検索します（AND検索）。

where( 条件, 値 ) -> andWhere( 条件, 値 )

whereに続けてandWhereで同じように条件を設定します。andWhereは複数追加してもOKです。

以下は、「第一引数以上のID かつ 第二引数以下のID をもつ商品レコード」を検索するメソッドです。

public function findByIDs($value1, $value2)
{
  $builder = $this->createQueryBuilder('p');
  return $builder
  ->where($builder->expr()->gte('p.id', '?1'))
  ->andWhere($builder->expr()->lte('p.id', '?2'))
  ->setParameters([1 => $value1, 2 => $value2])
  ->getQuery()
  ->getResult();
}

値を複数セットする場合はsetParameter’s’を用い、配列で値を指定します。

orWhere

設定した条件のいずれかに当てはまるものを検索します（OR検索）。

where( 条件, 値 ) -> orWhere( 条件, 値 )

whereに続けてandWhereで同じように条件を設定します。orWhereは複数追加してもOKです。（AND検索と同じです。）

以下は、「第一引数の値に合致するID または 第二引数の値に合致する名前 をもつ商品レコードを検索する」メソッドです。

public function findByIDOrName($value1, $value2)
{
  $builder = $this->createQueryBuilder('p');
  return $builder
  ->where($builder->expr()->eq('p.id', '?1'))
  ->orWhere($builder->expr()->eq('p.name', '?2'))
  ->setParameters([1 => $value1, 2 => $value2])
  ->getQuery()
  ->getResult();
}

値を複数セットする場合はsetParameter’s’を用い、配列で値を指定します。

レコードの取得順を変える（orderBy）

「orderBy」を用いることで、レコードの並び順を昇順（ASC）か降順（DESC）に指定できます。

orderBy( フィールド名, 並び順 ) -> addOrderBy( フィールド名, 並び順 )

第一引数に基準となるフィールド名、第二引数に並び順（ASC / DESC）を指定します。
また、並び順を追加したい場合はaddOrderByを使います。

以下は、「商品レコードをすべて取得し、IDの大きい順（降順）で並べ替える」というメソッドです。

public function findAllwithDESC()
{
  $builder = $this->createQueryBuilder('p');
  return $builder
  ->orderBy('p.id', 'DESC')
  ->getQuery()
  ->getResult();
}

レコードの取得範囲を変える（setFirst / setMax）

「setFirstResult」でレコードの取得開始位置を、「setMaxResult」で取得する最大レコード数を指定できます。

setFirstResult( 整数 ) -> setMaxResult( 整数 )

setFirstResultの第一引数に0を指定すると1番目、1を指定すると2番目のレコードから取得されます。
setMaxResultは、指定された値の数だけレコードを取得します。（足りない場合はその数まで。）

以下は、「商品レコードをすべて取得し、2番目から4番目のレコード（計3つ）を検索する」メソッドです。

public function findSome()
{
  $builder = $this->createQueryBuilder('p');
  return $builder
  ->setFirstResult(1)
  ->setMaxResults(3)
  ->getQuery()
  ->getResult();
}

取得するレコードの数が膨大になる場合、負荷を低減するためにこのメソッドを使うと良いでしょう。

まとめ

以上、データベースからレコードを取り出すための条件設定について、Exprの使い方を中心に解説しました。

実はExprを使わずとも、条件式をテキストで用意したり「DQL」と呼ばれる方法を利用したりすれば同じようにレコードを検索できます。が、SQLに慣れていない方にはちょっと難しいので、まずはEC-CUBE（Symfony）独特の機能であるExprを、ぜひ使ってみていただければと思います！