謝辞

このドキュメントは Zend Framework PHP 標準コーディング規約 と The Doctrine ORM Framework の Coding Standards をベースに、 symfony の Coding Standards の内容を盛り込んだものです。

有用なドキュメントを公開されている各プロジェクトに厚く御礼申し上げます。

全般

PHP コードのみからなるファイルでは、終了タグ ("?>") は決して含めてはいけません。これは必須なものではなく、 終了タグを省略することで、ファイルの最後にある空白文字が出力に影響することを防ぎます。

インデント

インデントは半角スペース 2 文字でおこない、タブ文字は用いません:

<?php

class opFoo
{
  public function bar()
  {
    return true;
  }
}

行の長さ

1 行の長さを 80 文字までにすることを目指しましょう。すなわち、 コードの長さを現実的な範囲で 80 文字までにおさめるよう努力すべきです。 しかしながら、場合によっては少々長くなってしまってもかまいません。 PHP コードの行の長さは、最大 120 文字までにするようにしましょう。

行末

行末の扱いは、標準的な Unix テキストファイルの方式にあわせます。 行末は、ラインフィード (LF) のみにしなければなりません。 この文字のコードは 10、あるいは 16 進形式で 0x0A となります。

Macintosh のようなキャリッジリターン (CR) (0x0D) や Windows のようなキャリッジリターンとラインフィードの組み合わせ (CRLF) (0x0D, 0x0A) を使用しないでください。

クラス

クラス名は必ず "op" というプレフィックスをつけなければなりません。

クラス名は英数字のみを含み、アンダースコアは許可されません。クラス名が複数の単語から成り立つ場合は、単語の最初の文字を大文字にしてください（これは「キャメルケース」と呼ばれています）。

インターフェース

インターフェースの規約は通常のクラスに従ってください（前項を参照してください）。

なお、名前は "Interface" という語で終わるようにしなければなりません。

関数とメソッド

メソッド名はキャメルケースでなければなりません。

関数定義はヘルパー関数を除いて認められません。関数名は PHP 本体に従ってアンダースコアを使用しなければなりません (PHP Coding Standards (英語) も参照してください)。

変数

変数名に含めることができるのは英数字のみです。アンダースコアを使用してはいけません。数字を含めることは可能ですが、ほとんどの場合はお勧めしません。変数名も "camelCaps" 方式に従わなければなりません。

冗長であることは歓迎されます。変数名は実際の言葉と同じくらい冗長であるべきです。 "$i" や "$n" などの短すぎる名前は小規模なループを除いて嫌われます。ループが 20 行以上にわたる場合、より説明的な名前の変数が求められます。

原則としてグローバルスコープでの変数定義は認められません。 global キーワードやスーパーグローバル変数 $GLOBALS を使用してアクセスすることも禁止します。

定数

定数は英数字とアンダースコアの両方が許容されます。アルファベットはすべて大文字でなければなりません。可読性のために、単語はアンダースコアで区切られていなければなりません。

定数はクラスメンバとして "const" によって定義されなければなりません。原則として "define" によるグローバルスコープでの定義は認められません。

レコードのカラム

すべてのカラムは小文字で構成されなければならず、複数の語からなる単語でアンダースコアを用いることが推奨されます。

外部キーは [テーブル名]_[カラム名] というフォーマットでなければなりません。

オプションやパラメータ

しばしば配列のキーとして登場するオプションやパラメータは、小文字とアンダースコアを用いなければなりません。

ファイル名

すべてのファイルにおいて、使用可能な文字は英数字、アンダースコア、ダッシュ文字 ("-") のみです。空白文字は使用できません。

PHP コードを含むすべてのファイルの拡張子は ".php" でなければなりません。またファイルがクラスかインターフェースを含む場合は ".class.php" で終わらなければなりませんが、モデルスクリプトは例外です。

プラグイン

