DEV Community

TMC
TMC

Posted on

Convenciones de nombre... ¿Como debo de nombrar o llamar las "cosas" en Laravel?

Alt Text

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
Enter fullscreen mode Exit fullscreen mode

🚫

Users, blogsPost, product, product_categories
Enter fullscreen mode Exit fullscreen mode

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
Enter fullscreen mode Exit fullscreen mode

🚫

$this->updatedAt, $this->Email, $this->ProductName
Enter fullscreen mode Exit fullscreen mode

¿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()
Enter fullscreen mode Exit fullscreen mode

🚫

public function Index(), public function get_user_by_email()
Enter fullscreen mode Exit fullscreen mode

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
Enter fullscreen mode Exit fullscreen mode

🚫

userController, blog_controller, productController, auth_Controlle.
Enter fullscreen mode Exit fullscreen mode

¿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
Enter fullscreen mode Exit fullscreen mode

🚫

Users, blog, failedJobs
Enter fullscreen mode Exit fullscreen mode

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 
Enter fullscreen mode Exit fullscreen mode

🚫

postUser, BlogCategory, product_category
Enter fullscreen mode Exit fullscreen mode

Discussion (0)