データを受け取るメソッドの命名について

Question

前提

• プロジェクトはMVCで構成

• モデルのプライベートメソッドでDBから該当データを取得し、配列で返す

• 同一モデルのパブリックメソッドから上のプライベートメソッドを呼び出し、受け取った配列を少し整形して配列で返す

この2つのメソッドがモデルあり、コントローラからパブリックメソッドを呼び出して、その後ソートなどを行い、ビューに渡します。
つまり、
View --> Controller --> Model::publicMethod --> Model::privateMethod
のような構成です。

わからない点

例えばDBからデータを取得するプライベートメソッドが

private function fetchDatas(int $id) : array
{
/* sqlを実行する処理 */
...
}

のように命名されているとき、パブリックメソッドにはどう命名するのが適切なのでしょうか。
パブリックメソッドはgetterではないのでget〜とつけるのは間違いだとは思うのですが…。

Comments

[m.ts10806]

何かしら既存のフレームワークを使われているのでしょうか？

[asatake]

既存フレームワークは使っていません。

[m.ts10806]

一応、「正解はない」ということは理解の上ですよね？プロジェクト的な命名規則はありますか？

[asatake]

そうですね、命名の例がほしいという感じです。命名規則は特に無いです。

[m.ts10806]

モデルの役割とパブリックメソッドの用途によりますね。場合により現在ご提示のfetchDatas()はprivateである必要がないかもしれませんし。id渡されてるので1件に絞ることが目的のようにも思えますし。

Answer 1

get～でも問題ないと思います。
動詞よりも名詞に気をつけたほうがよいかと思います。

名前のつけかたの基準は基本的には外部に公開する一番便利なメソッドと
内部で使う汎用的なメソッドで名前を考えることがよいかと思います。

たとえば食べ物屋とかで注文するのをイメージしてみてください。
お客は作り方の詳細はしらないけど、注文したものがでてくればよくて、
調理場は、作り方を知っている必要があります。

publicは、お客さんが注文をするときの名前で、呼び出す側が内部のことをしらなくても
使えるような名前になっていたほうがよいです。

privateは内部から呼び出すものなので、より詳細の作業かつ汎用的な名前になるかと思います。
場合によっては、builderみたいな専用の処理を用意する場合もあります

結果的にprivateとpublicが同じ名前になっても問題はないかと思います。
とはいえ、今回のケースで「fetchData」がpublicにはなるのは名前の意図がわからないのでNGかと。

public get牛丼() {
  return make牛丼();
}

public get牛丼セット() {
  return make牛丼().add(makeサラダ);
}

private make牛丼() {}
private makeサラダ() {}

あとは、DB検索系に使う動詞だと、想定する検索結果件数の違いで名前をわけることがあります。

Answer 2

http://qiita.com/AKB428/items/20e81ccc8d9998b5535d
http://tech.mof-mof.co.jp/blog/method-name.html
上記のページが参考になるかもしれません。
誰（何）が何をするか、どんな値が返ってきそうかなどを考えながら命名すると良いかもしれません。

datum→data（http://ejje.weblio.jp/content/datum）なのでdatasは微妙かもしれません。

dbからの取得なのでgetよりかはfetchのが命名として望ましいかと。