基本的には、 PSR-12 coding style guide および、 CakePHP コーディング規約 - 4.x に従って頂くものとし、下記のルールにも従います。
各ファイルの最上位に記述します。
/**
* baserCMS : Based Website Development Project <https://basercms.net>
* Copyright (c) NPO baser foundation <https://baserfoundation.org/>
*
* @copyright Copyright (c) NPO baser foundation
* @link https://basercms.net baserCMS Project
* @license https://basercms.net/about/license MIT License
*/
クラスの先頭にはクラスヘッダーをつけます。
/**
* Class SitesController
*/
class SitesController extends BcAdminAppController {}
メソッドの先頭にはメソッドヘッダーをつけます。
/**
* サイト一覧を表示する
*
* @param SiteManageServiceInterface $siteManage
* @checked
* @noTodo
* @unitTest
*/
public function index(SiteManageServiceInterface $siteManage){}
メソッドとメソッドの間では1行の空行を入れます。
ロウワーキャメルケースとします。
オブジェクトのプロパティ名のみ、アッパーキャメルケースとし、その他の変数は全てロウワーキャメルケースとします。
class UsersController extends AppController
{
public $Users;
private $user;
protected function getStatus()
{
$user = $this->Users->find()->first();
return $user->status;
}
}