CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

2018/01/08

Search Pluginで検索処理　設置方法　その８

検索Plugin CakeDC/Searchの関連記事、および、CakePHP3に関連する記事

　
ここしばらくは CakePHP3の記事を書いていましたが、CakePHP2で開発をしたシステムのメンテナンス、機能拡張の案件も多く、今回の記事はそんな CakePHP2で開発した案件に関しての記事です。
　
CakePHP2の検索プラグイン「CakeDC/Search」を使った処理で、重複レコードを省く group by句（distinct句）の使い方について解説します。
　
　
CakePHP2の「CakeDC/Search」に関連する記事は、下記に書いていますので、あわせて参考にしてください。
　
CakePHP 2.3　Search Pluginで検索処理　その１設置方法
 CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法
 CakePHP 2.3　Search Pluginで検索処理　その３入力エリア一つで複数の項目を同時に検索する方法
 CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索
 CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索
 CakePHP 2.3　Search Pluginで検索処理　その６ORDER、sortソートの機能
 CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索
　
　
また、CakePHP3に関する記事は、以下に一覧ページがあります。
「CakePHP3」に関する記事一覧（https://blog.s-giken.net/tag/cakephp3）
　
　

検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）を実装

　
検索Plugin CakeDC/Searchの基本的な使い方については、先にも書いていますが、に記事を書いていますので、その記事を参考にしてください。
　
基本的な使い方が分かっている前提で解説を行っていきます。
また、テーブルの設定なども「CakePHP 2.3　Search Pluginで検索処理　その１設置方法」の記事をベースに解説しています。
　
　
検索Plugin CakeDC/Searchを使う場合でも、重複を省く group by（distinct）を実装する場所は、CakeDC/Searchの中ではなく、下記のサンプルソースの 36行目に書いていますが、paginatorの処理の中に設定します。
　
そのため、group by（distinct）の実装方法は、「CakeDC/Search」プラグインを使う場合でも、find()関数を使う場合でも変わらない、ということになります。
　

<?php
class UsersController extends AppController {

  public $name = 'Users';
  public $uses = array('User', 'Profile');

  public $components = array('Search.Prg');
  public $presetVars = array();

  public function beforeFilter() {

    // 検索対象のフィールド設定代入
    $this->presetVars = $this->User->presetVars;

    // ページャ設定
    $pager_numbers = array(
      'before' => ' - ',
      'after'=>' - ',
      'modulus'=> 10,
      'separator'=> ' ',
      'class'=>'pagenumbers'
    );
    $this->set('pager_numbers', $pager_numbers);
  }

  public function index() {
    // 検索条件設定
    $this->Prg->commonProcess();
    // 検索条件取得
    $conditions = $this->User->parseCriteria($this->passedArgs);

    $this->paginate = array(
      'conditions' => $conditions,
      'limit' => 3,

      'group' => array ( 'username' ),

    );
    $this->set('users', $this->paginate('User'));
  }
}

<?php

class UsersController extends AppController {

public $name = 'Users';

public $uses = array('User', 'Profile');

public $components = array('Search.Prg');

public $presetVars = array();

public function beforeFilter() {

// 検索対象のフィールド設定代入

$this->presetVars = $this->User->presetVars;

// ページャ設定

$pager_numbers = array(

'before' => ' - ',

'after'=>' - ',

'modulus'=> 10,

'separator'=> ' ',

'class'=>'pagenumbers'

);

$this->set('pager_numbers', $pager_numbers);

}

public function index() {

// 検索条件設定

$this->Prg->commonProcess();

// 検索条件取得

$conditions = $this->User->parseCriteria($this->passedArgs);

$this->paginate = array(

'conditions' => $conditions,

'limit' => 3,

'group' => array ( 'username' ),

);

$this->set('users', $this->paginate('User'));

}

　
　
Modelは特に変更するところがないので「CakePHP 2.3　Search Pluginで検索処理　その１設置方法」のソースのコピペです。
　
（/app/Model/User.php）

<?php
class User extends AppModel {
  public $name = 'User';

  // 検索プラグイン
  public $actsAs = array('Search.Searchable');

  // 検索対象のフィルタ設定
  public $filterArgs = array(
    array('name' => 'id',       'type' => 'value', 'field' => 'User.id'),
    array('name' => 'username', 'type' => 'like',  'field' => 'User.username'),
    array('name' => 'nickname', 'type' => 'like',  'field' => 'Profile.nickname'),
  );

  // 検索対象のフィールド設定
  public $presetVars = array(
    array('field' => 'id',       'type' => 'value'),
    array('field' => 'username', 'type' => 'value'),
    array('field' => 'nickname', 'type' => 'value'),
  );


  // アソシエーション
  public $hasOne = array(
    'Profile' => array(
      'className'  => 'Profile',
      'foreignKey' => 'user_id',
      'conditions' => null,
      'fields'     => null,
      'dependent'  => true,
    ),  
  );  
}

<?php

class User extends AppModel {

public $name = 'User';

// 検索プラグイン

public $actsAs = array('Search.Searchable');

// 検索対象のフィルタ設定

public $filterArgs = array(

array('name' => 'id', 'type' => 'value', 'field' => 'User.id'),

array('name' => 'username', 'type' => 'like', 'field' => 'User.username'),

array('name' => 'nickname', 'type' => 'like', 'field' => 'Profile.nickname'),

);

// 検索対象のフィールド設定

public $presetVars = array(

array('field' => 'id', 'type' => 'value'),

array('field' => 'username', 'type' => 'value'),

array('field' => 'nickname', 'type' => 'value'),

);

// アソシエーション

public $hasOne = array(

'Profile' => array(

'className' => 'Profile',

'foreignKey' => 'user_id',

'conditions' => null,

'fields' => null,

'dependent' => true,

);

}

重複を省く場合でも group byを。distinctは使わない

　
重複を省く処理は、CakePHPでは「group by」を使うことを想定しているようです。
　
(CakePHP 2.x) 重複を取り除いた場合のPaginateのページ数
http://www.tailtension.com/cakephp/1116/
　
重複行のまとめ方はGROUP BY？DISTINCT？
https://qiita.com/tori076/items/ef7ac4301f9c20491bae
　
これらの記事を読むと、MySQLでは「distinct」より「group by」の方が早いようです。
もしかすると、CakePHPを作っている方々は、この状況を知っていて、CakePHPでは「distinct」は要らない、「group by」を使えば事足りるじゃないか、という作りになっているのかもしれません。

- CakePHP 3.x 4.x 5.x

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP 2.3　bakeの超初心者向けフォロー講座

CakePHP 2.3　bakeの超初心者向けフォロー講座

: CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。

: CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

CakePHP3で関連データをまとめて保存する方法。hasOne、hasMany、belongsTo等の関連データはassociatedを追加することでまとめて保存することができます。

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

: CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法

CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

: CakePHP3のForm Helperの使い方のまとめ

CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。