WinRoadのLaravel4初心者講座

次世代PHPフレームワークのLaravel4を初心者向けに解説して参ります。

Winroad徒然草の管理人がお届けします
コーディング規則

コーディング規則

このエントリーをはてなブックマークに追加

Laravel4の公式サイトでは、PSR-o*とPSR-1*のコーディング基準に従っています。それ以外に以下のコーディング規則に従っています。と記述されていますが、PSR-0と、PSR-1の詳細がわからないとコーディング規則を覚えることができませんので、下記に調べた内容を記述しておきます。

PSRとは

PSRとは、PHPの標準コーディング規約のことです。その中で、PSR-0は、オートローディング規約、PSR-1は基本コーディング規約です。Laravel4はComposer上で動作しており、Composerのオートローディングが使用できます(以下は、Laravel4ドキュメント+の追補項目からの引用です)。

PRS-0の概略

  • クラス*名にはベンダー*名をトップとした名前空間*をつけます。
  • 名前空間はフォルダ構造と対応しています。名前空間のアンダーバーは、フォルダ構造でもアンダーバーのまま、フォルダ名となります。
  • クラス名に使用されたアンダーバーは、フォルダ構造となります。

幸いなことに、他にもPSRについて日本語に訳してくださっている方がいらっしゃいますので、ご紹介しておきます。

Laravel4のコーディング規約

上記に基づいて、初心者でとりあえず必要なLaravel4のコーディング規約を下記に記述しておきます。

  • コントローラ*は、app/controllers 内に記述します。
  • コントローラファイル名はアッパーキャメル記法(複合語の先頭を大文字で書き始める)+Controllerで記述します。
    例:UserController.php、BaseController.php、HomeController.php
  • クラス名もコントローラ名と同様です。
  • モデル*は、app/models 内に記述します。
  • モデル名はデータベーステーブルの単数形で、アッパーキャメル記法で記述します。
    例:User.php、Collection.php
  • メソッド*名は、ローワーキャメル記法(複合語の先頭を小文字で書き始める)で記述します。
    例:getIndex、postCreate
  • ビュー*は、app/views 内に記述します。
  • ビューファイル名は、すべて小文字で記述します。また、ビュー内のフォルダも小文字で記述します。
  • 名前空間の宣言は、<?php と同じ行に記述します。
  • クラスの内容の定義を始める { は、クラス名と同じ行の最後に記述します。
  • 関数*と制御構造を開始する { は、次の行に記述します。
  • 常に and と or を使います。&& と || は決して使用しないでください。
  • インターフェイスの名前は、Interface をサフィックスとしてください。

« »

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です