CakePHP 2.3　Search Pluginで検索処理　その１設置方法

2013/07/30 2017/03/12

Search Pluginで検索処理　設置方法

プラグイン設置の参考サイト

　
CakePHP 2.0系の Search Pluginで検索処理を作ります。
　
参考にしたのは下記のサイト。文面はふざけている部分もありますが、内容は至ってしっかりしたもので、非常に参考になります。
また、ページャーの処理やソート機能なども Bakeするのではなく、それぞれ解説をしながら作っていきますので非常に勉強になります。
http://torhamzedd.halteria.com/2012/01/cakephp20search-plugin22.html
　
上記のサイトを読みながら、プラグインをダウンロードして、所定の場所にインストールしてください。私の場合は、ダウンロードしたファイルは、最新版の 2.3でした。
　
　

Search Plugin設置の際の注意ポイント

　
ここで注意してほしいのは、Pluginを設置したら「/app/Config/bootstrap.php」にそのことを記述する必要があるということです。（上記のサイトには書かれていません。）
　
「/app/Config/bootstrap.php」の 65行目あたりから Pluginの設定についての記述がありますので、そのあたりに下記のコードを追加しましょう。
　
————–（/app/Config/bootstrap.php）

CakePlugin::load(array('Search'));

1	CakePlugin::load(array('Search'));

————–
　
もしくは、70行目あたりにある下記のものをコメントの外に出して、有効にする方法でも OKです。こちらは、Pluginフォルダにあるものはすべて有効にするという記述の方法ですので、すでに有効にしてある場合もあるでしょう。その場合は、上記の記述を書かなくても問題ありません。両方書いていても問題ありません。
　
————–（/app/Config/bootstrap.php）

CakePlugin::loadAll(); // Loads all plugins at once

1	CakePlugin::loadAll(); // Loads all plugins at once

————–
　
　

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

Search Plugin設置のサンプルコード

　
続いて、テーブルを作りましょう。
こちらも上記サイトにあるものをそのまま使いました。また、データもそのまま入れました。
　
さらに続けて、Model、Controller、Viewを作ります。
Viewは、上記のサイトにあるものをそのままで問題ありませんが、Model、Controllerは、PHPのファイルですのでファイルの先頭に「<?php」を記述するのを忘れないようにしておきましょう。
　
そして、一度表示させて、検索フォームを追加するあたりまでは特に問題ないかと思います。
　
　
ページャーの設定などは、bakeで出てくるものをそのまま使うこともできますので、bakeで作ったところに検索処理を追加する場合などは、ページャーの一覧を表示する「app/View/Elements/pager.ctp」の設定は不要となるでしょう。
　
また、「UserController.php」は、最終的には下記のようになります。
　
————–（/app/Controller/UserController.php）

<?php
class UsersController extends AppController {  
  
  public $name = 'Users';  
  public $uses = array('User', 'Profile');  

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

  public function index()  
  {  
    $this->paginate = array(  
      'limit' => 3  
    );  
    
    $this->set('users', $this->paginate('User'));  
  } 

}

<?php

class UsersController extends AppController {

public $name = 'Users';

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

public function beforeFilter() {

// ページャ設定

$pager_numbers = array(

'before' => ' - ',

'after'=>' - ',

'modulus'=> 10,

'separator'=> ' ',

'class'=>'pagenumbers'

);

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

}

public function index()

{

$this->paginate = array(

'limit' => 3

);

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

}

————–
　
　
ここで、その 1は終了。
ここまでは問題ないでしょうか？
　
そして、ここからはその 2が始まります。
http://torhamzedd.halteria.com/2012/01/cakephp20search-plugin2.html
　
　
paginatorの sortの説明や、その機能を使って並び替えをする処理も特に問題ないと思います。
　
そして、続けて「Searchプラグインの準備」とありますが、これは問題ないでしょう。
すでに最初の方で書きましたが、「/app/Config/bootstrap.php」にプラグインを読み込む設定を記述するという内容ですが、最初のタイミングで記述していないと、おそらく最初の表示確認でエラーが出てここまで進めていないはずですから。
　
　
続けて、Model、Controllerの設定を行いますが、最終的には以下のようになります。
　
————–（/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,

);

}

————–
　
　
————–（/app/Controller/UsersController.php）

<?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,
    );
    $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,

);

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

}

- CakePHP 3.x 4.x 5.x

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

Message コメントをキャンセル

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

: CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

: CakePHP5系でDeprecatedを回避しfindListでキーと値のカラムを指定して取得する方法

CakePHP4のfindListでキーと値のカラムを指定してテーブルにアクセスする方法がCakePHP5では「Deprecated（非推奨）」となった。推奨の記述方法を解説。

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション（連携）させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

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

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

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

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

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

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

主キー（ID）以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。

PREV: SyntaxHighlighterを導入してソースコードを見やすくしてみました
NEXT: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

日	月	火	水	木	金	土
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31

CakePHP 2.3　Search Pluginで検索処理　その１設置方法

Search Pluginで検索処理　設置方法

プラグイン設置の参考サイト

Search Plugin設置の際の注意ポイント

Search Plugin設置のサンプルコード

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

CakePHP5系でDeprecatedを回避しfindListでキーと値のカラムを指定して取得する方法

CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

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

CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

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

CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力

CakePHP 2.3 Search Pluginで検索処理 その１設置方法

Search Pluginで検索処理 設置方法

プラグイン設置の参考サイト

Search Plugin設置の際の注意ポイント

Search Plugin設置のサンプルコード

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

CakePHP 2.3　Search Pluginで検索処理　その１設置方法

Search Pluginで検索処理　設置方法