CakePHP Coding Convention

Bộ quy tắc này được quy ước riêng cho các dự án sử dụng CakePHP Framework.

1. Khái quát chung

Code phải tuân theo PSR-1 và PSR-2
Tên variable đặt dưới dạng camelCase
Việc đặt tên method, variable có thêm dấu gạch dưới _ để phân biệt tính visibility của method, variable
Các tag nên sử dụng trong DocBlocks
Tên file trong trường hợp không chứa class

Tên biến được đặt dưới dạng camelCase và phải là cụm từ có ý nghĩa

Các public method, variable đặt tên bình thường

<?php
class Foo extends Bar
{
    public $publicVar;

    public function publicFunction()
    {
    }
}

Các protected method, variable có tên bắt đầu bằng một dấu gạch dưới _

<?php
class Foo extends Bar
{
    protected $_protectedVar;

    protected function _protectedFunction()
    {
    }
}

Các private method, variable có tên bắt đầu bằng hai dấu gạch dưới _

<?php
class Foo extends Bar
{
    private $__privateVar;

    private function __privateFunction()
    {
    }
}

DocBLocks của class, method, property may nên chứa các tag theo tài liệu của phpDocumentor

@version: Version hiện tại.
@deprecated: Cho biết các thành phần nằm trong kế hoạch lược bỏ ở các version tiếp theo.
@internal: Chỉ ra các yếu tố liên kết nội bộ như là các thư viện, các đoạn mã hoặc là các tài liệu chỉ dẫn cho người phát triển.
@link: Chỉ ra các địa chỉ web liên kết.
@param: Các tham số đầu vào
@return: Các giá trị trả về, đầu ra
@throws: Chỉ ra các hành vi khi xảy ra trường hợp ngoại lệ
@see: Chỉ ra các yếu tố kế thừa hoặc override.
@uses: Chỉ ra các yêu tố cấu thành trực tiếp.
@property: Cho biết có sử dụng một thành phần nào đó.
@license: Thông tin về bản quyền

Tên file trong trường hợp không chứa class nên được đặt dưới dạng string_lower_with_underscore.php