Category Archives: ZendFramework

Zend Framework命名規約早見表

このエントリーをはてなブックマークに追加
はてなブックマーク - Zend Framework命名規約早見表
Share on Facebook

Zend Frameworkは比較的厳格で、整った命名規約を定めています。以下にまとめておきます。

クラス・抽象クラス・インターフェース

共通の規約

  • “Zend/”ディレクトリ(または “ZendX/” ディレクトリ)からの階層構造通りにクラス名を付ける
    • ファイル名が “Zend/Db/Table.php” の場合、クラス名は “Zend_Db_Table”
  • アンダースコアでパス区切り
  • 複数の単語で構成されるクラス名は、それぞれの単語の先頭だけ大文字にする
    • “Zend_Pdf” → OK
    • “Zend_PDF” → NG
  • クラス名に数字を付けるのはおすすめしない

抽象クラス

共通ルール+接尾辞 “Abstract” を付ける(※アンダースコアは不要)

  • “Zend_Controller_PluginAbstract” → OK
  • “Zend_Controller_Plugin_Abstract” → NG

インターフェース

共通ルール+接尾辞 “Interface” を付ける(※アンダースコアは不要)

  • “Zend_Controller_Plugin_PluginInterface” → OK
  • “Zend_Controller_Plugin_Plugin_Interface” → NG

ファイル名

以下の文字のみが使用可能。

  • 英数字
  • アンダースコア
  • ダッシュ文字 (“-”)

※空白文字はNG

関数およびメソッド

  • 英数字のみ
    • privateメソッドとprotectedメソッド以外ではアンダースコアは禁止
    • 数字の利用はおすすめしない
  • privateメソッドとprotectedメソッドの先頭にはアンダースコア1個を入れる
  • camelCaps
    • 先頭の単語はすべて小文字
    • 以降の単語は各先頭文字だけ大文字
    • 例: filterInput(), getElementById(), widgetFactory()
  • デザインパターンを使う場合、メソッド名にパターン名を含める
  • グローバル関数は使わず、静的クラスに含める

変数

  • 英数字のみ
    • private変数とprotected変数以外ではアンダースコアは禁止
    • 数字の利用はおすすめしない
  • private変数とprotected変数の先頭にはアンダースコア1個を入れる
  • camelCaps

定数

  • 英数字およびアンダースコア
    • 数字を使用してもかまわない
  • 常にすべて大文字
  • 定数名の単語の間はアンダースコアで区切る
    • EMBED_SUPPRESS_EMBED_EXCEPTION → OK
    • EMBED_SUPPRESSEMBEDEXCEPTION → NG
  • 定数を宣言する際には、クラスのメンバとして “const” で定義する
    • “define” によるグローバル定数の宣言も可能だが非推奨

参考