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 コメントをキャンセル

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

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

: CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。

: CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

CakePHP4、CakePHP5でクリエビルダーを利用してテーブルからレコードを取得する際、asを使用してカラムの別名で値を取得したい場合の対応方法を解説。また、別名にはハイフンやアスタリスクなど使用できない文字がある点も解説。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。