2-convenciones nombrar variable

 En Laravel, existen convenciones y buenas prácticas para nombrar controladores, modelos, métodos, variables y tablas de la base de datos. Estas convenciones ayudan a mantener la consistencia en el código y aprovechar al máximo las características de Laravel, como la inyección de dependencias y el ORM Eloquent.

1. Controladores

  • Nombre de clase: PascalCase (primera letra en mayúscula) y singular.

  • Sufijo: Controller (ej: UserController, PostController).

  • Ubicación: app/Http/Controllers/.

  • Métodos: camelCase (ej: index, store, getUserPosts).

Ejemplo:

php
Copy
Download
// app/Http/Controllers/UserController.php
namespace App\Http\Controllers;

class UserController extends Controller {
    public function showUserProfile($id) {
        // Lógica
    }
}

Rutas asociadas (en routes/web.php o routes/api.php):

php
Copy
Download
Route::get('/user/{id}', [UserController::class, 'showUserProfile']);

2. Modelos

  • Nombre de clase: PascalCase y singular (representa una entidad única).

  • Relación con la tabla: Por defecto, Laravel asume que el nombre de la tabla es el plural snake_case del modelo (ej: User → users, BlogPost → blog_posts).

  • Ubicación: app/Models/ (aunque en versiones antiguas estaba en app/).

Ejemplo:

php
Copy
Download
// app/Models/User.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model {
    // Por defecto, asume que la tabla es 'users'
    protected $fillable = ['name', 'email']; // Campos asignables masivamente
}

Para definir una tabla manualmente:

php
Copy
Download
protected $table = 'mis_usuarios'; // Si la tabla no sigue la convención

3. Métodos (en clases)

  • camelCase: Para métodos públicos y privados.

  • Verbos claros: Usar get, create, update, delete, etc., según la acción.

Ejemplo:

php
Copy
Download
public function getUserById($id) { ... }
public function calculateTotal() { ... }
private function validateData() { ... }

4. Variables

  • camelCase: Para variables locales y propiedades de clase.

  • Descriptivas: Evitar abreviaturas ambiguas.

Ejemplo:

php
Copy
Download
$userCount = 10;
$isAdmin = true;
$postTitle = 'Laravel Conventions';

5. Tablas de Base de Datos

  • snake_case: Minúsculas y separadas por guiones bajos.

  • Plural: Representan una colección de registros (ej: users, post_comments).

  • Claves foráneas: singular_id (ej: user_id, post_id).

Ejemplo de migración:

php
Copy
Download
Schema::create('post_comments', function (Blueprint $table) {
    $table->id();
    $table->foreignId('post_id')->constrained(); // Clave foránea
    $table->string('comment_text');
    $table->timestamps();
});

6. Relaciones en Eloquent

Los métodos de relación en los modelos también usan camelCase y suelen ser descriptivos:

Ejemplo:

php
Copy
Download
// En app/Models/User.php
public function posts() {
    return $this->hasMany(Post::class); // Relación 1 a muchos
}

// En app/Models/Post.php
public function author() {
    return $this->belongsTo(User::class, 'user_id'); // Relación inversa
}

7. Convenciones adicionales

  • Archivos de configuración: snake_case (ej: config/database.php).

  • Vistas: kebab-case (ej: resources/views/user-profile.blade.php).

  • Traits: PascalCase con sufijo Trait (opcional, ej: NotifiableTrait).

Resumen de convenciones

ElementoConvenciónEjemplo
ControladoresPascalCase + ControllerUserController
ModelosPascalCase (singular)Post, UserProfile
MétodoscamelCasegetUserById
VariablescamelCasepostCount
Tablas BDsnake_case (plural)post_comments
Claves foráneassnake_case (singular_id)user_id

Estas convenciones permiten que Laravel funcione con "magia" (como el autoenlace entre modelos y tablas), pero siempre puedes sobrescribirlas si es necesario.

Comentarios

Publicar un comentario

Entradas más populares de este blog

8-Creación de una API RESTful con Laravel

  Creación de una API RESTful con Laravel En este tutorial, te guiaré paso a paso para crear una API RESTful básica con Laravel, incluyendo autenticación, rutas, controladores y migraciones. Requisitos previos PHP ≥ 8.1 Composer instalado Laravel instalado globalmente Conocimientos básicos de PHP y Laravel Base de datos configurada (MySQL, PostgreSQL, SQLite, etc.) Paso 1: Crear un nuevo proyecto Laravel bash laravel nuevo mi-api-laravel # O usando composer composer create-project laravel/laravel mi-api-laravel Accede al directorio del proyecto: bash cd mi-api-laravel Paso 2: Configurar la base de datos Abre el archivo  .env  y configura las credenciales de tu base de datos: env DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=mi_api_laravel DB_USERNAME=root DB_PASSWORD= Paso 3: Crear un modelo con migración, controlador y factory Vamos a crear un modelo  Producto  como ejemplo: bash php artisan make:model Producto -mcr Esto creará: Un modelo ( ...
Leer más

02 -Rutas en Laravel

  Rutas en Laravel: Explicación y Ejemplos Las rutas en Laravel son el mecanismo que permite definir cómo responde tu aplicación a las solicitudes HTTP entrantes. Todas las rutas de Laravel se definen en los archivos dentro del directorio  routes/ . Tipos básicos de rutas 1. Rutas básicas php Copy Download Route :: get ( '/saludo' , function ( ) { return '¡Hola Mundo!' ; } ) ; Cuando se visita  /saludo  en el navegador, se mostrará "¡Hola Mundo!". 2. Rutas con parámetros php Copy Download Route :: get ( '/usuario/{id}' , function ( $id ) { return 'Usuario ' . $id ; } ) ; Esta ruta capturará el ID de la URL y lo pasará a la función. 3. Rutas con parámetros opcionales php Copy Download Route :: get ( '/post/{titulo?}' , function ( $titulo = 'Título por defecto' ) { return $titulo ; } ) ; El parámetro  titulo  es opcional y tiene un valor por defecto. 4. Rutas con restricciones php Copy Download Rout...
Leer más

3-Rutas

  Rutas en Laravel: Explicación y Ejemplos Las rutas en Laravel son el mecanismo que permite definir cómo responde tu aplicación a las solicitudes HTTP entrantes. Todas las rutas de Laravel se definen en los archivos dentro del directorio  routes/ . 2. Rutas con parámetros php Copy Download Route :: get ( '/usuario/{id}' , function ( $id ) { return 'Usuario ' . $id ; } ) ; Esta ruta capturará el ID de la URL y lo pasará a la función. 3. Rutas con parámetros opcionales php Copy Download Route :: get ( '/post/{titulo?}' , function ( $titulo = 'Título por defecto' ) { return $titulo ; } ) ; El parámetro  titulo  es opcional y tiene un valor por defecto. 5. Rutas con nombre php Copy Download Route :: get ( '/perfil' , function ( ) { // ... } ) -> name ( 'perfil' ) ; Puedes generar URLs a esta ruta usando  route('perfil') . Rutas hacia controladores php Copy Download Route :: get ( '/productos'...
Leer más