Penamaan Variabel Laravel merupakan salah satu hal yang perlu diperhatikan. Dalam pembuatan program, yang perlu diperhatikan adalah konsistensi dalam pembuatan nama literal, variabel maupun konstanta, termasuk juga penamaan fungsi atau method. Programmer dalam memulai bekerja dalam team harus menyepakati bagaimana memberikan nama pada masing-masing bagian dari program tersebut. Apabila memungkinkan, penggunaan penamaan yang sesuai dengan kesepakatan dari komunitas juga akan membantu pengembangan project, terutama apabila bersifat open source.
Berikut adalah kesepakatan pemberian nama Laravel dari komunitas untuk penamaan pada project web development, yang dikembangkan berdasarkan PSR standards:
Ketentuan | Good | Bad | |
---|---|---|---|
Controller | singular | ArticleController | |
Route | plural | articles/1 | |
Named route | snake_case with dot notation | users.show_active | |
Model | singular | User | |
hasOne or belongsTo relationship | singular | articleComment | |
All other relationships | plural | articleComments | |
Table | plural | article_comments | |
Pivot table | singular model names in alphabetical order | article_user | |
Table column | snake_case without model name | meta_title | |
Model property | snake_case | $model->created_at | |
Foreign key | singular model name with _id suffix | article_id | |
Primary key | – | id | |
Migration | – | 2017_01_01_000000_create_articles_table | |
Method | camelCase | getAll | |
Method in resource controller | table | store | |
Method in test class | camelCase | testGuestCannotSeeArticle | |
Variable | camelCase | $articlesWithAuthor | |
Collection | descriptive, plural | $activeUsers = User::active()->get() | |
Object | descriptive, singular | $activeUser = User::active()->first() | |
Config and language files index | snake_case | articles_enabled | |
View | kebab-case | show-filtered.blade.php | |
Config | snake_case | google_calendar.php | |
Contract (interface) | adjective or noun | Authenticatable | |
Trait | adjective | Notifiable |
Demikian beberapa penamaan variabel Laravel berdasarkan kesepakatan dari komunitas. Apabila programmer memutuskan menggunakan sistem penamaan yang berbeda, masih diperkenankan, namun sebaiknya konsisten dalam penggunaanya. Penamaan yang berbeda perlu dituangkan dalam dokumentasi pengembangan web agar dapat diikuti oleh seluruh anggota team yang berkolaborasi dalam mengembangkan project tersebut.
Semoga bermanfaat, salam Entrepreneur!
Referensi:
written by: SEW 20191104