CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

2019/09/26 2019/09/28

CakePHP3でデフォルトを設置しつつ選択したソートも有効にする方法

CakePHP3ではソート条件の設定を間違えると困った問題が発生する

　
CakePHP3でデフォルトのソート条件を設定した場合、ソート条件を設定する方法を間違えると、一覧表の表頭（一覧表のタイトル部分）をクリックしてソート条件を変更しようとしてもうまく行かないときがあります。
　
そんなときの対処方法です。
　
　

CakePHP3でソート条件を指定してレコードを取得する基本形

　
Usersテーブルのレコードを、idをソートキーにして取得する場合は下記のように記述をします。
　

$this->Users->find()->order(["id"=>"ASC"])

1	$this->Users->find()->order(["id"=>"ASC"])

　
　
そして、これをページネーションの処理を加ええると下記のようになります。
　

$this->paginate($this->Users->find()->order(["id"=>"ASC"]));

1	$this->paginate($this->Users->find()->order(["id"=>"ASC"]));

この方法ではあとから選択したソート条件は反映されない

　
上記のように記述した場合、初期表示では想定しているソート順に並びます。
　
ですが、一覧表示した後、表頭（一覧表のタイトル）にある下記の処理で生成されたソート条件を変更するリンクをクリックしても想定しているソート順にはなりません。（最初のソート順のままです。）
　
　

// 下記の記述で生成されるソートのリンク
<?= $this->Paginator->sort('user_type') ?>

// HTML上では下記の URLにリンクする設定になっている
http://example.com/users/index?sort=user_type&direction=asc

// 下記の記述で生成されるソートのリンク

<?= $this->Paginator->sort('user_type') ?>

// HTML上では下記の URLにリンクする設定になっている

http://example.com/users/index?sort=user_type&direction=asc

CakePHP3でデフォルトのソート条件を設定しつつユーザが選択したソート条件でも並び替えるようにする方法

　
正しい記述方法は、以下のようになります。
　

$this->paginate = [
    "order" => ["id" => "ASC"]
];
$this->paginate($this->Users->find());

$this->paginate = [

"order" => ["id" => "ASC"]

];

$this->paginate($this->Users->find());

　
　
「<?= $this->Paginator->sort(‘user_type’) ?>」によるソート処理は「$this->Paginator」とあるように、ページネーションに関連する処理なのです。
　
そのため、ページネーションの処理側ではなく、値を取得する処理として「$this->Users->find()」の方でソートの処理を実行してしまうと、ページネーション側でのソート処理が実行されなくなる、というわけなのです。
　
　

CakePHP3でデフォルトのソート条件を設定しつつユーザが選択したソート条件でも並び替えるようにする方法・その２

　
前項で解説した方法がスマートな方法ですが、下記のような方法でも対応は可能です。
　

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));

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より前と以降とで処理の方法が変更になっています。
古い記事を参考にすると動作しない場合があります。
　

// CakePHP 3.4以降
$this->request->getQuery()

// CakePHP 3.4より前
$this->request->query()

// CakePHP 3.4以降

$this->request->getQuery()

// CakePHP 3.4より前

$this->request->query()

- CakePHP 3.x 4.x 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

: CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法

CakePHP環境にてpostLinkで生成した削除のリンクをクリックしても処理が実行されず、JavaScriptでUncaught TypeErrorが発生。原因は同一IDを複数記述していることだった。

: CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。

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

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

: CakePHP3のデバッグキット（DebugKit）を強制的に有効、無効に変更する方法

CakePHP3に付属しているデバッグのためのツール、デバッグキットを強制的に有効化、無効化する方法を解説。初期設定では開発環境としてありそうなドメインの場合のみ有効になるように設定されている。

: CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で複数項目を入力した場合の AND検索、OR検索についての解説です。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHP3のForm Helperの使い方のまとめ

CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

CakePHP3で関連データをまとめて保存する方法。hasOne、hasMany、belongsTo等の関連データはassociatedを追加することでまとめて保存することができます。