This document is for a version of CakePHP that is no longer supported. Please upgrade to a newer release!
私たちは「設定より規約」(convention over configuration) という考え方に賛成です。 CakePHP の規約を習得するには少し時間がかかりますが、長い目で見ると時間を節約していることになります。 規約に従うと自由に使える機能が増えますし、設定ファイルを調べまわってメンテナンスするという悪夢からも 開放されます。 規約によって開発が統一感を持つため、開発者が加わってすぐに手伝うということがやりやすく なります。
コントローラーのクラス名は複数形でパスカルケースで、最後に Controller
が付きます。
UsersController
、 ArticleCategoriesController
は規約に合ったコントローラー名の例
となります。
コントローラーにある public メソッドは、アクションとしてブラウザーからアクセス可能になります。
例えば、 /users/view
は UsersController
の view()
メソッドにアクセスします。
protected メソッドや private メソッドはルーティングしてアクセスすることはできません。
前節の通り、ひとつの単語からなる名前のコントローラーは、簡単に小文字の URL パスにマップできます。
例えば、 UsersController
(ファイル名は UsersController.php)には、
http://example.com/users
としてアクセスできます。
複数語のコントローラーをあなたの好きなようにルーティングできますが、
DashedRoute
クラスを使用すると URL は小文字とダッシュを用いる規約であり、
ArticleCategoriesController::viewAll()
アクションにアクセスするための正しい形式は
/article-categories/view-all
となります。
this->Html->link
を使用してリンクを作成した時、URL 配列に以下の規約を使用できます。
$this->Html->link('link-title', [
'prefix' => 'MyPrefix', // パスカルケース
'plugin' => 'MyPlugin', // パスカルケース
'controller' => 'ControllerName', // パスカルケース
'action' => 'actionName' // キャメルバック
]
CakePHP の URL とパラメーターの取り扱いに関するより詳細な情報は、 ルートを接続 をご覧ください。
通常、ファイル名はクラス名と一致し、オートローディングのために PSR-4 標準に準拠してください。以下に、クラス名とファイル名の例を挙げます。
LatestArticlesController
というコントローラークラスは、
LatestArticlesController.php というファイル名にします。
MyHandyComponent
というコンポーネントクラスは、
MyHandyComponent.php というファイル名にします。
OptionValuesTable
という Table クラスは、
OptionValuesTable.php というファイル名にします。
OptionValue
という Entity クラスは、
OptionValue.php というファイル名にします。
EspeciallyFunkableBehavior
というビヘイビアークラスは、
EspeciallyFunkableBehavior.php というファイル名にします。
SuperSimpleView
というビュークラスは、
SuperSimpleView.php というファイル名にします。
BestEverHelper
というヘルパークラスは、
BestEverHelper.php というファイル名にします。
各ファイルは、 app フォルダー内の適切なフォルダー・名前空間の中に配置します。
CakePHP のモデルに対応するテーブル名は、複数形でアンダースコア記法です。上記の例で言えば、
テーブル名はそれぞれ、 users
、 article_categories
、 user_favorite_pages
になります。
二個以上の単語で構成されるフィールド/カラムの名前は、
first_name
のようにアンダースコア記法になります。
hasMany, blongsTo, hasOne 中の外部キーは、デフォルトで関連するモデルの(単数形の)名前に
_id
を付けたものとして認識されます。ユーザーが記事を複数持っている (Users hasMany Articles)
としたら、 articles
テーブルは、 user_id
を外部キーとして users
テーブルのデータを
参照します。 article_categories
のような複数の単語のテーブルでは、外部キーは
article_category_id
のようになるでしょう。
モデル間の BelongsToMany の関係で使用される join テーブルは、結合するテーブルに合わせて、
アルファベット順に (tags_articles
ではなく、 articles_tags
) 並べた名前にしてください。
そうでなければ bake コマンドは動作しません。連結用テーブルにカラムを追加する必要がある場合は、
そのテーブル用に別のエンティティークラスやテーブルクラスを作成する必要があります。
主キーとしてオートインクリメントな整数型を使用することに加えて UUID カラムも使用できます。
Table::save()
メソッドを使って新規レコードを保存するとき、CakePHP はユニークな
36 文字の UUID (Cake\Utilitiy\Text::uuid
) を用いようとします。
Table クラスの名前は複数形でパスカルケースで、最後に Table
が付きます。 UsersTable
,
ArticleCategoriesTable
, UserFavoritePagesTable
などは users
,
article_categories
, user_favorite_pages
テーブルに対応するテーブルクラス名の例です。
Entity クラスの名前は単数形でパスカルケースで、サフィックスはありません。 User
,
ArticleCategory
, UserFavoritePage
などは users
, article_categories
,
user_favorite_pages
テーブルに対応するエンティティー名の例です。
ビューのテンプレートファイルは、それを表示するコントローラーの関数に合わせた、
アンダースコア記法で命名されます。
ArticlesController
クラスの viewAll()
関数は、ビューテンプレートとして、
src/Template/Articles/view_all.ctp を探すことになります。
基本パターンは、 src/Template/コントローラー名/アンダースコア記法_関数名.ctp です。
注釈
デフォルトで、CakePHP は英単語の語形変化を使用します。もし、別の言語を使った
データベースのテーブルやカラムがある場合、語形変化規則 (単数形から複数形、逆もまた同様) の
追加が必要になります。カスタム語形変化規則を定義するために
Cake\Utility\Inflector
を使うことができます。より詳しい情報は、
Inflector をご覧ください。
各部分を CakePHP の規約に合わせて命名しておくことで、混乱を招く面倒な設定をしなくても 機能的に動作するようになります。以下が最後の規約に合った命名の例です。
データベースのテーブル: "articles"
Table クラス: ArticlesTable
の場所は src/Model/Table/ArticlesTable.php
Entity クラス: Article
の場所は src/Model/Entity/Article.php
Controller クラス: ArticlesController
は
src/Controller/ArticlesController.php
ビューテンプレートの場所は src/Template/Articles/index.ctp
これらの規約により、CakePHP は、 http://example.com/articles
へのリクエストを、
ArticlesController の index()
関数にマップします。そして、Articles モデルが自動的に使える
(データベースの 'articles' テーブルに自動的に接続される)ようになり、表示されることになります。
必要なクラスとファイルを作成しただけでこれらの関係が設定されています。
さて、これで CakePHP の基本について一通り理解できました。物事がどう組み合わせられるかを確かめるために、 コンテンツ管理チュートリアル を体験することができるでしょう。
CakePHP プラグインのパッケージ名にプレフィックスとして "cakephp-" を付けると便利です。 これにより、名前が意味的にフレームワークに依存することを関連付けられます。
CakePHP 所有のプラグインに予約されているため、ベンダー名として CakePHP ネームスペース(cakephp) を 使用しない でください。 規約では、小文字の文字とダッシュを区切り記号として使用します。
// 悪い例
cakephp/foo-bar
// 良い例
your-name/cakephp-foo-bar
詳しくは awesome list recommendations をご覧ください。