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

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

: CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で複数項目を入力した場合の AND検索、OR検索についての解説です。

: CakePHP 2.3で確認画面付きのお問い合わせフォームの作り方

CakePHPで確認画面付きのお問い合わせフォーム、メールフォームの作り方をサンプルを提示しながら解説。

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

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

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP3のデバッグキット（DebugKit）を強制的に有効、無効に変更する方法

CakePHP3に付属しているデバッグのためのツール、デバッグキットを強制的に有効化、無効化する方法を解説。初期設定では開発環境としてありそうなドメインの場合のみ有効になるように設定されている。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る

他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。