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の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする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」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。
-
-
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。
-
-
CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。
-
-
CakePHP 2.3 Search Pluginで検索処理 その1設置方法
CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。
-
-
getParam('action')
で取得するアクション名は別関数に移動しても不変CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。
-
-
CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説
CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。
-
-
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。
-
-
CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」
CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。
-
-
CakePHP 2.3 ID以外のカラムでアソシエーション(連携)をさせる場合
ID以外のカラムでアソシエーション(連携)させるための考え方とサンプルソースを用いての説明を行っています。
-
-
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン(エレメント化、ブロック化)にして解説。