Convenciones de nombre... ¿Como debo de nombrar o llamar las "cosas" en Laravel?
TMC
Posted on May 28, 2021
Partiendo de estas cuatro convenciones de nombres más utilizadas en la programación, las cuales son:
🐪 camelCase
🍢 kebab-case
👨🏼🏫 PascalCase
🐍 snake_case
¿Cómo llamar a los Modelos?
En Laravel los modelos debe llamarse en singular, sin espacios entre las palabras y utilizando la estrategia de combinación de palabras llamada "PascalCase".
✅
User, BlogPost, Product, ProductCategory
🚫
Users, blogsPost, product, product_categories
Tip importante: Procurar utilizar nombres en ingles para llamar las cosas y de esta manera aseguras que tu código va poder ser comprendido con mayor facilidad por otros desarrolladores.
¿Cómo llamar a las propiedades en los Modelos?
Estas debemos llamarlas en minúsculas y "snake_case", simplemente debemos seguir la convención que existe en las columnas de la base de datos. Por ejemplo:
✅
$this->updated_at, $this->email, $this->name
🚫
$this->updatedAt, $this->Email, $this->ProductName
¿Cómo llamar los métodos utilizados en los modelos?
Todos los métodos que creemos en nuestro proyecto dentro de Laravel, debemos de llamarlos utilizando la convención camelCase. Por ejemplo:
✅
public function index(), public function getUserByEmail()
🚫
public function Index(), public function get_user_by_email()
Tip importante: Dentro de los tests, debemos llamar a los métodos utilizando la convención "snake_case";
¿Cómo llamar a los controladores?
Los controladores que creemos en Laravel deben de ser singulares, con la convención "PascalCase" y terminar con la palabra "Controller".
✅
UserController, ProductController, BlogController
🚫
userController, blog_controller, productController, auth_Controlle.
¿Cómo nombrar las tablas de las bases de datos?
Las tablas de la base de datos deben de ser nombradas en plural y utilizando la convención "sanke_case".
✅
users, categories, failed_jobs
🚫
Users, blog, failedJobs
Caso para las tablas pivote:
Las tablas pivotes deben de nombrarse en singular, alfabeticamente según cada modelo que se utilice y utilizando la convención "snake_case".
✅
post_user, blog_category, category_product
🚫
postUser, BlogCategory, product_category
Posted on May 28, 2021
Join Our Newsletter. No Spam, Only the good stuff.
Sign up to receive the latest update from our blog.
Related
August 28, 2024