CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索

2013/08/26 2017/03/12

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

Search Pluginで検索処理　AND検索、OR検索のサンプルコード

　
今回の検索は、入力項目に複数のキーワードを入力した際に、AND検索したり、OR検索したりする検索方法です。
今回の処理は、「CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法」をベースにしていますので、そちらもご覧ください。
　
　
CakePHPの Search Pluginでは、AND検索、OR検索の方法も簡単に実装できるように用意されています。
今回は、下記のように Modelの「nickname」に「’connectorAnd’ => ‘ ‘, ‘connectorOr’ => ‘,’」を追加することで、それぞれ AND検索、OR検索を実装しています。
AND検索の場合は「ーン」の様に、OR検索の場合は「太郎,多恵子」の様に入力することでそれぞれ検索を行えます。
　
Googleの検索が半角スペースで区切ることで AND検索になりますので、「’connectorAnd’ => ‘ ‘」としていますが、「’ ‘（半角スペース）」と記述していある部分を好きな記号に変更することでオリジナルの区切り文字を設定することができます。
　
ただ、OR検索は、Googleの場合は「or」と入力することで OR検索になりますが、CakePHPのこの Search Pluginの場合は、区切り文字を 2文字以上のものを設定することができませんので、「’connectorOr’ => ‘,’」の方は「’,’（カンマ）」を設定しています。
　
————–（/app/Model/User.php）

<?php
class User extends AppModel {  
    :
    :
  // 検索対象のフィルタ設定
  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', 'connectorAnd' => ' ', 'connectorOr' => ','),
  );
    :
    :
}

<?php

class User extends AppModel {

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

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', 'connectorAnd' => ' ', 'connectorOr' => ','),

);

}

————–
　
　

Search Pluginで検索処理　AND検索、OR検索の注意点

　
上記の方法は、検索対象が部分一致検索（’type’ => ‘like’）の場合のみ有効です。
　
完全一致検索（’type’ => ‘value’）の場合は、下記の様に「connectorAnd」「connectorOr」を設定してもエラーにはなりませんが、正しい検索結果は戻ってきません。
　
————–（/app/Model/User.php）

<?php
class User extends AppModel {  
    :
    :
    array('name' => 'id',       'type' => 'value', 'field' => 'User.id', 'connectorAnd' => ' ', 'connectorOr' => ','),
    :
    :
}

<?php

class User extends AppModel {

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

}

————–
　
私は、このことが分からず、かなーりハマりました。エラーが起こらないために何が悪いのかが分かりにくいんですよね。
　
　

CakePHP2 実践入門 (WEB+DB PRESS plus)

Search Pluginで検索処理　AND検索、OR検索の処理のポイント

　
ではどうするか。
下記の様に「’type’ => ‘subquery’」を設定し、「searchIn」の関数を設定し、queryに編集する文字列を生成します。
subqueryを設定し、入力値を戻すだけで IN句を生成してくれるようです。
　
————–（/app/Model/User.php）

<?php
class User extends AppModel {  
    :
    :
  // 検索対象のフィルタ設定
  public $filterArgs = array(
    array('name' => 'id',       'type' => 'subquery', 'method' => 'searchIn', 'field' => 'User.id'),
    array('name' => 'username', 'type' => 'like',  'field' => 'User.username'),
    array('name' => 'nickname', 'type' => 'like',  'field' => 'Profile.nickname'),
  );

  function searchIn($data = array()) {
    $query = $data['id'];
    return $query;
  }
    :
    :
}

<?php

class User extends AppModel {

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

public $filterArgs = array(

array('name' => 'id', 'type' => 'subquery', 'method' => 'searchIn', 'field' => 'User.id'),

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

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

);

function searchIn($data = array()) {

$query = $data['id'];

return $query;

}

————–
　
ただ、この場合、「1,2,3」の様に「,（カンマ）」で区切らないとエラーになります。
そのため、もし、入力値が数字のみと分かっている場合は、「searchIn」の関数の中身を下記の様にしてみるのもいいでしょう。
1行目で数字以外を「,」に変換し、2行目でカンマが連続している場合はカンマ一つに変換する処理を入れて、3行目、4行目で先頭と最後尾のカンマを削除しています。
これであれば、数値以外が入力されても問題はないでしょう。
　
————–（/app/Model/User.php）

  function searchIn($data = array()) {
    $query = mb_ereg_replace ( '[^0-9]', ',', $data['id'] );
    $query = mb_ereg_replace ( ',+', ',', $query );
    $query = mb_ereg_replace ( '^,', '', $query );
    $query = mb_ereg_replace ( ',$', '', $query );
    return $query;
  }

function searchIn($data = array()) {

$query = mb_ereg_replace ( '[^0-9]', ',', $data['id'] );

$query = mb_ereg_replace ( ',+', ',', $query );

$query = mb_ereg_replace ( '^,', '', $query );

$query = mb_ereg_replace ( ',$', '', $query );

return $query;

}

————–
　
　

Search Pluginで検索処理　AND検索、OR検索の応用編

　
その他、これを応用して、例えば、必ず表示させる情報がある場合の対応も可能です。
　
具体的なイメージとしては、会員サイトで会員ごとにお知らせを配信しているとします。
通常は、会員ごとに配信するので会員 IDを付与してお知らせを配信しますが、全会員に向けて一斉配信したいお知らせがあった場合に、特定の IDを付与したお知らせはすべての会員に配信したい、そんな状況を想定します。
　
処理の方法は、「$data[‘id’] .= ‘,20’;」の行を追加するだけです。
今回は、サンプルとして「20」の IDは必ず表示させるようにしていますが、IDを 0にするといった方法でもいいと思います。（もっとスマートな書き方もありますが．．．）
　
————–（/app/Model/User.php）

  function searchIn($data = array()) {
    $data['id'] .= ',20';
    $query = mb_ereg_replace ( '[^0-9]', ',', $data['id'] );
    $query = mb_ereg_replace ( ',+', ',', $query );
    $query = mb_ereg_replace ( '^,', '', $query );
    $query = mb_ereg_replace ( ',$', '', $query );
    return $query;
  }

function searchIn($data = array()) {

$data['id'] .= ',20';

$query = mb_ereg_replace ( '[^0-9]', ',', $data['id'] );

$query = mb_ereg_replace ( ',+', ',', $query );

$query = mb_ereg_replace ( '^,', '', $query );

$query = mb_ereg_replace ( ',$', '', $query );

return $query;

}

- CakePHP 3.x 4.x 5.x

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

Message コメントをキャンセル

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

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

: CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法

CakePHP4でコマンドを実行する際に引数（パラメータ）をコマンド内で受け取る処理について解説。複数個の引数にも対応する記述方法も解説。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系のログイン認証の可否のチェック、および、ログインユーザの情報を取得する方法のまとめ。複数の方法があるが手続きが微妙に異なるためまとめてみた。

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

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

: CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！

: CakePHP4のフラッシュメッセージの表示場所、デザインを変更する方法を解説

CakePHP4のエラーメッセージ、完了メッセージなどを表示するフラッシュ処理の解説。Controller、レイアウトファイル、テンプレートファイルでそれぞれ処理を指定する。

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。