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 5.x

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

Message コメントをキャンセル

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

: CakePHP4、5のユーザ認証でID、PASS以外の削除フラグなども条件加える方法

CakePHP4系、5系ではAuthenticationを使用してログイン認証を行う。その認証でID、PASS以外の削除フラグなどの条件を加えたいときの対応方法について解説。

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

: CakePHP3で保存前にバリデーション結果を取得する2つの方法

CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

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

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

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

: CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

PHPでサーバ情報、環境情報を取得する際は「$_SERVER」を利用するが、似たような情報をCakePHPの関数で取得する際は「getUri()」を使用する。取得出来る値は一致するものもあるが、違うものもあり便利な使い方もある。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

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

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

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