コーディング規約 > PHPのコーディング規約

PHPのコーディング規約

SetucoCMSのコーディングをする時は、このPHPのコーディング規約に沿ってコーディングしてください。

SetucoCMSはZend Frameworkを使用して開発しています。
Zend Frameworkを採用した理由につきましては、当プロジェクトブログのSetucoCMSで採用したフレームワークの記事を参照してください。

PHPのコーディング規約は、Zend FrameworkのZend Framework PHP 標準コーディング規約を参考にしています。

Outline

1. コーディング規約の詳細
2. コーディング規約の主要なもの
   1. PHPファイルのフォーマット
   2. PHPの命名規約
   3. PHPのソースコードのレイアウト

コーディング規約の詳細

コーディング規約の詳細につきましては、以下のページを参照してください。

• PHPファイル全体のフォーマットの詳細
• PHPの命名規約の詳細
• PHPのソースコードのレイアウトの詳細

コーディング規約の主要なもの

コーディング規約の主要なものにつきましては、以下の項目を参照してください。

PHPファイルのフォーマット

• PHPの開始タグは、必ず標準の <?php を使用してください
• エラーを防ぐために、PHPだけのファイルはPHPの綴じタグは決して含めないでください
• インデントは、スペース4文字にしてください
• 文字コードはUTF-8にしてください (DBなどもUTF-8にしてください)
• ファイルの行末はLF(ラインフィード)にしてください (LinuxなどのUnix系OSの改行コードです)

PHPファイルのフォーマットについての詳細につきましては、 PHPファイル全体のフォーマット を参照してください。

PHPの命名規約

• 命名規則は、Zend Framework PHP 標準コーディング規約を元にしています
• クラス名のプレフィックス(接頭辞)には、 Setuco_ を先頭につけてください ( Setuco_Controller_Plugin の形式になります)
• Interfaceは、必ず命名規則に従ってInterface名をつけてください
• AbstractクラスやInterfaceの命名規則は、Setuco_Controller_PluginAbstract、Setuco_Controller_PluginInterfaceの形式にしてください

命名規約の詳細につきましては、 PHPの命名規約 を参照してください。

PHPのソースコードのレイアウト

• If文などの制御構造のレイアウト(書き方)は必ずコーディング規約に従ってください (詳しくは、制御構造のレイアウトを参照してください)
• PHPDocumentorに従って、インラインドキュメントやドキュメントブロックを必ず書いてください
• Viewファイル（スクリプトファイル)の制御構造(if文など)のブロックはコロン形式で書いてください　(詳しくは、Viewファイルのレイアウトを参照してください)
• HTMLの出力は、<?= ?>ではなく、必ず<?php echo ?>で出力してください
• インラインドキュメントは必ず決まった形式で、記入してください。(詳しくは、 インラインドキュメントの詳細を参照してください)

PHPのソースコードのレイアウトの詳細につきましては、 PHPのソースコードのレイアウト を参照してください。