Những quy ước đặt tên Laravel
- Đặt tên cho Controllers:
+ Tên Controller phải ở dạng PascalCase/CapitalCase
+ Chúng phải ở dạng số ít, không có khoảng cách giữa các từ và kết thúc bằng "Controller"
+ Ngoài ra thỳ mỗi từ cần phải được viết hoa (VD: BlogController, NewController, ...)
- Đặt tên các bảng dữ liệu trong Laravel
+ Các bảng DB phải ở dạng chữ thường, có dấu gạch dưới để phân tách các từ và phải ở dạng số nhiều.
+ VD: posts, project_tasks, uploaded_images
- Bảng tổng hợp (pivot tables)
+ Các bảng tổng hợp phải là tất cả chữ thường, mỗi mô hình theo thứ tự bảng chữ cái, được phân tách bằng dấu gạch dưới
+ VD: post_user, task_user, ...
- Tên cột trong bảng
+ Tên cột của bảng phải ở dạng solid_case (dấu gạch dưới giữa các từ) - viết thường. Bạn không nên tham khảo tên bảng.
+ VD: id, post_body, create_at, ....
- Khóa chính: thường thỳ sẽ chỉ là id
- Khóa ngoại: phải là tên kiểu máy (số ít), với '_id' được thêm vào nó (giả sử PK trong bảng khác là 'id'). VD: comment_id, user_id
- Biến
+ Các biến thông thường thường phải ở dạng camelCase, với ký tự đầu tiên là chữ thường. VD: $users = ..., $bannedUsers = ..., ...
+ Nếu biến chứa một mảng hoặc tập hợp nhiều mục thì tên biến phải ở dạng số nhiều. Mặt khác, nó phải ở dạng số ít.
VD: $users = User::all() - tập hợp của nhiều đối tượng người dùng
$user = User::first() - đây chỉ là 1 đối tượng
- Quy ước đặt tên cho Model
1. Đặt tên Model trong Laravel
+ Model phải ở trong PascalCase/CapitalCase. Chúng phải ở dạng số ít, không có khoảng cách giữa các từ và được viết hoa.
VD: User( \App\User hoặc \App\Models\User, ...), ForumThread, Comment
2. Thuộc tính Model
+ Đây phải là chữ thường, Snake_case. Chúng cũng phải tuân theo các quy ước giống như tên cột của bảng. VD: $this->updated_at, $this->title, ...
3. Phương thức Model
+ Các phương thức trong các mô hình của bạn trong các dự án Laravel, giống như tất cả các phương thức trong các dự án Laravel của bạn, phải là camelCase với ký tự đầu tiên viết thường. VD: public function get(), public function getAll(), ...
4. Các mối quan hệ
- mối quan hệ hasOne hoặc thuộc về (một đến nhiều)
Đây phải là dạng số ít và tuân theo cùng quy ước đặt tên của các phương thức mô hình thông thường (camelCase, với chữ cái đầu tiên viết thường)
VD: public function postAuthor(), public function phone(), ...
- hasMany, thuộc vềToMany, hasManyThrough (một đến nhiều)
Những cái này phải giống như một trong nhiều quy ước đặt tên, tuy nhiên, nó phải ở dạng số nhiều. VD: public function comments(), public function roles(),...
- mối quan hệ đa hình
- Quy ước đặt tên phương thức trong bộ điều khiển
+ Chúng phải tuân theo các quy tắc giống như các phương pháp mô hình. Tức là camelCase (ký tự đầu tiên viết thường).
+ Đặc điểm nên là tính từ VD: Notifiable, Dispatchable, ...
+ Blade view files: Các tệp phiến phải ở dạng chữ thường, Snake_case (gạch dưới giữa các từ). VD: all.blade.php, all_posts.blade.php, ....
Link tham khảo thêm: https://webdevetc.com/blog/laravel-naming-conventions/