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 コメントをキャンセル

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

: CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。

: CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意

CakePHPのユーザ認証に使用するオフィシャルなプラグインAuthenticationだが、CakePHP5系では Authentication Ver.3系を使う必要があるが、公式ChiffonBookが間違えている。

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

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

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

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

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

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