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のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。

: CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。

: CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

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

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

: CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因

Bakeして自動生成した入力フォーム処理を元に少し処理を追加したら、入力エラーがあってもエラーメッセージが表示されなくなった。原因はリダイレクトの処理にあった。

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！