エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

   

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

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

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

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

 
 

アソシエーション先のテーブルのカラムでソートするサンプルソースの解説

 
まず、サンプルソースの環境は、下記のブログチュートリアルの環境を想定します。
 
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()」が有効になっていない!のです。
 

 
ちなみに、5行目の記述を上記のようにすると、エラーになります。
「orderAsc(“modified”)」のようにすると、エラーにはなりませんが、ソートの設定は無視されています。
 
 

アソシエーション先のテーブルのカラムでソートする記述方法

 
アソシエーション先のテーブルのカラムでソートするための正しい記述方法は、「orderAsc()」で指定するのではなく、「contain()」でテーブルを指定する際に、ソート条件も指定します。(下記 4行目を追加します。)
 

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

["modified"=>"asc"]
のように「Bookmarks.」を付けなくても正しく動作します。
 
 

Tableファイルのアソシエーションの設定に Sort条件を指定することもできる

 
前項では、Controllerに記述する前提で書いてきましたが、「Bookmarksからレコードを取得するときは基本的には『modified』カラムでソートさせるのでいちいち指定したくない」という場合は、Tableに記述しておく方法もあります。
 
 
3行目の「sort」の行を追加します。
 

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

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

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

 
 

ksortを使い強引にソートする方法もある

 
PHPには配列のキーや値をソートの基準として並び替える関数が用意されています。
 
PHP 配列のソート
https://www.php.net/manual/ja/array.sorting.php
 
なので、私は、この記事に書いた内容を知る前は、foreachで配列を生成し、ksort()関数で無理やりソートし直す、という処理を作っていました。
 
やっぱり普通に必要になるであろう処理は対応方法が用意されているので、それをしっかり探す必要がありますね。
無駄なコードを減らせますからね。
 
 

CakePHP3の関連記事

CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合
CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応
CakePHP3でアソシエーション先のカラムでデータをソートして取得したい
CakePHP3のdatetime型カラムの日時の扱い。秒まで正しく表示する方法
CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法
CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root/Homeのリンクなども
CakePHP3で「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」などのエラーが出たときの確認するポイント
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 2.x 3.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法
CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。

CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説
CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート(エレメント)を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

CakePHP3で保存前にバリデーション結果を取得する2つの方法
CakePHP3で保存前にバリデーション結果を取得する2つの方法

CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。

CakePHP 2.3 Search Pluginで検索処理 その3入力エリア一つで複数の項目を同時に検索する方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で入力エリア一つで複数の項目を同時に検索する方法を解説。

CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法(webrootとpagesとを活用する方法)を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

URL短縮サービス「TTTオンライン(https://ttt.onl)」公開
URL短縮サービス「TTTオンライン(https://ttt.onl)」公開

URL短縮サービス「TTTオンライン(https://ttt.onl)」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。

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

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

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

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

CakePHP 2.3 デバッグキット(DebugKit)超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット(DebugKit)のインストール方法、はまりポイントを解説。