すべての OpenPNE プラグインの名前はキャメルケースであり、 "op" ではじまり "Plugin" で終わらなければなりません。

プラグインが認証のためのものであるならば、プラグイン名には "Auth" という語を含むべきです。

PHP コードの境界

PHP コードは常に完全な標準 PHP タグによって区切られなければならず、省略形 ("<? ?>" や "<?= ?>") は認められません。PHP コードのみからなるファイルでは、終了タグは決して含めてはいけません。

文字列

$newString = $string.' is good.';
$newString = sprintf('%s is good.', $string);

$openpne = 'OpenPNE'.' is '.' a '.' SNS '.' Engine.';

$sql = "SELECT id, name FROM user "
     . "WHERE name = ? "
     . "ORDER BY name ASC";

配列

$sampleArray = array('OpenPNE', 'SNS', 1, 2, 3);

$sampleArray = array(
  1, 2, 3,
  $a, $b, $c,
  56.44, $d, 500,
);

$sampleArray = array(
  'first'  => 'firstValue',
  'second' => 'secondValue',
);

クラス

開始波括弧は常にクラス名の下に置かれなければなりません。

すべてのクラスは PHPDocumentor 形式のドキュメントブロックを有していなければなりません。

すべての条件を満たすクラス定義は以下の通りです:

/**
 * Documentation here
 */
 class opSampleClass
 {
   // entire content of class
   // must be indented 2 spaces
 }

関数およびメソッド

/**
 * Documentation Block Here
 */
 class Foo
 {
  /**
   * Documentation Block Here
   */
   public function bar()
   {
     // entire content of function
     // must be indented 2 spaces
   }
 }

public function isBar()
{
  $flag = true;

  if ($flag)
  {
    $this->someThingToDo();

    return $flag;
  }

  return false;
}

プロパティ

プロパティを宣言する際には、常に private, protected, public のいずれかの修飾子を用いてアクセス範囲を指定しなければなりません。

制御構造

制御構造では条件を指定する括弧の前に空白をひとつ入れなければなりません。

開始の波括弧は常に条件文の次の行に書かれます。終了の波括弧は常に改行して独立して記述されます。波括弧の中では空白 2 文字でインデントをおこないます。

条件文の開始の括弧の直後や終了の括弧の直前にはスペースを入れてはなりません:

if ($foo == 1)
{
  // body
}
elseif ($foo == 2)
{
  // body
}
else
{
  // body
}

PHP では場合によっては、これらの文で波括弧が必要ないこともあります。 しかし、このコーディング規約では、このような例外を認めません。 "if"、"elseif" あるいは "else" 文では、常に波括弧を使用しなければなりません。

"switch" 文の中身は、空白 2 文字の字下げを使用します。 各 "case" 文の中身は、さらに 2 文字ぶん字下げします:

switch ($case)
{
  case 1:
    break;
  default:
    break;
}

switch 文の default は、 決して省略してはいけません。

コメント

C 言語形式のコメント (/* */) と標準 C++ コメント (//) のどちらも使用可能です。 Perl/shell 形式のコメント (#) は使用するべきではありません。

すべての標準 C++ コメントはスペースからはじまるべきです。

変数のチェック

変数が null かどうかを用いる場合は is_null() 関数を用いてください:

if (is_null($var))
{
  echo '$var is null.';
}

変数と値を比較する際は最初に値を置き、場合によっては型チェックもおこなってください:

if (1 === $var)

スーパーグローバル変数

スーパーグローバル変数に直接アクセスすることは避け、できるだけラッパー経由でアクセスするようにしてください。

たとえば、 $_REQUEST であれば sfWebRequest (およびその派生クラス) が、 $_SESSION であれば sfUser (およびその派生クラス) がラッパーとしての機能を提供しています。

インラインドキュメント

/**
 * Short description for class
 *
 * @package OpenPNE
 * @author  John Smith <jsmith@example.com>
 */