Previous Next

コーディングスタイル

PHP コードの境界

PHP のコードの区切りには、標準 PHP タグを常に使用しなければなりません。

短いタグは決して使用してはいけません。 PHP コードのみからなるファイルでは、終了タグ ("?>") は決して含めてはいけません (全般 を参照ください)。

文字列

文字列リテラル

文字列がリテラルである (変数の展開などが含まれない) 場合は、アポストロフィあるいは「シングルクォート」 で文字列を囲まなければなりません。

$a = '文字列の例';

アポストロフィを含む文字列リテラル

リテラル文字列自体にアポストロフィが含まれている場合は、 引用符あるいは「ダブルクォート」で文字列を囲んでもかまいません。 特に SQL 文などでこのような場合がよくあるでしょう。

$sql = "SELECT `id`, `name` from `people` "
     . "WHERE `name`='Fred' OR `name`='Susan'";
アポストロフィをエスケープするよりも、上の構文のほうが読みやすくなるのでお勧めです。

変数の展開

変数の展開を行うには、次のような方法を使用します。

$greeting = "こんにちは $name さん。ようこそ!";

$greeting = "こんにちは {$name} さん。ようこそ!";

一貫性を保つため、以下の形式は許可されません。

$greeting = "こんにちは ${name} さん。ようこそ!";

文字列の連結

文字列の連結には "." 演算子を使用しなければなりません。コードを読みやすくするため、 "." 演算子の前後には常にスペースを入れなければなりません。

$company = 'Zend' . ' ' . 'Technologies';

文字列を "." 演算子で連結する際には、コードを読みやすくするために ひとつの文を複数行に分けることもできます。そのような場合は、 2 行目以降の行頭にスペースを入れ、各行の "." 演算子が最初の行の "=" 演算子と同じ位置にくるようにしなければなりません。

$sql = "SELECT `id`, `name` FROM `people` "
     . "WHERE `name` = 'Susan' "
     . "ORDER BY `name` ASC ";

配列

数値添字の配列

添字として負の数を使用してはいけません。

数値添字の配列の添字は、0 以上の任意の数から始めることができます。 しかし、常に 0 から始めるようにすることを推奨します。

Array を使用して数値添字の配列を宣言する場合は、 コードを読みやすくするため、 要素を区切るカンマの後にスペースを入れなければなりません。

$sampleArray = array(1, 2, 3, 'Zend', 'Studio');

"array" を使用して、複数行にまたがる配列を宣言することも可能です。 その場合は、2 行目以降の行頭にスペースを入れ、 各行の開始位置が以下のようになるようにしなければなりません。

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

連想配列

連想配列を Array で宣言する場合には、 適宜改行をいれて複数行で宣言するようにしましょう。その場合は、 2 行目以降の行頭などにスペースを入れ、 キーと値の位置がそれぞれ揃うようにしなければなりません。

$sampleArray = array('firstKey'  => 'firstValue',
                     'secondKey' => 'secondValue');

クラス

クラス宣言

クラス宣言は、以下の Zend Framework 命名規約に従わなければなりません。

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

PHPDocumentor の標準形式のドキュメントブロックがなければなりません。

クラス内のコードは、すべて空白 4 文字で字下げします。

ひとつの PHP ファイルにはクラス定義をひとつだけ含めるようにします。

クラスファイルの中にクラス以外のコードを追加することもできますが、 お勧めしません。このような場合には、クラス定義とその他のコードの間に 空行を 2 行挿入しなければなりません。

これらの条件を満たすクラス宣言の例です。

/**
 * これがドキュメントブロックです
 */
class SampleClass
{
    // クラスのすべての内容は、
    // 空白 4 文字の字下げを使用します。
}

クラスのメンバ変数

メンバ変数は、以下の Zend Framework 変数命名規約に従わなければなりません。

クラスの内部で使用する変数は、クラスの先頭 (あらゆるメソッド宣言より前) で宣言する必要があります。

var 構文を使ってはいけません。メンバ変数を宣言する際には privateprotected あるいは public のいずれかの修飾子を用いてアクセス範囲を指定します。 メンバ変数を public 宣言して外部からアクセスさせることもできますが、 それよりはアクセサメソッド (set/get) を使用する方式のほうを推奨します。

関数およびメソッド

関数およびメソッドの宣言

関数は、以下の Zend Framework 関数命名規約に従わなければなりません。

クラス内でメソッドを宣言する際には、常に privateprotected あるいは public のいずれかの修飾子を用いてアクセス範囲を指定しなければなりません。

クラスと同様、波括弧は関数名の次の行に書かなければなりません。 関数名と引数定義用の開始括弧の間にはスペースを入れてはいけません。

グローバルスコープの関数は、できるだけ使わないようにしましょう。

クラス内の関数宣言の例として適切なものを次に示します。

/**
 * これがドキュメントブロックです
 */
class Foo
{
    /**
     * これがドキュメントブロックです
     */
    public function bar()
    {
        // 関数のすべての内容は、
        // 空白 4 文字の字下げを使用します。
    }
}

注意: 値の参照渡しは、メソッドの宣言時にパラメータを渡す部分においてのみ可能です。

/**
 * これがドキュメントブロックです
 */
class Foo
{
    /**
     * これがドキュメントブロックです
     */
    public function bar(&$baz)
    {}
}

実行時の参照渡しは禁止されています。

返り値は括弧で囲んではいけません。これは可読性を下げますし、 将来そのメソッドが参照を返すようになった場合にコードが壊れてしまいます。

/**
 * これがドキュメントブロックです
 */
