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のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要

CakePHP4でキャッシュをクリアするコマンドcake cache clear_allでPermission deniedのエラーが出るのはcakeにパーミッションが足りないとき。その対処方法を解説。

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

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

: CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法

CakePHP4のクリエビルダーを使って複数のOR条件をANDでつなぐSQL文を作成する方法を解説。OR条件を記述したwhere句を2つつなげて記述する。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。