共通部分を親クラスにするべきかライブラリにするべきかヘルパーにするべきかそれともそれ以外か

codeigniterで、複数のコントローラーで共通するメソッド群があったんですが、それを書くべきところのルール（作法）がよくわからなくなってきたのでアドバイスがほしいです。

具体的には、ある値を受けたらそれを表に従い変換した値を返すようなメソッドが何種類かあって、それらを複数回書かないために、一箇所に書くところをまとめてしまいたいのですが、親クラスにするべきかライブラリにするべきかヘルパーにするべきかわからなくなりました。

例えば、共通メソッド部分のところをまとめるだけに親クラスを作ったとしたら、それはクラス間の親子関係がおかしいように感じます。

またライブラリなら他の環境へ再利用性が全く無いので、ここに置いていいのか感があります。

そしてヘルパーは、汎用性が高い色んな所で使うようなものならそれっぽいのですが、そんなに呼び出さないので違うのかなと思いました。

あと、コントローラーのフォルダにfunctions.phpみたいなものとか作ってそれを読み込むような方法も考えましたが、標準的な方法じゃないだろうなとも思ってます。

今回のケースだとどこに書くべきか、また、上記の書くところの使い分けの考え方みたいなコツがあれば、ご教授いただけたらありがたいです。

追記
maverixzさんに具体的じゃないと指摘されたのでコードを書いてみます。

例で上げたのはこんな感じのコードです。

メソッドの関心事ってのは、自由記述のフォームから入力されたごちゃごちゃした入力をある程度までまとめるってことでしょうか。

php
1//部署に当たる単語を検出してコードを返す
2function convert_division_code($division){
3   switch($division){
4     case '営業':
5     case '営業1課':
6     return 'eigyo-A';
7     case '営業2課':
8     case '営業3課':
9     return 'eigyo-B';
10     case '総務':
11     case '総務部':
12     return 'soumu';
13     default:
14     return false;
15  }
16}
17
18//事務所の場所の名前を検出してコードを返す
19function convert_branch_code($branch){
20//続く
21

指摘内容の「複数のコントローラーが汎化できるか」ってのがちょっとわかりません。共通部分を汎化しないほうが良いパターンってあるのでしょうか？
同じ内容を2回も3回も書くというのは、１つ変更があるときに全箇所見落としなしで修正するという作業が必要になり、ミスが起こりやすくなると思いますが違うのでしょうか？

あと、今回のコードは○○だからどうするべきだというピンポイントの回答よりも、できれば、どう考えるべきかという判断基準を示していただいた回答の方がより嬉しいです。

xenbeat

2018/05/29 15:52 編集

> 具体的には、ある値を受けたらそれを表に従い変換した値を返すようなメソッド　→全然具体的でないので的を得た回答は難しいと思います。記載内容から複数のコントローラーが汎化できるのか、メソッドの関心事は何のか等わからないので。

行動規範の内容に同意します

回答2件

ベストアンサー

自分ならたぶんこう考えるだろうな、というところを書いてみます。

親クラスの場合

特定の機能を持ったControllerを作るという意味あいになるんだと思います。その機能がControllerが持つべきものなのかどうかというところが判断基準になるんじゃないでしょうか？

ライブラリの場合

他の環境へ再利用性が全く無い場合でも、コードの見通しがよくなるのであればライブラリに分けてしまってもいいかと思います。ただし、単純すぎる処理をいちいちライブラリ化するのも手間かと思うで、クラス化して不自然でない程度の規模があるかを判断基準にしてはいかがでしょうか？

ヘルパーの場合

こちらも「汎用性が高い色んな所で使うようなものならそれっぽい」といのは確かにおっしゃる通りかと思います。ただし、使われる場所が限定的であったとしても、コードの見通しがよくなるのであればヘルパーにしても問題ないかと思います。特にライブラリにするまでもないような（＝クラス化するまでもない、手続き型で十分な）簡単な処理であれば、ヘルパーのほうが向いている気もします。

ライブラリ、ヘルパともに利用範囲や利用頻度、再利用性を考慮して悩んでおられるみたいですが、目的として同じコードを集約しておいてメンテナンス性を高めたいというのが趣旨かと思うので、今回は判断基準としてそこまで重要でない気がします。

さて、利用しているphpのバージョンにもよるのですが、もう1つ方法があるかと思います。

トレイトを使う

例を見る限り、自分ならトレイトを使うかなぁという気がしました。
トレイトについては以下を参考にしてください。
http://php.net/manual/ja/language.oop5.traits.php

投稿2018/05/30 01:59