CakePHPでMySQLのコメントを表示する方法

Question

環境

・Apache
・Mac OS Sierra
・PHP Version 7.0.14
・mysqlnd 5.0.12
・CakePHP3

やりたいこと

CakePHPでbakeでコードを生成する際に、カラム名のコメントを表示するようにしたいです。

補足

編集しているファイルは
/vendor/cakephp/bake/src/Template/Bake/Element/form.ctp

90行目あたりを以下のようにやれば、、、と思ったのですが
どうやってコメントを持ってくるのかわかりませんでした。

echo $this->Form->input('<%= $field %>')
↓
echo $this->Form->input('<%= $field %>',array(
     'label' => array(
     'text' => ここにカラムのコメント情報を入れたい,       // labelに表示するテキスト
     )
   )
);

Answer 1

以下のような感じでしょうか。手元の環境では、それっぽく動きましたが十分な検証はしていません。

echo $this->Form->input('<%= $field %>', ['label' => '<%= $fieldData['comment'] %>']);

あまりマニュアルに載っていないようですが、TableのSchema情報にcommentも持っているようなので、それを使えばできました。

※余談ですが、一般的にはvender配下の外部のコードを変更することはコード管理の観点からあまりよくないです。該当コードのバージョンを上げたときに変更が消えてしまうからです。まぁ、一時利用のbakeなら問題ないかもしれませんけど...

Comments

[ssk]

icchii様

ご回答ありがとうございます。
教えていただいたコードで表示することができました。

助言、ありがとうございます。
vender配下は修正しない方向で進めていきます。

bakeで生成されるコードの雛形を作成したいのですが、どのフォルダにあるファイルを変更したら良いでしょうか？

[popobot]

> bakeで生成されるコードの雛形を作成したいのですが、どのフォルダにあるファイルを変更したら良いでしょうか？

正直bakeは普段全く使わないので、詳しくないのですが... 以下のマニュアルがそれっぽいですかね
https://book.cakephp.org/3.0/ja/bake/development.html#id4

[ssk]

URL情報ありがとうございます！