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

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

Message コメントをキャンセル

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

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP 2.3　ログイン、操作履歴、アクセスログ出力

CakePHPでログインや操作履歴などのアクセスログ出力処理を作成します。

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。

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

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

: CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP3の標準設定のタイムゾーンは「UTC（協定世界時）」に設定されている。これを日本標準時に変更する方法（app.php、bootstrap.phpの変更方法）の解説。

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

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

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

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のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakePHP 2.3　ログイン、操作履歴、アクセスログ出力

CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

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

CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

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

CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

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で検索処理　設置方法