CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
2019/09/28
CakePHP3でデフォルトを設置しつつ選択したソートも有効にする方法
CakePHP3ではソート条件の設定を間違えると困った問題が発生する
CakePHP3でデフォルトのソート条件を設定した場合、ソート条件を設定する方法を間違えると、一覧表の表頭(一覧表のタイトル部分)をクリックしてソート条件を変更しようとしてもうまく行かないときがあります。
そんなときの対処方法です。
CakePHP3でソート条件を指定してレコードを取得する基本形
Usersテーブルのレコードを、idをソートキーにして取得する場合は下記のように記述をします。
1 |
$this->Users->find()->order(["id"=>"ASC"]) |
そして、これをページネーションの処理を加ええると下記のようになります。
1 |
$this->paginate($this->Users->find()->order(["id"=>"ASC"])); |
この方法ではあとから選択したソート条件は反映されない
上記のように記述した場合、初期表示では想定しているソート順に並びます。
ですが、一覧表示した後、表頭(一覧表のタイトル)にある下記の処理で生成されたソート条件を変更するリンクをクリックしても想定しているソート順にはなりません。(最初のソート順のままです。)
1 2 3 4 5 |
// 下記の記述で生成されるソートのリンク <?= $this->Paginator->sort('user_type') ?> // HTML上では下記の URLにリンクする設定になっている http://example.com/users/index?sort=user_type&direction=asc |
CakePHP3でデフォルトのソート条件を設定しつつユーザが選択したソート条件でも並び替えるようにする方法
正しい記述方法は、以下のようになります。
1 2 3 4 |
$this->paginate = [ "order" => ["id" => "ASC"] ]; $this->paginate($this->Users->find()); |
「<?= $this->Paginator->sort(‘user_type’) ?>」によるソート処理は「$this->Paginator
」とあるように、ページネーションに関連する処理なのです。
そのため、ページネーションの処理側ではなく、値を取得する処理として「$this->Users->find()
」の方でソートの処理を実行してしまうと、ページネーション側でのソート処理が実行されなくなる、というわけなのです。
CakePHP3でデフォルトのソート条件を設定しつつユーザが選択したソート条件でも並び替えるようにする方法・その2
前項で解説した方法がスマートな方法ですが、下記のような方法でも対応は可能です。
1 2 3 4 5 6 |
if($this->request->getQuery("sort")){ $sort = [$this->request->getQuery("sort") => $this->request->getQuery("direction")]; } else { $sort = ["id" => "asc"]; } $papers = $this->paginate($this->Users->find()->order($sort)); |
最初は、上記のようにクエリーに「sort」があるかないかをチェックして、if文でソート条件を振り分けるという処理を作っていました。
これでも動作はするのですが、フレームワークなのにこんな処理をしなくてはいけないはずはない、と思っていたところ、問題の本質にたどり着きました。
クエリーの情報取得方法が CakePHP 3.4で変更になっている
クエリーの情報を取得する方法は、CakePHP3.4より前と以降とで処理の方法が変更になっています。
古い記事を参考にすると動作しない場合があります。
1 2 3 4 5 |
// CakePHP 3.4以降 $this->request->getQuery() // CakePHP 3.4より前 $this->request->query() |
CakePHP3の関連記事
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP3で他のテーブルのマスタテーブルからセレクトボックス(プルダウンリスト)を作る
他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。
-
-
CakePHP3でアソシエーション先のカラムでデータをソートして取得したい
アソシエーション先のテーブルのカラムをキーにソートをしたデータを取得したい!ときの記述方法を解説。「orderAsc()」ではなく「contain()」の中にSort条件を記述する。
-
-
CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説
CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。
-
-
CakePHP 2.3 Search Pluginで検索処理 その7queryを使って 日付の範囲検索
CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。
-
-
CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力
CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。
-
-
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。
-
-
CakePHP 2.3で saveの便利な使い方・サンプルソース付き
CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。
-
-
CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法
CakePHP3でcomposerを使ってパッケージ(ライブラリ、プラグイン)をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。
-
-
CakePHP3のインストールでURL rewriting……のエラーが!その解決方法解説
CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。
-
-
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。