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
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
cakephp3 カスタムバリデーションを簡易的に実装する方法
CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。
-
-
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。
-
-
CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力
CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。
-
-
CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法
CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。
-
-
CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除
CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。
-
-
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3で静的なページを設置する場合の方法(webrootとpagesとを活用する方法)を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。
-
-
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。
-
-
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。
-
-
VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する
VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。
-
-
CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。