質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.69%

カスタムFinderメソッドの例はどんなクエリを実行しているのでしょうか?

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,576

gitboku

score 30

前提

cakePHP3のカスタムFinderメソッドメソッドについて、わからないことがあったので質問しました。
コード例では以下のように書かれています。

use Cake\ORM\Query;
use Cake\ORM\Table;

class ArticlesTable extends Table
{
  public function findOwnedBy(Query $query, array $options)
    {
        $user = $options['user'];
        return $query->where(['author_id' => $user->id]);
    }
}

// コントローラーやテーブルのメソッド内で
$articles = TableRegistry::get('Articles');
$query = $articles->find('ownedBy', ['user' => $userEntity]);

上記コード例に対する自分の疑問

findOwnedByメソッドはどのようなクエリを実行しているのでしょうか?
一番わからないのは以下の部分です。

$query = $articles->find('ownedBy', ['user' => $userEntity]);


まず"ownedBy"の意味が分かりません。
調べ方が悪いのか、リファレンスが出てきません。

どうか知恵をお貸しください、お願いします。

現在の自分の認識

実行しているクエリ(予想)は以下の通り。
"???"の部分がわからないところです。

select ??? from articles from author_id = $options['user']->id;
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

$articles->find('ownedBy', ['user' => $userEntity]);の意味ですが、find()関数の第一引数で指定したもの(ownedBy)がTableクラス側のfindOwnedByにマッピングされて、実行されます。第二引数はfindOwnedByの第二引数($options)に渡されます。

カスタムFinderを使わない場合、以下のように書くことができます。

$articles->find()->where('author_id' => $userEntity->id);


※この例はわりと単純ですが、もっと複雑な条件だったり、他のfind時にも利用する条件だったりする場合にカスタムFinderを使えば共通化できます。

なお、このクエリを実行すると以下のようなSQLになると思います

select * from articles where author_id = $userEntity->id


※$userEntity->idは実際の値が展開される
※find()->select()を指定していないので * 相当(実際はカラムが列挙されますが)

実行されたSQLについてはDebugKitのSql Logで参照できますので、実際にコードを動かして確認してみると理解が深まると思います

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/07/04 23:10

    ありがとうございます。
    確認したいことが2店あります。

    1:以下の認識で問題ないでしょうか?
    「ArticleTable::findOwnedBy()のインターフェースとして***->find('ownedBy',)が使えるようになる」

    2:findOwnedBy()とfind('ownedBy',)のマップ関係はどうやって指定しているのでしょう……
    クラス名やメソッド名がcakePHPの命名規則に従っていれば、cakePHPが勝手にうまいことやってくれるのでしょうか?

    キャンセル

  • 2017/07/05 04:39

    > 1:以下の認識で問題ないでしょうか?
    > 「ArticleTable::findOwnedBy()のインターフェースとして***->find('ownedBy',)が使えるようになる」

    そうです

    > 2:findOwnedBy()とfind('ownedBy',)のマップ関係はどうやって指定しているのでしょう……
    > クラス名やメソッド名がcakePHPの命名規則に従っていれば、cakePHPが勝手にうまいことやってくれる> のでしょうか?

    そうです、メソッド名が命名規則に従っていれば、特に設定は必要ありません。メソッド名も自由につけることができます。find('hoge')ならfindHogeになります。

    実際の処理はTableクラスのcallFinderでやっていますので、ご興味があれば見てみてください。
    https://github.com/cakephp/cakephp/blob/master/src/ORM/Table.php#L2191

    キャンセル

  • 2017/07/05 23:14

    ありがとうございます!
    githubでソースが見れたのですね……知りませんでした。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.69%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる