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のUserHelperでログアウトやreCAPTCHAをカスタマイズ

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

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。

: CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。

: CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。