class Foo
{
    /**
     * 間違いです
     */
    public function bar()
    {
        return($this->bar);
    }

    /**
     * 正しい形式です
     */
    public function bar()
    {
        return $this->bar;
    }
}

関数およびメソッドの使用法

関数の引数を指定する際は、引数を区切るカンマの後に空白をひとつ入れます。 例えば 3 つの引数を受け取る関数をコールする場合の例は、 以下のようになります。

threeArguments(1, 2, 3);

コール時に引数を参照渡しすることは禁じます。 関数への引数を参照渡しにする方法は、 関数宣言についての節を参照ください。

引数として配列を受け取る関数については、関数コールの中に "array" 構文を含め、それを複数行に分けることもできます。 そのような場合の記述法は、以下のようになります。

threeArguments(array(1, 2, 3), 2, 3);

threeArguments(array(1, 2, 3, 'Zend', 'Studio',
                     $a, $b, $c,
                     56.44, $d, 500), 2, 3);

制御構造

If/Else/Elseif

if および elseif 系の制御構造では、 条件を指定する括弧の前に空白をひとつ入れなければなりません。 また、条件指定の括弧を閉じた後にも空白をひとつ入れなければなりません。

括弧で囲まれた条件文の中では、演算子の前後にも空白をいれなければなりません。 また、条件の論理的な区切りを明確にするため、 条件文の中でも積極的に括弧を使用することを推奨します。

開始波括弧は、条件文と同じ行に記述します。 終了波括弧は、常に改行してそれのみで記述します。 波括弧の中では、空白 4 文字の字下げを使用します。

if ($a != 2) {
    $a = 2;
}

"elseif" あるいは "else" を含む "if" 文の場合の決まりは、通常の "if" と同じです。 次の例は、"if" 文に "else" や "elseif" が含まれる場合のものです。

if ($a != 2) {
    $a = 2;
} else {
    $a = 7;
}

if ($a != 2) {
    $a = 2;
} elseif ($a == 3) {
    $a = 4;
} else {
    $a = 7;
}
場合によっては、これらの文で波括弧が必要ない場合もあります。 しかし、このコーディング規約では、このような例外を認めません。 "if"、"elseif" あるいは "else" 文では、常に波括弧を使用しなければなりません。

"elseif" を使用することは可能ですが、推奨されません。代わりに "else if" を使用してください。

Switch

"switch" を使用した制御文では、 条件を指定する括弧の前に空白をひとつ入れなければなりません。 また、条件指定の括弧を閉じた後にも空白をひとつ入れなければなりません。

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

switch ($numPeople) {
    case 1:
        break;

    case 2:
        break;

    default:
        break;
}

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

注意:case の最後に breakreturn を記述せず、意図的に 次の case に処理を流すという書き方をする場合もあるでしょう。 これらの場合を単なる記述漏れと区別するために、case 文で break あるいは return を指定しなかった場合は "// break intentionally omitted" (訳注:「意図的に break を省略しました」) というコメントを含めるようにします。

インラインドキュメント

ドキュメントの書式

ドキュメントブロック ("docblocks") は、phpDocumentor と互換性のある書式でなければなりません。 phpDocumentor の書式については、このドキュメントの対象範囲外です。 詳細な情報は » http://phpdoc.org/ を参照ください。

Zend Framework のために書かれたコード、あるいはフレームワーク上で操作するコードは、 各ファイルの最初に「ファイルレベル」の docblock、 そして各クラスの直前に「クラスレベル」の docblock を含めなければなりません。以下に docblock の例を示します。

ファイル

PHP コードを含むすべてのファイルは、最低限これらの phpDocumentor タグを含むドキュメントブロックを、 ファイルの先頭に記述しなければなりません。

/**
 * ファイルについての短い説明
 *
 * ファイルについての長い説明 (もしあれば)...
 *
 * LICENSE: ライセンスに関する情報
 *
 * @copyright  2008 Zend Technologies
 * @license    http://framework.zend.com/license   BSD License
 * @version    $Id:$
 * @link       http://framework.zend.com/package/PackageName
 * @since      File available since Release 1.5.0
*/

クラス

各クラスには、最低限これらの phpDocumentor タグを含む docblock が必要です。

/**
 * クラスについての短い説明
 *
 * クラスについての長い説明 (もしあれば)...
 *
 * @copyright  2008 Zend Technologies
 * @license    http://framework.zend.com/license   BSD License
 * @version    Release: @package_version@
 * @link       http://framework.zend.com/package/PackageName
 * @since      Class available since Release 1.5.0
 * @deprecated Class deprecated in Release 2.0.0
 */

関数

オブジェクトのメソッドを含めたすべての関数には、 最低限以下の内容を含む docblock が必要です。

  • 関数についての説明

  • すべての引数

  • 返り値

"@access" タグは必要ありません。なぜなら、 アクセスレベルについては関数宣言の際の "public"、"private" あるいは "protected" によってわかっているからです。

関数/メソッドが例外をスローする場合には、すべての既知の例外クラスに対して @throws を使用します。

@throws exceptionclass [description]

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server
Zend_Application
導入
Zend_Application Quick Start
Theory of Operation
Examples
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGeneratorリファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Zend_File_Transfer 用のバリデータ
Filters for Zend_File_Transfer
以前のバージョンからの移行
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
サポートするロケール
以前のバージョンからの移行
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Introduction
画面
Containers
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDLアクセッサ
自動検出
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project導入
Create A Project
Zend Tool Project Providers
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
以前のバージョンからの移行
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
検証メッセージ
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
以前のバージョンからの移行
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
導入
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework Performance Guide
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報