Convenciones en PHP (El Lenguaje)

 PHP no impone una única convención obligatoria, pero la comunidad y los manuales oficiales recomiendan ciertos estilos para evitar conflictos y mejorar la legibilidad.

1. Clases, Interfaces y Traits

  • Convención: PascalCase (también conocido como StudlyCaps). Cada palabra comienza con mayúscula y no hay guiones bajos.

  • Ejemplos:

    • class Usuario {}

    • class UsuarioPremium {}

    • interface ProveedorCorreo {}

    • trait ValidadorDatos {}

  • Nota: La documentación oficial de PHP sugiere este estilo para las clases . PEAR, un estándar histórico, también lo recomienda .

2. Métodos

  • Convención: camelCase. La primera palabra comienza con minúscula y las siguientes palabras con mayúscula, sin guiones bajos .

  • Ejemplos:

    • public function obtenerNombre() {}

    • public function enviarNotificacionPush() {}

    • private function calcularTotal() {}

3. Propiedades (Atributos de una clase)

  • Convención: Históricamente ha habido cierta variabilidad, pero la tendencia moderna, especialmente con PHP 7.4+ y tipado fuerte, es usar camelCase.

  • Ejemplos:

    • public $nombreUsuario;

    • protected $fechaCreacion;

    • private $esActivo;

  • Nota histórica: Algunas guías antiguas recomendaban snake_case para propiedades  o el uso de guiones bajos para propiedades privadas/protegidas ($_nombre) , pero esto es cada vez menos común en el código PHP moderno, que prefiere la simplicidad de camelCase.

4. Constantes de Clase

  • Convención: MAYÚSCULAS_SNAKE_CASE. Todas las letras en mayúscula y palabras separadas por guiones bajos .

  • Ejemplos:

    • public const VERSION = '1.0';

    • private const MAXIMO_INTENTOS = 5;

5. Funciones Globales (No recomendado dentro de clases)

  • Convención: snake_case. Letras minúsculas y palabras separadas por guiones bajos. Es el estilo que usa PHP internamente (ej. str_replace, array_merge) .

  • Ejemplos:

    • function conecta_base_datos() {}

Convenciones en Laravel (El Framework)

Laravel es famoso por su "magia" y convenciones sobre configuración. Seguir sus reglas de nomenclatura hace que todo funcione de manera fluida y automática .

ConceptoConvenciónEjemplo(s)¿Por qué?
ModelosSingular y PascalCaseUser, BlogPost, OrderItem Laravel asume que la tabla en la base de datos será la versión en snake_case y plural del nombre de la clase (ej. blog_posts para BlogPost).
ControladoresPascalCase con sufijo ControllerUserController, BlogPostController, ApiProductController Es la convención estándar para identificar rápidamente qué archivos son controladores.
Tablas DBsnake_case y pluralusers, blog_posts, order_items Coincide con la convención de Laravel para enlazar automáticamente un modelo a su tabla.
Columnas DBsnake_casefirst_name, created_at, user_id, is_active Es el estándar SQL y Laravel lo maneja a la perfección, especialmente con nombres compuestos.
Métodos en ControladorescamelCaseindex(), show(), store(), getUserPosts() Sigue la convención de PHP para métodos. Los métodos de recursos (index, create, etc.) son la excepción por ser parte de la API REST de Laravel.
Archivos de Migraciónsnake_case con timestamp2024_01_15_123456_create_blog_posts_table.php El timestamp asegura el orden de ejecución. El nombre describe claramente la acción.
Nombres de Rutassnake_caseblog.index, user.profile.show, dashboard.analytics.export Son legibles y fáciles de usar en los helpers de Laravel (route('blog.index')).
Archivos Blade (Vistas)snake_caseindex.blade.php, show.blade.php, user-profile.blade.php Mantiene la consistencia con otros archivos de configuración y nombres de ruta.
Variables localescamelCase$blogPost, $activeUsers, $isValid Es el estándar de PHP para variables.

Un Resumen Visual Rápido

