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

Question

###前提
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;

Answer 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で参照できますので、実際にコードを動かして確認してみると理解が深まると思います

Comments

[gitboku]

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

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

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

[popobot]

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

そうです

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

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

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

[gitboku]

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