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、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う
CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。
-
CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法
CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。
-
CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その1
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。
-
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。
-
CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法
CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。
-
CakePHP 2.3でOn Duplicate Key構文を実装
CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。
-
CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by(distinct)の実装方法
CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。
-
CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説
CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。
-
CakePHP 2.3 Search Pluginで検索処理 その1設置方法
CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。
-
CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。