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 2.x　3.x

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

Message コメントをキャンセル

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

: VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する

VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。

: CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP 2.3でコマンドラインから CakePHPで記述した処理を実行する方法を解説します。

: CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合

アソシエーション（連携）している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。

: CakePHP3のdatetime型カラムの日時の扱い。秒まで正しく表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3でアソシエーション先のカラムでデータをソートして取得したい

アソシエーション先のテーブルのカラムをキーにソートをしたデータを取得したい！ときの記述方法を解説。「orderAsc()」ではなく「contain()」の中にSort条件を記述する。

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。