CakePHP 2.3　Search Pluginで検索処理　その６ORDER、sortソートの機能

2013/09/02 2014/06/26

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

Search Pluginで検索処理　ORDER、sortソートの機能

　
今回は、検索をする際に、あらかじめソートキーを選択できるようにする処理を作っていきます。
　
　
ソートキー（ORDER BY）の設定は、「CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法」の「limit」の設定ができさえすれば簡単に分かると思います。
また、今回の処理は、「CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法」をベースにしていますので、そちらもご覧ください。
　
　
なぜなら、タイトルをクリックしてソートをさせた際に表示される URLを見れば「sort:User.username/direction:asc」表示されていますので、「sort」「direction」という項目名でソートをさせる項目を設定している、ということがなんとなく分かるでしょう。
　
　

Search Pluginで検索処理　ORDER、sortソートのサンプルコード

　
まず、入力フォームです。
「表示件数」の次あたりに追加してもらえればいいと思います。
今回は、動作を検証するためのものですので、text形式で作っていますが、実際に運用する際には、プルダウンの選択式にする必要があるでしょうね。
　
————–（/app/View/Elements/searchForm.ctp）

    :
    :
    <dt><label>ソート条件・キー</label></dt>  
    <dd><?php echo $this->Form->input('sort', array(  
      'type' => 'text', 'div' => false, 'label' => false ))?></dd>  
    <dt><label>ソート条件・降順昇順</label></dt>  
    <dd><?php echo $this->Form->input('direction', array(  
      'type' => 'text', 'div' => false, 'label' => false ))?></dd>  
    :
    :

<dt><label>ソート条件・キー</label></dt>

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

'type' => 'text', 'div' => false, 'label' => false ))?></dd>

<dt><label>ソート条件・降順昇順</label></dt>

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

'type' => 'text', 'div' => false, 'label' => false ))?></dd>

————–
　
続いて Modelを修正します。
こちらも「array(‘field’ => ‘sort’, ‘type’ => ‘value’),」を追加するだけです。
細かな説明は、その２の方を見てもらえると分かりやすいかと思います。
　
————–（/app/Model/User.php）

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

<?php

class User extends AppModel {

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

public $presetVars = array(

array('field' => 'id', 'type' => 'value'),

array('field' => 'username', 'type' => 'value'),

array('field' => 'nickname', 'type' => 'value'),

array('field' => 'limit', 'type' => 'value'),

array('field' => 'sort', 'type' => 'value'),

array('field' => 'direction', 'type' => 'value'),

);

}

————–
　
また、デフォルトでソートキーを設定したい場合は、Controllerに「’order’ => array ( ‘User.username’ => ‘desc’, ‘User.id’ => ‘desc’ ),」の設定を追加しておきます。
limitの時と同じく、ここで設定してあってもソートキーの入力があった場合はそちらが優先されます。
　
　
————–（/app/Controller/UsersController.php）

<?php
class UsersController extends AppController {  
    :
    :
    $this->paginate = array(
      'conditions' => $conditions,
      'order' => array ( 'User.username' => 'desc', 'User.id' => 'desc' ),
      'limit' => 3,
    );
    :
    :
}

<?php

class UsersController extends AppController {

$this->paginate = array(

'conditions' => $conditions,

'order' => array ( 'User.username' => 'desc', 'User.id' => 'desc' ),

'limit' => 3,

);

}

- CakePHP 3.x 4.x

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

Message コメントをキャンセル

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

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

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

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

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

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

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

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

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

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