2-Te explico las convenciones de nomenclatura en Laravel:

Controladores

Nombres de Clases (Controladores)

  • Caso: PascalCase

  • Sufijo: Controller

  • Ejemplos:

    • UserController ✅

    • ProductCategoryController ✅

    • Estructura: Sujeto/Objeto (Sustantivo) + Controller

    • user_controller ❌

Convención RESTful

php
// Controlador para manejar productos
class ProductController extends Controller
{
    public function index() {}    // GET /products
    public function create() {}   // GET /products/create
    public function store() {}    // POST /products
    public function show() {}     // GET /products/{id}
    public function edit() {}     // GET /products/{id}/edit
    public function update() {}   // PUT/PATCH /products/{id}
    public function destroy() {}  // DELETE /products/{id}
}

🔧 Métodos

Nombres de Métodos

  • Caso: camelCase

  • Verbo + Sustantivo: Primero el verbo, luego el sustantivo

  • Ejemplos:

    • getUserProfile() ✅

    • updateProductPrice() ✅

    • calculateTotal() ✅

    • UserProfileGet() ❌

Métodos RESTful Comunes

php
public function index() {}      // Listar recursos
public function create() {}     // Mostrar formulario de creación
public function store() {}      // Guardar nuevo recurso
public function show() {}       // Mostrar recurso específico
public function edit() {}       // Mostrar formulario de edición
public function update() {}     // Actualizar recurso
public function destroy() {}    // Eliminar recurso

🗃️ Modelos

Nombres de Modelos

  • Caso: PascalCase

  • Singular: Siempre en singular

  • Ejemplos:

    • User ✅ (tabla: users)

    • Product ✅ (tabla: products)

    • Category ✅ (tabla: categories)

    • Users ❌

Relación con Tablas

php
class User extends Model
{
    // Por defecto busca la tabla 'users'
    protected $table = 'users'; // Opcional si sigue convención
}

class Product extends Model
{
    // Buscará automáticamente la tabla 'products'
}

📊 Variables

Variables Regulares

  • Caso: camelCase

  • Ejemplos:

    • $userName ✅

    • $productList ✅

    • $totalAmount ✅

    • $user_name ❌ (aunque funciona, no sigue convención)

Colecciones y Arrays

php
$users = User::all();          // Colección de usuarios
$user = User::first();         // Usuario individual

$productCategories = [];       // Array de categorías
$activeProducts = Product::where('active', true)->get();

📋 Resumen de Reglas

ElementoCasoSingular/PluralEjemplo
ControladoresPascalCasePlural + ControllerUsersController
ModelosPascalCaseSingularUser
MétodoscamelCase-getUserData()
VariablescamelCaseDepende del contexto$userName
Tablas BDsnake_casePluraluser_profiles
Columnas BDsnake_case-created_at

🎯 Buenas Prácticas

1. Controladores por Recurso

php
// ✅ Correcto
php artisan make:controller ProductController --resource

// ❌ Evitar controladores que hagan de todo
php artisan make:controller MainController

2. Nombres Descriptivos

php
// ✅ Bueno
public function calculateOrderTotal() {}
public function sendWelcomeEmail() {}

// ❌ Malo
public function doSomething() {}
public function process() {}

3. Rutas RESTful

php
// ✅ Convención estándar
Route::resource('products', ProductController::class);

// ✅ Rutas personalizadas con nombres claros
Route::post('products/{id}/activate', [ProductController::class, 'activate'])
     ->name('products.activate');

🔄 Relaciones con Tablas

La magia de Eloquent funciona con estas convenciones:

  • Modelo: User (singular)

  • Tabla: users (plural)

  • Clave primaria: id

  • Claves foráneas: user_id, post_id

php
// Si necesitas personalizar
class User extends Model
{
    protected $table = 'mi_tabla_usuarios'; // Solo si no sigue convención
    protected $primaryKey = 'user_id';      // Solo si no es 'id'
}

Seguir estas convenciones hace tu código más legible y mantenible, y aprovecha todas las funcionalidades automáticas de Laravel.

megusto mucho que indicaras en las convenciones de nomenclatura la estructura Verbo + Sustantivo: Primero el verbo, luego el sustantivo , puedes volver a escribir todo pero indicando tambien en cada momento la regla Verbo + Sustantivo: Primero el verbo, luego el sustantivo

Te explico las convenciones de nomenclatura en Laravel con énfasis en la estructura Verbo + Sustantivo:

📝 Controladores

Nombres de Clases (Controladores)

  • Caso: PascalCase

  • Estructura: Sustantivo (Plural) + Controller

  • Sufijo: Controller

  • Ejemplos:

    • UserController (Maneja usuarios) ✅

    • ProductController (Maneja productos) ✅

    • OrderController (Maneja órdenes) ✅

Convención RESTful (Métodos)

php
class ProductController extends Controller
{
    // VERBO: Listar | SUSTANTIVO: Productos
    public function index() {}    // GET /products
    
