Lavarel Naming Conventions

Nguyen Thanh Dat

• 1 min read

Lavarel Naming Conventions:

  • Controller: 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 từ
    "Controller" (BlogController, AuthController...)
    Method naming conventions in controllers: GET, POST, POST, PUT, PATCH, DELETE
  • Tên bảng CSDL: 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ừ cuối phải ở dạng số nhiều (post, uploaded_images...)
  • Pivot tables: chữ thường, được phân tách bằng dấu gạch dưới(post_user, task_user)
  • Table columns names: dấu gạch dưới giữa các từ, viết thường(post_body, id, created_at)
  • Primary Key: id
  • Foreign Keys: số ít, với '_id' được thêm vào nó (comment_id, user_id)
  • Variables: Các biến thông thường thường phải ở dạng camelCase($users, $bannedUsers)
  • Naming Models in Laravel: ở dạng số ít, không có khoảng cách giữa các từ và được viết hoa(ForumThread, Comment)
  • Model properties: dấu gạch dưới giữa các từ, viết thường($this->updated_at, $this->title)
  • Model Methods:ở dạng camelCase(public function getAll())
  • Relationships:
  • hasOne or belongsTo relationship (one to many): ở dạng camelCase(public function postAuthor())
  • hasMany, belongsToMany, hasManyThrough (one to many): phải ở dạng số nhiều (public function comments())
  • Traits: Nên là tính từ(Notifiable, Dispatchable)
  • Blade view files: viết thường, có dấu gạch dưới phân tách các từ(all.blade.php, all_posts.blade.php)