Naming
Naming classes, variables database tables or anything as a developer is always the hardes part.
Naming a class, model, controller, service, repository should always be a noun. The key thing to understand is that a class represents a blue print or the template for the object.
Controllers
Controllers should be in PascalCase/CapitalCase.
They should be in singular case, no spacing between words, and end with "Controller".
Also, each word should be capitalised (i.e. BlogController, not blogcontroller).
// Controller
class UserController {
}
Database Tables
Tables
DB tables should be in lower case, with underscores to separate words (snake_case), and should be in plural form.
posts, project_tasks, uploaded_images
Pivot Tables
Pivot tables should be all lower case, each model in alphabetical order, separated by an underscore (snake_case).
post_user, task_user
Columns names
Table column names should be in snake_case (underscores between words) - in lower case. You shouldn't reference the table name.
post_body, id, created_at
Foreign Keys
Foreign keys should be the model name (singular), with '_id' appended to it (assuming the PK in the other table is 'id').
comment_id, user_id
Variables
Normal variables should typically be in camelCase, with the first character lower case.
$users = ..., $bannedUsers = ...
If the variable contains an array or collection of multiple items then the variable name should be in plural. Otherwise, it should be in singular form.
For example: $users = User::all(); (as this will be a collection of multiple User objects), but $user = User::first() (as this is just one object)
Models
A model should be in PascalCase/CapitalCase. They should be in singular, no spacing between words, and capitalised.
\App\Models\User, \App\Models\ForumThread, \App\Models\Comments
Properties
These should be lower case, snake_case. They should also follow the same conventions as the table column names.
$this->updated_at, $this->title
Methods
Methods in your models in Laravel projects, like all methods in your Laravel projects, should be camelCase with the first character lower case.
public function get(), public function getAll()
Relationships
hasOne or belongsTo relationship (one to many)
These should be singular form and follow the same naming conventions of normal model methods (camelCase, with the first letter lower case)
public function postAuthor(), public function phone()
hasMany, belongsToMany, hasManyThrough (one to many)
These should be the same as the one to many naming conventions, however, it should be in plural.
public function comments(), public function roles()
Polymorphic relationships
These can be a bit awkward to get the naming correct.
Ideally, you want to be able to have a method such as this:
public function category()
{
return $this->morphMany('App\Category', 'categoryable');
}
And Laravel will by default assume that there is a categoryable_id and categoryable_type.
But you can use the other optional parameters for morphMany ( public function morphMany($related, $name, $type = null, $id = null, $localKey = null)) to change the defaults.
Controllers
These should follow the same rules as model methods. I.e. camelCase (first character lowercase).
In addition, for normal CRUD operations, they should use one of the following method names.
| Verb | URI | Action | Route Name |
|---|---|---|---|
| GET | /photos | index | photos.index |
| GET | /photos/create | create | photos.create |
| POST | /photos | store | photos.store |
| GET | /photos/{photo} | show | photos.show |
| GET | /photos/{photo}edit | edit | photos.edit |
| PUT/PATCH | /photos/{photo} | update | photos.update |
| DELETE | /photos/{photo} | delete | photos.destroy |
Traits
Traits should be be adjective words.
Notifiable, Dispatchable
Blade
Blade files should be in lower case, snake_case (underscore between words).
all.blade.php, all_posts.blade.php