    // VERBO: Crear | SUSTANTIVO: Formulario de producto
    public function create() {}   // GET /products/create
    
    // VERBO: Almacenar | SUSTANTIVO: Producto
    public function store() {}    // POST /products
    
    // VERBO: Mostrar | SUSTANTIVO: Producto específico
    public function show() {}     // GET /products/{id}
    
    // VERBO: Editar | SUSTANTIVO: Formulario de producto
    public function edit() {}     // GET /products/{id}/edit
    
    // VERBO: Actualizar | SUSTANTIVO: Producto
    public function update() {}   // PUT/PATCH /products/{id}
    
    // VERBO: Destruir | SUSTANTIVO: Producto
    public function destroy() {}  // DELETE /products/{id}
}

🔧 Métodos Personalizados

Estructura: VERBO + SUSTANTIVO

  • Orden: Primero el verbo, luego el sustantivo

  • Caso: camelCase

  • Ejemplos:

php
// ✅ CORRECTO: Verbo primero, luego sustantivo
public function getUserProfile() {}       // Obtener perfil de usuario
public function updateProductPrice() {}   // Actualizar precio de producto
public function calculateOrderTotal() {}  // Calcular total de orden
public function sendWelcomeEmail() {}     // Enviar email de bienvenida
public function generateSalesReport() {}  // Generar reporte de ventas
public function activateUserAccount() {}  // Activar cuenta de usuario

// ❌ INCORRECTO: Sustantivo primero
public function userProfileGet() {}       // ❌
public function productPriceUpdate() {}   // ❌
public function orderTotalCalculate() {}  // ❌

🗃️ Modelos

Nombres de Modelos

  • Caso: PascalCase

  • Estructura: Sustantivo en Singular

  • Ejemplos:

    • User (Modelo para usuario) ✅

    • Product (Modelo para producto) ✅

    • Category (Modelo para categoría) ✅

php
// VERBO: Definir | SUSTANTIVO: Modelo de Usuario
class User extends Model
{
    // VERBO: Obtener | SUSTANTIVO: Posts del usuario
    public function getUsersPosts() {}
    
    // VERBO: Calcular | SUSTANTIVO: Edad del usuario
    public function calculateUserAge() {}
}

📊 Variables

Variables y Propiedades

  • Caso: camelCase

  • Estructura: Sustantivo descriptivo (a veces con adjetivo)

  • Ejemplos:

php
// ✅ Variables con sustantivos descriptivos
$userName = 'John';          // Nombre de usuario
$productList = [];           // Lista de productos
$totalAmount = 100;          // Monto total
$isActiveUser = true;        // Usuario activo
$hasValidSubscription = false; // Tiene suscripción válida

// ✅ Colecciones (sustantivo en plural)
$activeUsers = User::where('active', true)->get(); // Usuarios activos
$productCategories = Category::all();              // Categorías de productos

📋 Resumen Completo de Reglas

ElementoCasoEstructuraSingular/PluralEjemplo
ControladoresPascalCaseSustantivo + ControllerPluralUsersController
Métodos RESTcamelCaseVerbo-store(), update()
Métodos PersonalizadoscamelCaseVerbo + Sustantivo-calculateTotal()
ModelosPascalCaseSustantivoSingularUser, Product
VariablescamelCaseSustantivoDepende contexto$userName, $products
Tablas BDsnake_caseSustantivoPluralusers, product_categories
Columnas BDsnake_caseSustantivo-created_at, price

🎯 Ejemplos Prácticos Completos

Controlador con Métodos Personalizados

php
class OrderController extends Controller
{
    // ✅ VERBO + SUSTANTIVO: Calcular total de orden
    public function calculateOrderTotal($orderId)
    {
        $order = Order::find($orderId);
        $total = $order->calculateTotal();
        return response()->json(['total' => $total]);
    }
    
    // ✅ VERBO + SUSTANTIVO: Aplicar descuento a orden
    public function applyOrderDiscount($orderId, $discount)
    {
        $order = Order::find($orderId);
        $order->applyDiscount($discount);
        return response()->json(['success' => true]);
    }
    
    // ✅ VERBO + SUSTANTIVO: Generar factura de orden
    public function generateOrderInvoice($orderId)
    {
        $invoice = Order::generateInvoice($orderId);
        return response()->download($invoice);
    }
}

Modelo con Métodos

php
class User extends Model
{
    // ✅ VERBO + SUSTANTIVO: Verificar contraseña de usuario
    public function verifyUserPassword($password)
    {
        return Hash::check($password, $this->password);
    }
    
    // ✅ VERBO + SUSTANTIVO: Actualizar perfil de usuario
    public function updateUserProfile($data)
    {
        $this->update($data);
        return $this;
    }
    
    // ✅ VERBO + SUSTANTIVO: Calcular edad de usuario
    public function calculateUserAge()
    {
        return now()->diffInYears($this->birthdate);
    }
}

