CakePHP3でアソシエーション先のカラムでデータをソートして取得したい

2019/07/28

CakePHP3でアソシエーション先のカラムでソートしたい

　
アソシエーションしている先のテーブルのカラムでソートして、そのデータを取得したい、というときの方法について解説します。
　
　

アソシエーション先のカラムでソートする処理のサンプルソース

　
下記のように、「contain()」の中で sortの指定も行います。
　

$this->Users = TableRegistry::getTableLocator()->get("Users");
$usersList = $this->Users->find()
                         ->contain(["Bookmarks"
                             =>["sort"=>["Bookmarks.modified"=>"asc"]]
                                   ])
                         ->orderAsc("Users.modified")
                         ->orderAsc("Bookmarks.modified")
                         ->all()->toArray();

$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()」が有効になっていない！のです。
　

$this->Users = TableRegistry::getTableLocator()->get("Users");
$usersList = $this->Users->find()
                         ->contain(["Bookmarks"])
                         ->orderAsc("Users.modified")
                         ->orderAsc("Bookmarks.modified")
                         ->all()->toArray();

$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行目を追加します。）
　

$this->Users = TableRegistry::getTableLocator()->get("Users");
$usersList = $this->Users->find()
                         ->contain(["Bookmarks"
                             =>["sort"=>["Bookmarks.modified"=>"asc"]]
                                   ])
                         ->orderAsc("Users.modified")
                         ->orderAsc("Bookmarks.modified")
                         ->all()->toArray();

$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」の行を追加します。
　

        $this->hasMany('Bookmarks', [
            'foreignKey' => 'user_id',
            "sort" => ["Bookmarks.modified"=>"asc"]
        ]);

$this->hasMany('Bookmarks', [

'foreignKey' => 'user_id',

"sort" => ["Bookmarks.modified"=>"asc"]

]);

　
このとき、2行目末の「,」も忘れずに！
また、「Bookmarks.」を付けなくても正しく動作します。
　
　
また、Tableファイルに上記のように指定していても、前項のように Controllerで指定すると、Controllerの指定が優先されます。
そのため、あるアクションの処理では「created」をキーにしてソートしたい、という場合はその条件を Controller側で指定してください。
　
　

ソート条件を指定する「orderAsc()」の使い方の間違い例

　
ちなみに、ソートキーを複数設定したい場合は下記のように「orderAsc()」を複数記述します。
「間違い」の設定をしていてもエラーにならないため、間違いに気づきにくい不具合です。
　

// 正解
$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();

// 正解

$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()関数で無理やりソートし直す、という処理を作っていました。
　
やっぱり普通に必要になるであろう処理は対応方法が用意されているので、それをしっかり探す必要がありますね。
無駄なコードを減らせますからね。
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

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

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション（連携）させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

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

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

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

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

: CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。