読者です 読者をやめる 読者になる 読者になる

情弱エンジニアのなかのblog

一人前のエンジニアになる為のブログです

CakePHPの命名規則について

MVC命名規則を理解する

CakePHPでどうにもこうにも進まないエラーが出ましてコードに間違いがないか探したのですが 原因は命名規則を違反しているというものでした。

1.命名規則の整理

2.モデル、ビュー、コントローラごとの命名規則

3.まとめ

1.命名規則の整理

CakePHPではファイル名などを命名するときにいくつかルールがあります、 正しく命名しないと処理が動かないことがあるのでしっかり見ていきましょう。

2.モデル、ビュー、コントローラごとの命名規則

三つの命名規則を記載します。

  • モデル

  • データベースのテーブルは複数形で命名する

  • モデル・クラスは複数形のキャメル記法で命名する
  • スクリプトファイル名はモデル・クラス名をそのまま(単数形のキャメル記法で)命名する

  • コントローラ

  • コントローラクラス名はコントローラ名(通常はモデル名と同じ)の複数形+Controllerという形のキャメル記法で命名する
  • スクリプトファイルは、コントローラクラス名をそのまま(複数形+Controllerをキャメル記法で)命名する)
  • アクションメソッド名は、一般的なメソッド名と同様、小文字で始まるキャメル記法で命名する

  • ビュー

  • ビューを保管するフォルダ名は、コントローラ名そのまま(複数形をキャメル記法で)命名する

  • 各ビューテンプレートファイル名は、アクションメソッド名をアンダースコア記法にしたもので命名する

3.まとめ

MVC命名規則の基本となる考え方は以下になります。

  • モデル名だけは単数形、それ以外でデータベースのデータを扱う名前は複数形にする
  • クラスとして定義されるものはキャメル記法、クラスとは直接関係ないものはアンダースコア記法にする

モデルは単数形ですが、それ以外のものは、多数のデータを扱うわけですから複数形で命名するのが基本です。

テーブル名やモデルを利用するコントローラ名は複数形になっていまして、モデルやコントローラなどクラスとして定義されるものはキャメル記法ですが、テーブルやビューテンプレートのようにクラスでないものはアンダースコア記法になります。

長々と書きましたがやはり理解して使っていくことが大切だと思います。 以上になります。