Guía de estilo

Tabla de contenido

1. Archivos
2. Sintaxis de condicionales (if)
3. Sintaxis de ciclos (for, while, etc)
4. Clases
5. Variables
6. Funciones

Archivos

Nombramiento de archivos

• Los archivos de controladores deben ser nombrados como <Nombre_del_controlador>Controller.php (manteniendo notación StudlyCaps) touch app/Http/Controllers/OrderController.php

Reglas generales

• Los archivos php deben iniciar con <?php seguido de una línea en blanco
• Al final de los archivos php debe haber una línea en blanco
• La definición de funciones debe estar separada por una línea en blanco

public function index() 
{  
...  
}  

public function save()  
{  
...  
}

Sintaxis de condicionales

Los condicionales deben escribirse así:

<?php

if ($a > $b) {
  echo "a es mayor que b";
}

• Nótese el espacio entre el if y la expresión a evaluar.
• Nótese los espacios en la expresión entre las variables y el operador lógico.
• Nótese el espacio entre el paréntesis y el curly brace que abre

Sintaxis de ciclos

Los ciclos deben escribirse así:

<?php

$times = 0;
while ($a > $b) {
  $times++;
}

• Nótese el espacio entre el ciclo y la expresión a evaluar.
• Nótese los espacios en la expresión entre las variables y el operador lógico.
• Nótese que se abren y cierran los curly braces en una nueva línea

Clases

• Las clases deben ser nombradas en StudlyCaps.
• Se deben usar los namespaces.

Variables

• Las variables deben ser nombradas en camelCase.
• Las constantes deben estar escritas todas en mayúscula.

Funciones

Estilos generales

• Las funciones deben ser nombradas en camelCase.
• Preferiblemente deben tener nombres de acciones.
• Al definir una función, se debe abrir y cerrar los curly braces en una línea diferente

public function index()
{
...
}

Llamadas a funciones

• Cuando se requiera llamar a una función, no deben haber espacios entre la función y los paréntesis $newOrder->setDate($request->input('date'));
• Si la función tiene muchos parámetros, se pueden poner en líneas diferentes para facilitar la lectura del código