CakePHP3でアソシエーション先のカラムでデータをソートして取得したい
CakePHP3でアソシエーション先のカラムでソートしたい
アソシエーションしている先のテーブルのカラムでソートして、そのデータを取得したい、というときの方法について解説します。
アソシエーション先のカラムでソートする処理のサンプルソース
下記のように、「contain()」の中で sortの指定も行います。
1 2 3 4 5 6 7 8 |
$this->Users = TableRegistry::getTableLocator()->get("Users"); $usersList = $this->Users->find() ->contain(["Bookmarks" =>["sort"=>["Bookmarks.modified"=>"asc"]] ]) ->orderAsc("Users.modified") ->orderAsc("Bookmarks.modified") ->all()->toArray(); |
アソシエーション先のテーブルのカラムでソートするサンプルソースの解説
まず、サンプルソースの環境は、下記のブログチュートリアルの環境を想定します。
CakePHP3 Cookbook ブログチュートリアル
https://book.cakephp.org/3.0/ja/tutorials-and-examples/blog/blog.html
ブックマークチュートリアル関連の記事としては以下にも記事を書いています。
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
このブログチュートリアルの環境において、Usersのデータを取得する際に、アソシエーション先のテーブルを contain()を使って Bookmarksのデータも一緒に取得します。
その際、Bookmarksのデータも「modified」のカラムでソートしたい!という場合の対処方法です。
最初に考えたのは、下記のような記述方法でした。
4行目の「orderAsc()」に続けて、5行目を追加しました。
ですが、この記述方法では 5行目の「orderAsc()」が有効になっていない!のです。
1 2 3 4 5 6 |
$this->Users = TableRegistry::getTableLocator()->get("Users"); $usersList = $this->Users->find() ->contain(["Bookmarks"]) ->orderAsc("Users.modified") ->orderAsc("Bookmarks.modified") ->all()->toArray(); |
ちなみに、5行目の記述を上記のようにすると、エラーになります。
「orderAsc(“modified”)」のようにすると、エラーにはなりませんが、ソートの設定は無視されています。
アソシエーション先のテーブルのカラムでソートする記述方法
アソシエーション先のテーブルのカラムでソートするための正しい記述方法は、「orderAsc()」で指定するのではなく、「contain()」でテーブルを指定する際に、ソート条件も指定します。(下記 4行目を追加します。)
1 2 3 4 5 6 7 8 |
$this->Users = TableRegistry::getTableLocator()->get("Users"); $usersList = $this->Users->find() ->contain(["Bookmarks" =>["sort"=>["Bookmarks.modified"=>"asc"]] ]) ->orderAsc("Users.modified") ->orderAsc("Bookmarks.modified") ->all()->toArray(); |
「["Bookmarks.modified"=>"asc"]
」
は
「["modified"=>"asc"]
」
のように「Bookmarks.」を付けなくても正しく動作します。
Tableファイルのアソシエーションの設定に Sort条件を指定することもできる
前項では、Controllerに記述する前提で書いてきましたが、「Bookmarksからレコードを取得するときは基本的には『modified』カラムでソートさせるのでいちいち指定したくない」という場合は、Tableに記述しておく方法もあります。
3行目の「sort」の行を追加します。
1 2 3 4 |
$this->hasMany('Bookmarks', [ 'foreignKey' => 'user_id', "sort" => ["Bookmarks.modified"=>"asc"] ]); |
このとき、2行目末の「,」も忘れずに!
また、「Bookmarks.」を付けなくても正しく動作します。
また、Tableファイルに上記のように指定していても、前項のように Controllerで指定すると、Controllerの指定が優先されます。
そのため、あるアクションの処理では「created」をキーにしてソートしたい、という場合はその条件を Controller側で指定してください。
ソート条件を指定する「orderAsc()」の使い方の間違い例
ちなみに、ソートキーを複数設定したい場合は下記のように「orderAsc()」を複数記述します。
「間違い」の設定をしていてもエラーにならないため、間違いに気づきにくい不具合です。
1 2 3 4 5 6 7 8 9 10 11 12 |
// 正解 $usersList = $this->Users->find() ->contain(["Bookmarks"]) ->orderAsc("Users.modified") ->orderAsc("Bookmarks.modified") ->all()->toArray(); // 下記のように orderAsc()の中に複数の項目を並べるのは間違い $usersList = $this->Users->find() ->contain(["Bookmarks"]) ->orderAsc("Users.modified","Bookmarks.modified") ->all()->toArray(); |
ksortを使い強引にソートする方法もある
PHPには配列のキーや値をソートの基準として並び替える関数が用意されています。
PHP 配列のソート
https://www.php.net/manual/ja/array.sorting.php
なので、私は、この記事に書いた内容を知る前は、foreachで配列を生成し、ksort()関数で無理やりソートし直す、という処理を作っていました。
やっぱり普通に必要になるであろう処理は対応方法が用意されているので、それをしっかり探す必要がありますね。
無駄なコードを減らせますからね。
CakePHP3の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールするCakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP3のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP3の英語のメッセージを日本語化(多言語化)する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。
-
CakePHP4のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP4の英語のメッセージを日本語化(多言語化)する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。
-
CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法
CakePHP3でcomposerを使ってパッケージ(ライブラリ、プラグイン)をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。
-
CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()
CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。
-
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3で Insert … On Duplicate Key Update構文(upsert)を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。
-
CakePHP3で「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」などのエラーが出たときの確認するポイント
CakePHP3の開発で発生する「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」のエラーには特有の原因もあるため、その説明と対処方法の解説。
-
CakePHP 2.3 主キー(ID)以外のキーで更新方法 updateAll
主キー(ID)以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。
-
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。
-
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。
-
CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法
CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。