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 コメントをキャンセル

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

: CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

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

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

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

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

: CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

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

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

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。

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

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