CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

2013/09/09 2014/06/26

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

Search Pluginで検索処理 queryを使って日付の範囲検索

　
今回は、「’type’ => ‘query’」を使い、オリジナルの検索条件を記述して検索する方法を行います。
今回の処理は、「CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法」をベースにしていますので、そちらもご覧ください。
　
　
本当は、「Group By句」による集計の処理をやろうかと思っていましたが、Group By ＋ sumによる集計は、集計した項目をバーチャルフィールド（virtual fields）を使って値を取得する必要があるため（バーチャルフィールドを使わなくても値を取得できないわけではないですが）、長くなりそうなので、「’type’ => ‘query’」の方を先にやってみたいと思います。　
　
　
「’type’ => ‘query’」を使うと、検索の条件を柔軟性を持って設定することができるため、もともと用意されている検索方法以外の検索方法を行いたい、と思った場合に利用できる方法です。
　
具体的な検索方法を考える際にあれこれ悩みましたが、あまりいいサンプルを思いつかず、今回の記事は、下記のサイトを参考にさせていただきました。
http://kamakurasoft.net/blog/?p=1479
　
　

Search Pluginで検索処理 queryを使って日付の範囲検索のサンプルコード

　
まずは、Viewから。
Viewの Elementsに下記の項目を追加してください。
　
————–（/app/View/Elements/searchForm.ctp）

    :
    :
    <dt><label>日付</label></dt>  
    <dd><?php echo $this->Form->input('start',array(
        'type'=>'date', 'dateFormat'=>'YMD', 'timeFormat'=>'NONE', 'monthNames'=>'false',
//        'label'=>'開始年月日（年-月-日）',
        'label'=>'',
        'minYear'=>2010, 'maxYear'=>date('Y') + 5,
        'selected'=>array('year'=>date('Y')-1,'month'=>date('m'),'day'=>date('d')), /*1年前*/ )) ?></dd>
    :
    :

<dd><?php echo $this->Form->input('start',array(

'type'=>'date', 'dateFormat'=>'YMD', 'timeFormat'=>'NONE', 'monthNames'=>'false',

// 'label'=>'開始年月日（年-月-日）',

'label'=>'',

'minYear'=>2010, 'maxYear'=>date('Y') + 5,

'selected'=>array('year'=>date('Y')-1,'month'=>date('m'),'day'=>date('d')), /*1年前*/ )) ?></dd>

————–
　
「’label’=>’開始年月日（年-月-日）’,」をコメントにしていますが、labelの設定があると入力エリアのすぐ上にラベル表示がされるためにコメントにしています。
ちなみに、labelの設定がない場合は、デフォルトの設定として項目名の「start」がラベル名として表示されます。そのため、labelを消すためには「’label’=>”,」の設定が必要なようです。
　
　
続けて、Modelです。
サンプルは開始日と終了日での設定がしてありますが、ここでは面倒なので開始日しか設定していません。
　
日付の項目に関して、今回の日付項目は、「start」という項目名で設定しています。その中から、日付の「年」の項目は「$data[‘start’][‘year’]」として取得します。同じように「月」「日」は、「$data[‘start’][‘month’]」「$data[‘start’][‘day’]」として取得します。
　
私は、最初のうちはこのことがよく分からず、日付の項目の項目名は一つなのに、年月日のそれぞれの項目はどうやって取得したらいいのだろう、としばーらく悩んでいました。
分かってしまえば意外に簡単ではあるんですが．．．
　
————–（/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'),
    array('name' => 'start',    'type' => 'query', 'method'=>'createSql'),
  );

  public function createSql ( $data = array () ) {
    $start = $data['start']['year'] . '-' . $data['start']['month'] . '-' . $data['start']['day'];
    $condition = array ( 'DATE(User.created) >= DATE(?)' => array($start) );
    return $condition;
  }
    :
    :
}

<?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'),

array('name' => 'start', 'type' => 'query', 'method'=>'createSql'),

);

public function createSql ( $data = array () ) {

$start = $data['start']['year'] . '-' . $data['start']['month'] . '-' . $data['start']['day'];

$condition = array ( 'DATE(User.created) >= DATE(?)' => array($start) );

return $condition;

}

————–
　
　
また、入力の値を再び設定する処理で、下記のように設定してみましたがうまくいかず、デフォルトの設定に戻ってしまいます。
こちらの設定方法については後日分かり次第改めて対応したいと思います。
　
————–（/app/Model/User.php）

<?php
class User extends AppModel {
    :
    :
  // 検索対象のフィールド設定
  public $presetVars = array(
    :
    :
    array('field' => 'start',    'type' => 'date'),
  );
    :
    :
}

<?php

class User extends AppModel {

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

public $presetVars = array(

array('field' => 'start', 'type' => 'date'),

);

}

- CakePHP 3.x 4.x

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

Message コメントをキャンセル

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

: CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。

: CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

: CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション（入力チェック）の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

: CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。