Entrada

Usas CakePHP? Comprueba si tu código cumple las convenciones

Si usas CakePHP es muy recomendable que compruebes si tu código cumple los estándares y convenciones definidos por CakePHP, que puedes ver en su página oficial: convenciones de CakePHP. Esto se puede hacer con un sniffer de código, el cual ha desarrollado el equipo de CakePHP.

A continuación indico como integrarlo tanto si tienes un entorno de desarrollo en Linux como en Windows.

Si tienes un entorno de desarrollo en Linux

Tienes que ejecutar.

1
2
pear channel-discover pear.cakephp.org
pear install cakephp/CakePHP_CodeSniffer

y para usarlo

1
phpcs --standard=CakePHP /path/to/code

La documentación oficial la puedes ver en el repositorio oficial de CakePHP https://github.com/cakephp/cakephp-codesniffer

Si tienes un entorno de desarrollo en Windows con Xampp

Saca una consola de windows, en Inicio > Ejecutar o buscar > teclea cmd y pincha en el icono de la consola

Ubícate en la carpeta php dentro de xampp. Usa los comandos cd y dir de windows, para moverte por las carpetas y mostrar el contenido respectivamente.

Ejecuta el siguiente comando

1
C:\xampp\\php>pear.bat channel-discover pear.cakephp.org

Si ya lo tienes instalado te aparecerá un mensaje similar a este: Channel “pear.cakephp.org” is already initialized

Ejemplo visual de este proceso.

instalar cakephp code sniffer 1

Instala el sniffer

instalar cakephp sniffer comandos

Nota: he agregado –alldeps para que en caso de que no tengáis el canal de pear.phpunit.de el cual se necesita para instalar el sniffer de CakePHP, se instale automáticamente.

Ubicandos en la misma carpeta de xampp/php ejecutar

1
C:\xampp\\php>phpcs.bat --standard=CakePHP /ruta/proyecto/cakephp/

errores standares CakePHP

Como se ve en la imagen hay una lista de errores y warnings y la ubicación de los mismos, ahora habría que modificar el código para que éste cumpla al 100% los estándares de CakePHP.

Esta entrada está licenciada bajo CC BY 4.0 por el autor.