新標準PSRに学ぶきれいなPHP

新標準PSRに学ぶ
きれいなPHP

Fukuoka.php / Yusuke Ando (@yando)

福岡でのボランティア急募！

こんな経験はありませんか？


同僚のコードが読みづらい


タブ派とスペース派の凄惨な勢力争い


ネーミングでもめる


コーディング規約が必要！


PEAR Zend

俺々

Symfony CakePHP


たくさんあって
どれがいいかわからない


PSR


PSRはPHP ﬁgが策定した
今風なPHPの
コーディング規約！


www.php-ﬁg.org


豪華なメンバー陣
Nate Abele: Lithium Robert Lemke: FLOW3
Nils Adermann: phpBB Larry Masters: CakePHP, CakePHP 2
Brett Bieber: PEAR, PEAR2 Ryan Parman: Amazon Web Services
Guilherme Blanco: Doctrine, Doctrine2, SDK
et al. Evert Pot: SabreDAV
Jordi Boggiano: Composer, Packagist Fabien Potencier: Symfony, Symfony2
Karma Dordrak: Zikula Andre Romcke: eZ Publish
Paul Dragoonis: PPI, PPI2 Paul Scott: Chisimba, C4
William Durand: Propel, Propel 2 Phil Sturgeon: PyroCMS
Andrew Eddie: Joomla Kris Wallsmith: Assetic, Buzz
Cal Evans: the community at large Matthew Weier O'Phinney: Zend
Larry Garﬁeld: Drupal Framework, Zend Framework 2
Paul M. Jones: Solar Framework, Aura David Zülke: Agavi
Project


PSRとは？

•Proposing a Standards Recommendation
(標準勧告提案)
•PSR-0
オートロードの為のファイル名とクラス名の規約
•PSR-1
共有コードの高レベルな連携性を目的にした規約
•PSR-2
標準化されたコードを目指すスタイルガイド

内容毎にレベル分けがされている

PSR-0
オートロードの為のファイルとクラスの規約


PSR-0

•名前空間はベンダー名から必ず始める
•名前空間の区切りはディレクトリ階層になる
•クラス名内のアンダースコアはディレクトリ階層になる
•名前空間とクラス名に.phpをつけてファイル名とする
•名前空間とクラス名の大文字小文字については不問

PHP5.3と名前空間にスマートに対応


PSR-0の例

対象は名前空間、クラス名、ファイル名のみ


autoloadの実装例

require_once地獄とさようなら

PSR-1
相互に機能を連携させる為の規約


File

•PHPコードは長い <?php ?> タグか <?= ?> を使わなけれ
ばならない。それ以外のタグを使ってはならない
•PHPコードはBOMなしUTF-8を使う
•ファイルはクラスや関数などの定義を行いその他の副作用
があってはならない。または副作用のある処理を行うが定
義と処理を同時に行なってはならない


副作用のダメな例


副作用のセーフな例


名前空間とクラス

•PSR-0に準拠する
•クラス名はStudlyCapsで宣言する
•PHP5.3以降では必ず名前空間を使う

•PHP5.2以前の場合は擬似名前空間を使う


定数、プロパティ、メソッド
•定数は全て大文字記述しアンダースコアで単語を区切る

•プロパティについては敢えて言及していない
StudlyCaps camelCase under_score など
•メソッドは camelCaseで宣言する


PSR-2
標準化されたPHPコードの為の規約


基本

•PSR-1に準拠
•全てのPHPファイルは改行にLFを使わなければならない
•ファイルの末尾は一行の空行で終わらなければならない
•ファイルがPHPのみの場合 ?> は省略せねばならない


Line

•ハードリミットは設けない
•ソフトリミットは120文字で、警告の対象
•行は80文字以内であるべき、越える場合は複数行に分割
•行の末尾に空白を付けてはならない
•可読性の為に空行を加えてもよい
•1行に複数のステートメントがあってはならない


インデント

•インデントはスペース４つ、タブを使ってはならない


キーワード

•キーワードは小文字で記述しなければならない
•true false null は小文字で記述しなければならない


名前空間
•名前空間の定義の後には空行を１行置く
•use宣言は名前空間宣言の後に置く
•宣言ごとに１つづつのuseを使う
•useのブロックの後に空行を１行置く


クラス
•extendsとimplementsはクラス定義と同じ行
•開きブレースは単独の行に、閉じブレースは内容の次の行


プロパティ
•全てのプロパティにアクセス権を設定
•varキーワードは使ってはならない
•１ステートメントに複数のプロパティを含めない
•アンダースコアを前置してアクセス権を表現しない


メソッド
•全てのメソッドにアクセス権を設定
•アンダースコアを前置してアクセス権を表現しない
•メソッド名宣言の後に空白を置かない、括弧の前後にス
ペースを置かない、ブレースは独立した行にする


メソッドの引数
•引数リストのカンマの前に空白を置かない
•カンマの後には空白を１つ置く
•デフォルトのある引数はリストの最後に置く


メソッドの引数２
•引数リストを複数行にしてインデントしてもよい
•その場合は閉じ括弧と開きブレースを同じ行に


abstract ﬁnal static
•abstract ﬁnalアクセス権の前に置く
•staticはアクセス権の後に置く


メソッドと関数の呼出
•メソッド名と括弧の間に空白を置かない
•括弧の後に空白を置かない
•カンマの前に空白を置かないカンマの後に空白を置く
•引数リストを複数行にインデントして分割もできる


制御構造
•キーワードの後に空白を１つ置く
•開き括弧の後と閉じ括弧の前に空白を置かない
•閉じ括弧と開きブレースの間には空白を１つ置く
•メインのブロックは１レベルインデントする
•閉じブレースはメインのブロックの直後


if elseif else
•else elseif とブレースは同じ行
•else ifではなく elseif を使うべき


switch case
•caseはswitchからインデント内容やbreakもインデント
•意図的に何もしないcaseにはコメント


while do while
•特筆事項なし


for foreach


try catch


クロージャ
•function の後に空白を１つ置く useの前後に空白
•開き括弧の後、閉じ括弧の前に空白を置かない
•カンマの前に空白を置かない、カンマの後に空白を置く


クロージャ2
•引数、変数のリストを複数行にしてもよい


その他
•下記の点についてはPSRｰ2はあえて言及していない
•グローバル変数と定数の定義
•関数の定義
•演算と代入
•間の行の配置
•コメントとドキュメントブロック
•クラスのプリフィクスとサフィックス
•ベストプラクティス


おまけ
•PSR-2では著名なプロジェクトへの統計調査が行われた


質問？


新標準PSRに学ぶきれいなPHP

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (19)

More from Yusuke Ando

More from Yusuke Ando (20)

新標準PSRに学ぶきれいなPHP