Estandares de Codificacion para PHP
Esta es una guia que estoy utilizando para llegar a un desarrollo mas limpio y entendible en mis proyectos y en los proyectos de la empresa donde trabajo, estoy tomando como base la documentacion de PEAR y alli le meto mis agregados. La dejo aqui por si a alguien mas le sirve, las sugerencias son bienvenidas.
Sangrías y Longitud de línea
Usar una sangría de 4 espacios sin usar la tecla “tab”. Esto ayuda a evitar problemas con diffs, patches, historia del CVS y anotaciones.
Estructuras de Control
Estas incluyen: if, for, while, switch, etc. Aquí esta el ejemplo de la postura de “if”, porque es el mas complicado de todas ellas.
-
<?php
-
if ((condition1) || (condition2)) {
-
action1;
-
} elseif ((condition3) && (condition4)) {
-
action2;
-
} else {
-
defaultaction;
-
}
-
?>
Los estatutos de control deben de tener un espacio entre la palabra clave de control y el inicio de paréntesis “(“, para distinguirlos de las llamadas de función.
Deben de utilizarse las llaves en cualquier caso “{ }”, incluso en situaciones donde son técnicamente opcionales. Su uso incrementa su capacidad de lectura y reduce la probabilidad de errores lógicos que son introducidos cuando líneas nuevas se agregan.
Para estructuras switch:
-
<?php
-
switch (condition) {
-
case 1:
-
action1;
-
break;
-
case 2:
-
action2;
-
break;
-
default:
-
defaultaction;
-
break;
-
}
-
?>
Llamadas de Función
Las funciones deberá de ser llamadas sin espacios entre el nombre de la función, el abrir paréntesis y el primer parámetro; espacios entre comas y cada parámetro, y sin espacios entre el ultimo parámetro, el cierra paréntesis y punto y coma.
Ejemplo:
-
<?php
-
$var = foo($bar, $baz, $quux);
-
?>
Como se muestra aquí arriba, deberá de haber un espacio en ambos lados del signo de igual que se usa para asignar el valor de regreso de una función a una variable. En el caso de un bloque de asignaturas relacionadas, mas espacio puede ser agregado para así, promover su facilidad de lectura.
-
<?php
-
$short = foo($bar);
-
$long_variable = foo($baz);
-
?>
Definiciones de Función
En las declaraciones de función, el bracket de apertura empieza al final de la linea de definición despues de un espacio.
-
<?php
-
function foo_function($arg1, $arg2 = 'x') {
-
if (condition) {
-
statement;
-
}
-
return $val;
-
}
-
?>
Los argumentos con valores por default van al final de la lista de argumentos. Siempre tratando de regresar un valor significativo de una función, si una es la apropiada. Un ejemplo más largo:
-
<?php
-
function connect(&$dsn, $persistent = false) {
-
$dsninfo = &$dsn;
-
} else {
-
$dsninfo = DB::parseDSN($dsn);
-
}
-
if (!$dsninfo || !$dsninfo['phptype']) {
-
return $this->raiseError();
-
}
-
return true;
-
}
-
?>
Inclusión de Código
En cualquier parte que estés incondicionalmente incluyendo una archivo de una clase, usa required_once. En cualquier parte donde estés condicionalmente incluyendo una archivo de clase (por ejemplo, métodos de fabrica) usa include_once. Cualquiera de esas se asegurará que la class file sea incluida únicamente una vez. Ellas comparten la misma lista de archivo (file list) así que no hay necesidad de preocuparse por mezclarlas, un archivo incluido con required_once no será nuevamente incluido por include_once.
Convención de Nombres de Variables, Funciones, Clases
Variables:
Estas deberán nombrarse con un prefijo de tres letras el cual define el tipo de dato de la misma, seguido de un guión bajo y el nombre descriptivo de la variable. Ejemplo:
-
$txt_descripcion: Campo tipo text
-
$chr_nombres: Campo tipo char o varchar
-
$int_cantidad: Campo tipo integer
-
$flt_total: Campo tipo float
-
$dbl_precio : Campo tipo double
-
$dtm_fecha: Campo tipo fecha
-
$bol_activo: Campo tipo boolean
Funciones:
Estas deberán nombrarse con palabras minúsculas seguido de un guión bajo, para separar palabras en el nombre de la misma. Ejemplo:
-
<?php
-
function conectar_db($arg1, $arg2 = 'x') {
-
if (condition) {
-
statement;
-
}
-
return $val;
-
}
-
?>
Clases:
Estas deberán nombrarse con la primer palabra iniciando con minúscula y separando las demás palabras con letra mayúscula. Ejemplo:
-
<?php
-
class CodigosPostales {
-
function foo($arg1) {
-
statement;
-
}
-
}
-
?>
