Rule - opensource-workshop/connect-cms GitHub Wiki

プログラミング時のルール

PHPのコーディングルール

  • PSR-2を基に下記表のルールを準拠します。
    • 参考:PSR-2 コーディングガイド ( ja / en )
  • phpcsページ記載のコマンドでコーディングルールをチェックできます。
ルール PHP_CodeSniffer設定
1行の長さ制限なし Generic.Files.LineLength.TooLong ルールを外す
constは小文字でOK Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase ルールを外す
開きカッコ・閉じカッコ前後の空行OK Squiz.WhiteSpace.ControlStructureSpacing.SpacingAfterOpen
Squiz.WhiteSpace.ControlStructureSpacing.SpacingBeforeClose ルールを外す
メソッド呼び出しの引数は1行の中に複数記述してOK PSR2.Methods.FunctionCallSignature,allowMultipleArguments,trueにルール変更

インデント

ソースのインデントはスペース4つで統一します。

クラスの命名規則

頭大文字のキャメル(らくだのこぶ)型

例)
app/Plugins/User/Blogs/BlogsPlugin.php

class BlogsPlugin extends UserPluginBase

functionの命名規則

頭小文字のキャメル(らくだのこぶ)型

例)

    public function getPublicFunctions()

変数の命名規則

スネーク型

        $role_ckeck_table = array();

CSSの命名規則

CSS名のつなぎはハイフンで統一します。

例)
public/css/connect.css

bladeの命名規則

初めわかんなくって、古めパターンで命名。
最新、新しい目パターンで対応できる事わかって、それで対応。

⚠️ **GitHub.com Fallback** ⚠️