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

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

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。

: CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。

: CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

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

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

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP4のCakeDC/Usersのログイン時のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製UsersプラグインのCakePHP4版の紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。