Ahora comienzo una serie de post orientados a las buenas practicas de desarrollo bajo PHP5, básicamente son medidas adoptadas por mi persona desde hace un tiempo y es producto de la misma dinámica que hace que uno se de cuenta que a veces no esta haciendo las cosas bien y como el norte es hacer software de manera profesional este es un buen comienzo, aunque fácilmente puedes tomar tu código y aplicarles estas técnicas que lo hacen mas limpio…

En esta primera parte tocare dos herramienta PHP_CodeSniffer y PHP_Beautifier

PHP_CodeSniffer

Nos ayuda a saber cuando estamos trabajando fuera del estándar, no con esto digo que mi código no tiene ni un error cuando ejecuto esta herramienta (tampoco soy un talibán).

Las instalación es bastante sencilla es un paquete que esta en PEAR

# pear install  PHP_CodeSniffer

La forma de utilizarla es tan sencilla como esta…

#phpcs <directorio_archivo_PHP>

Y la salida de debería ser algo como lo que se muestra abajo, como se aprecia solo debemos ir a la linea y seguir la sugerencia que nos indica…

--------------------------------------------------------------------------------
FOUND 15 ERROR(S) AND 20 WARNING(S) AFFECTING 25 LINE(S)
--------------------------------------------------------------------------------
24 | WARNING | PHP version not specified
24 | ERROR   | Missing @link tag in file comment
38 | ERROR   | Missing @link tag in class comment
40 | ERROR   | Expected 0 spaces before opening brace; 1 found
41 | ERROR   | Spaces must be used to indent lines; tabs are not allowed
126 | ERROR   | Spaces must be used to indent lines; tabs are not allowed
127 | ERROR   | Public method name "Kumbia::init_application" is not in camel caps format
127 | ERROR   | Missing function doc comment
127 | ERROR   | Opening function brace should be on a new line
136 | WARNING | Line exceeds 85 characters; contains 91 characters
136 | WARNING | Equals sign not aligned with surrounding assignments; expected 17 spaces but found 1 space<pre>
<h2>PHP_Beautifier</h2>
Esta herramienta formatea el codigo de manera tal que este "humanizado", la instalación es tan sencilla como el anterior
<pre lang="text">#pear install --alldeps --force PHP_Beautifier

hecho esto veamos un ejemplo…

1
2
3
4
5
6
7
8

function test ($aParameter)
 {
 $a = 4;
 $b=5;
 if ($a == $aParameter)
 {
 var_dump('Hola Mundo'); }
}

como se aprecia el código es realmente feo, ahora si ponemos en acción a PHP_Beautifier esto mejora…

#php_beautifier archivo.php salida.php
1
2
3
4
5
6
7
8

function test($aParameter) {
    $a = 4;
    $b = 5;
    if ($a == $aParameter) {
        var_dump('Hola Mundo');
    }
}
?>

Como podemos notar la diferencia es notable :) los invito a todos a generar código de una manera profesional y profesional no solo es que la aplicación funcione correctamente…

  • Share/Bookmark