🔄 Rutas con Convenciones

php
// Rutas RESTful automáticas
Route::resource('products', ProductController::class);

// Rutas personalizadas con nombres VERBO + SUSTANTIVO
Route::post('products/{id}/activate', [ProductController::class, 'activateProduct'])
     ->name('products.activate'); // activateProduct = VERBO + SUSTANTIVO

Route::get('users/{id}/reports', [UserController::class, 'generateUserReport'])
     ->name('users.generateReport'); // generateUserReport = VERBO + SUSTANTIVO

Esta estructura Verbo + Sustantivo hace que el código sea:

  • Más legible: Se entiende inmediatamente qué acción realiza cada método

  • Más mantenible: Nombres consistentes y predecibles

  • Más intuitivo: Sigue el flujo natural de lenguaje (acción + objeto




Tienes toda la razón. Permíteme corregir y explicar adecuadamente la estructura para controladores:

📝 Controladores - Estructura Correcta

Nombres de Clases (Controladores)

  • Caso: PascalCase

  • Estructura: Sujeto/Objeto (Sustantivo) + Controller

  • Sufijo: Controller

  • Número: Sustantivo en Plural (representa la colección que maneja)

✅ Ejemplos Correctos:

php
// Controlador para manejar usuarios (colección de usuarios)
class UsersController extends Controller {}  // Sujeto: Users

// Controlador para manejar productos (colección de productos)  
class ProductsController extends Controller {} // Sujeto: Products

// Controlador para categorías de productos
class ProductCategoriesController extends Controller {} // Sujeto: ProductCategories

❌ Ejemplos Incorrectos:

php
class UserController extends Controller {}     // ❌ Debe ser plural: UsersController
class ManageUsersController extends Controller {} // ❌ No sigue estructura Sustantivo + Controller
class user_controller extends Controller {}    // ❌ Caso incorrecto

🔧 Métodos - Estructura Correcta

Métodos RESTful Estándar:

php
class ProductsController extends Controller
{
    // SUJETO: Products | VERBO: index (listar)
    public function index() {}    // GET /products
    
    // SUJETO: Product | VERBO: create (mostrar formulario creación)
    public function create() {}   // GET /products/create
    
    // SUJETO: Product | VERBO: store (almacenar)
    public function store() {}    // POST /products
    
    // SUJETO: Product | VERBO: show (mostrar)
    public function show() {}     // GET /products/{id}
    
    // SUJETO: Product | VERBO: edit (mostrar formulario edición)
    public function edit() {}     // GET /products/{id}/edit
    
    // SUJETO: Product | VERBO: update (actualizar)
    public function update() {}   // PUT/PATCH /products/{id}
    
    // SUJETO: Product | VERBO: destroy (eliminar)
    public function destroy() {}  // DELETE /products/{id}
}

Métodos Personalizados:

php
class UsersController extends Controller
{
    // SUJETO: User | VERBO: activate (activar)
    public function activate() {}      // PUT /users/{id}/activate
    
    // SUJETO: User | VERBO: suspend (suspender)  
    public function suspend() {}       // PUT /users/{id}/suspend
    
    // SUJETO: UserProfile | VERBO: update (actualizar)
    public function updateProfile() {} // PUT /users/{id}/profile
    
    // SUJETO: UserPassword | VERBO: change (cambiar)
    public function changePassword() {} // PUT /users/{id}/password
}

🎯 Estructura Generalizada

Para Controladores:

text
[SUSTANTIVO_PLURAL] + Controller

  • Sustantivo: Representa el recurso/entidad que se manipula

  • Plural: Indica que maneja una colección del recurso

  • Controller: Identifica el tipo de clase

Para Métodos:

text
[VERBO] + [SUSTANTIVO_OPCIONAL]()

  • Verbo: La acción a realizar (index, create, store, show, edit, update, destroy)

  • Sustantivo: Opcional, para especificar sub-recursos (profile, password, settings)

📋 Resumen Corregido

ElementoEstructuraEjemploExplicación
ControladorSustantivo Plural + ControllerUsersControllerManeja colección de usuarios
Método RESTVerboindex(), store()Acción sobre el recurso principal
Método PersonalizadoVerbo + Sustantivoactivate(), updateProfile()Acción específica o sobre sub-recurso
ModeloSustantivo SingularUserRepresenta una instancia única
Tabla BDSustantivo Plural snake_caseusersAlmacena múltiples instancias

🔄 Relación entre Componentes

text
Modelo: User (singular)        → Instancia individual
Tabla: users (plural)          → Colección de instancias  
Controlador: UsersController   → Maneja la colección
Métodos: index(), show(), etc. → Operaciones sobre la colección

Esta estructura sigue el principio de que el controlador maneja colecciones de recursos, por eso el sustantivo va en plural, mientras que los métodos operan sobre elementos individuales o la colección completa.

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