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 CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

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

ID以外のカラムでアソシエーション（連携）させるための考え方とサンプルソースを用いての説明を行っています。

: CakePHP4のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP4の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP 2.3　Search Pluginで検索処理　その６ORDER、sortソートの機能

CakePHPの検索プラグイン Search Pluginの検索処理の中で order、ソートについての解説です。

: CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション（入力チェック）の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説

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

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。