Para que lo tengas siempre presente, esta imagen de Tajammal Amin en LinkedIn lo resume de forma excelente :

  • 🐫 camelCase: Variables locales, métodos de controladores, parámetros de request.

  • 🐍 snake_case: Tablas y columnas DB, parámetros de ruta, claves de configuración.

  • 📛 PascalCase: Nombres de clases (Modelos, Controladores, Middleware).

  • 🔠 MAYÚSCULAS_SNAKE_CASE: Constantes, variables de entorno.

  • ➖ kebab-case: Nombres de rutas (en algunos contextos, aunque Laravel prefiere snake_case) y archivos de vista.

En Resumen

  1. Para PHP Puro: Usa PascalCase para clases y camelCase para métodos y propiedades. Es limpio y moderno.

  2. Para Laravel: Sigue las convenciones del framework al pie de la letra. Esto es clave. Cuando nombras tu modelo BlogPost y tu tabla blog_posts, Laravel los conecta automáticamente. Cuando nombras tu controlador BlogPostController, el framework y otros desarrolladores saben instantáneamente qué hace.

Adoptar estas convenciones desde el principio hará que tu código sea mucho más fácil de leer, mantener y escalar, tanto para ti como para cualquier otra persona que trabaje en el proyecto.

Comentarios

Publicar un comentario

Entradas más populares de este blog

token

  ¿Qué es un token? Un  token  es una cadena de caracteres que representa información específica, como credenciales de acceso, identificadores únicos o datos de sesión. Se utilizan comúnmente en: Autenticación y autorización (JWT, tokens de acceso) Protección CSRF (Cross-Site Request Forgery) Identificación única de recursos Contraseñas de un solo uso Ejemplo pequeño en PHP: Token de autenticación simple php <?php // Función para generar un token aleatorio function generarToken ( $longitud = 32 ) { return bin2hex ( random_bytes ( $longitud ) ) ; } // Generar un token $token = generarToken ( ) ; echo "Token generado: " . $token . "\n\n" ; // Simular verificación del token (en una aplicación real se guardaría en base de datos) function verificarToken ( $tokenAlmacenado , $tokenRecibido ) { return hash_equals ( $tokenAlmacenado , $tokenRecibido ) ; } // Ejemplo de uso $tokenAlmacenado = $token ; // En la práctica, esto ven...
Leer más

¿Qué es un token y cómo se utiliza en una API?

  ¿Qué es un token y cómo se utiliza en una API? ¿Qué es un token? Un  token  es una cadena de caracteres que actúa como credencial de acceso para autenticar y autorizar a un usuario o aplicación en una API. Funciona como una "llave digital" que permite acceder a recursos protegidos sin necesidad de compartir credenciales sensibles como usuario y contraseña en cada solicitud. Tipos comunes de tokens: JWT (JSON Web Token) : Token auto-contenido con información codificada Access Token : Para acceso a recursos Refresh Token : Para renovar access tokens expirados API Key : Clave simple de identificación Ejemplo con PHP usando JWT 1. Instalación de dependencias bash composer require firebase/php-jwt 2. Generar un token JWT php <?php require 'vendor/autoload.php' ; use Firebase \ JWT \ JWT ; use Firebase \ JWT \ Key ; class TokenManager { private $secretKey = "tu_clave_secreta_muy_segura" ; private $algorithm = 'HS256' ; ...
Leer más

Generación de Credenciales API

   Generación de Credenciales API Método 1: Credenciales básicas (API Key + Secret) php <?php // Generar credenciales seguras function generarCredencialesAPI ( ) { $api_key = bin2hex ( random_bytes ( 32 ) ) ; // 64 caracteres hexadecimales $api_secret = bin2hex ( random_bytes ( 64 ) ) ; // 128 caracteres hexadecimales return [ 'api_key' => $api_key , 'api_secret' => password_hash ( $api_secret , PASSWORD_DEFAULT ) ] ; } // Generar y guardar credenciales $credenciales = generarCredencialesAPI ( ) ; // Guardar en base de datos (ejemplo) // INSERT INTO api_credentials (api_key, api_secret_hash, created_at) // VALUES (:api_key, :api_secret, NOW()) ?> Método 2: Credenciales JWT php <?php use Firebase \ JWT \ JWT ; use Firebase \ JWT \ Key ; class JWTCredentials { private $secret_key ; public function __construct ( ) { $this -> secret_key = bin2hex ( r...
Leer más