{"id":26721,"date":"2021-04-28T17:05:00","date_gmt":"2021-04-28T14:05:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=26721"},"modified":"2021-10-17T17:51:36","modified_gmt":"2021-10-17T14:51:36","slug":"php_codesniffer-una-biblioteca-para-mejorar-sus-estandares-de-codificacion-php","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/es\/php_codesniffer-una-biblioteca-para-mejorar-sus-estandares-de-codificacion-php\/","title":{"rendered":"PHP_CodeSniffer: una biblioteca para mejorar sus est\u00e1ndares de codificaci\u00f3n PHP"},"content":{"rendered":"

\u00bfQuiere mejorar sus est\u00e1ndares de codificaci\u00f3n PHP? Obviamente, s\u00ed. No importa si es un desarrollador PHP m\u00e1s nuevo o experimentado, todos desean mejorar sus est\u00e1ndares de codificaci\u00f3n.<\/p>\n

\u00bfPero c\u00f3mo?<\/p>\n

Bueno, hay varios recursos disponibles en Internet que puede leer y comenzar a implementar.<\/p>\n

Hay una soluci\u00f3n m\u00e1s que no requiere leer sobre codificaci\u00f3n est\u00e1ndar. En cambio, le brinda sugerencias para mejorar el tiempo de ejecuci\u00f3n de sus est\u00e1ndares al buscar en su archivo PHP. De esta manera es mejor, ya que obtendr\u00e1 una sugerencia clara junto con el n\u00famero de l\u00ednea.<\/p>\n

Introducci\u00f3n a PHP_CodeSniffer<\/h3>\n

Como sugiere el nombre, PHP_CodeSniffer<\/a> huele el c\u00f3digo en sus archivos o carpetas. Dondequiera que huela el c\u00f3digo incorrecto, le informa d\u00f3nde est\u00e1 el c\u00f3digo incorrecto y qu\u00e9 pasos debe seguir para corregirlo. PHP_CodeSniffer act\u00faa como su verificador de c\u00f3digo PHP.<\/p>\n

Es una biblioteca muy recomendada para un programador PHP. Mientras trabaja en un proyecto PHP, no debe entregar su c\u00f3digo al cliente final hasta que haya terminado con los est\u00e1ndares de codificaci\u00f3n PHP sugeridos por PHP_CodeSniffer.<\/p>\n

Despu\u00e9s de todo, el programador de PHP deber\u00eda ofrecer un mejor c\u00f3digo y PHP_CodeSniffer lo ayuda a mejorar la codificaci\u00f3n.<\/p>\n

Instalar PHP_CodeSniffer con Composer<\/h3>\n

Composer<\/a> es un administrador de dependencias para PHP. Le permite instalar \/ actualizar la biblioteca que necesita para su proyecto.<\/p>\n

Puede instalar PHP_CodeSniffer en el directorio ra\u00edz de su proyecto. Pero, le recomiendo que cree una carpeta ‘php_codesniffer’ en el directorio ra\u00edz e instale la biblioteca dentro de esta carpeta.<\/p>\n

Para instalar PHP_CodeSniffer usando Composer, abra el s\u00edmbolo del sistema en el directorio ‘php_codesniffer’ y ejecute el siguiente comando.<\/p>\n

composer require \"squizlabs\/php_codesniffer=*\"<\/code><\/p>\n

\"PHP_CodeSniffer:<\/a><\/p>\n

Revisemos nuestros est\u00e1ndares de codificaci\u00f3n PHP<\/h3>\n

A continuaci\u00f3n, dir\u00edjase al php_codesniffer\/vendor\/bin<\/code>directorio desde el s\u00edmbolo del sistema. Desde esta carpeta bin, comprobaremos nuestros est\u00e1ndares de codificaci\u00f3n PHP con PHP_CodeSniffer.<\/p>\n

Por ejemplo, supongamos que tenemos un archivo llamado index.php en su proyecto. Mi archivo index.php contiene el siguiente c\u00f3digo.<\/p>\n

<?php\nrequire_once (\"vendor\/autoload.php\");\nrequire_once (\"config.php\");\n\u00a0\nTinifysetKey(TINIFY_KEY);\n\u00a0\n$source = TinifyfromFile(\"large.jpg\");\n$resized = $source->resize(\n\u00a0\u00a0\u00a0\u00a0array(\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"method\" => \"cover\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"width\" => 150,\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"height\" => 100\n\u00a0\u00a0\u00a0\u00a0));\n$resized->toFile(\"thumbnail1.jpg\");\n\u00a0\necho \"Image resized.\";\n\u00a0\n$bool = true;\n?><\/code><\/pre>\n
Este c\u00f3digo se usa para cambiar el tama\u00f1o de la imagen en PHP usando la biblioteca TinyPNG<\/a>. Nuestro c\u00f3digo funciona bien y da el resultado esperado. Pero, pasamos por alto algunos est\u00e1ndares de codificaci\u00f3n en nuestro archivo.<\/p>\n
Averig\u00fcemos qu\u00e9 est\u00e1ndar nos falta en el archivo anterior.<\/p>\n
Comprobaremos este archivo con PHP_CodeSniffer ejecutando el siguiente comando.<\/p>\n
phpcs --standard=PEAR \/path\/to\/your\/file<\/code><\/p>\n
Estamos trabajando en Windows, por lo que en nuestro caso, un comando ser\u00eda el siguiente.<\/p>\n
phpcs --standard=PEAR D:wampwwwapitinypngindex.php<\/code><\/p>\n
Aqu\u00ed ‘\u2013standard = PEAR’ significa que nuestro archivo se comparar\u00e1 con el est\u00e1ndar establecido por PEAR<\/a>.<\/p>\n
\"PHP_CodeSniffer:<\/a><\/p>\n
Despu\u00e9s de ejecutar el comando anterior, obtuvimos algunos errores sobre los est\u00e1ndares de codificaci\u00f3n.<\/p>\n
Corrija el c\u00f3digo utilizando pautas<\/h3>\n
Tomemos un ejemplo de error.<\/p>\n
El segundo error que dice ‘require_once’ es una declaraci\u00f3n, no una funci\u00f3n: no se requieren par\u00e9ntesis<\/p>\n
Por este error, llegamos a conocer el est\u00e1ndar para incluir archivos externos.<\/p>\n
Nuestro siguiente c\u00f3digo<\/p>\n
require_once (\"vendor\/autoload.php\");\nrequire_once (\"config.php\");<\/code><\/pre>\n
deber\u00eda reemplazar con<\/p>\n
require_once \"vendor\/autoload.php\";\nrequire_once \"config.php\";<\/code><\/pre>\n
Este es un ejemplo de correcci\u00f3n de c\u00f3digo. En su caso, puede encontrar otros errores. Debe corregirlo siguiendo las instrucciones que recibi\u00f3.<\/p>\n
La biblioteca PHP_CodeSniffer proporciona un comando que corrige autom\u00e1ticamente las violaciones del est\u00e1ndar de codificaci\u00f3n. Recuerde, este comando no corrige todos los errores. Se encargar\u00e1 de algunos errores menores como sangr\u00eda, cierre de par\u00e9ntesis, etc.<\/p>\n
Si observa la captura de pantalla anterior, notar\u00e1 que se encontraron 7 errores en total en nuestro archivo. Despu\u00e9s de la lista de errores, vea la l\u00ednea<\/p>\n
‘PHPCBF’ PUEDE ARREGLAR AUTOM\u00c1TICAMENTE LAS 6 VIOLACIONES DE SNIFF MARCADAS<\/p>\n
\"PHP_CodeSniffer:<\/a><\/p>\n
Primer error relacionado con la falta de un comentario de documento de archivo, tenemos que cuidar este comentario de documento. El comando ‘PHPCBF’ no lo corregir\u00e1.<\/p>\n
Habiendo dicho eso, escribamos el comando para ello.<\/p>\n
phpcbf --standard=PEAR D:wampwwwapitinypngindex.php<\/code><\/p>\n
\"PHP_CodeSniffer:<\/a><\/p>\n
En la captura de pantalla, puede ver que se corrigieron 6 errores y queda 1. El error restante est\u00e1 relacionado con el comentario del documento del archivo.<\/p>\n
Por lo tanto, agregaremos el comentario del archivo y nuestro c\u00f3digo final ser\u00e1 el siguiente.<\/p>\n
<?php\n\/**\n\u00a0* This file will generate the resize version of an image\n\u00a0*\n\u00a0* PHP version 5.6.25\n\u00a0*\n\u00a0* @category Resize_Image\n\u00a0* @package\u00a0 TinyPNG\n\u00a0* @author\u00a0\u00a0 Sajid <sajid@artisansweb.net>\n\u00a0* @license\u00a0 http:\/\/www.php.net\/license\/3_01.txt\u00a0 PHP License 3.01\n\u00a0* @link\u00a0\u00a0\u00a0\u00a0 https:\/\/artisansweb.net\/resize-image-php-using-tinypng\n\u00a0*\/\nrequire_once \"vendor\/autoload.php\";\nrequire_once \"config.php\";\n\u00a0\nTinifysetKey(TINIFY_KEY);\n\u00a0\n$source = TinifyfromFile(\"large.jpg\");\n$resized = $source->resize(\n\u00a0\u00a0\u00a0\u00a0array(\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"method\" => \"cover\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"width\" => 150,\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"height\" => 100\n\u00a0\u00a0\u00a0\u00a0)\n);\n$resized->toFile(\"thumbnail1.jpg\");\n\u00a0\necho \"Image resized.\";\n\u00a0\n$bool = true;\n?><\/code><\/pre>\n
Ahora, si ejecutamos el script ‘phpcs’, no obtendremos ning\u00fan error de est\u00e1ndares de codificaci\u00f3n PHP.<\/p>\n
\"PHP_CodeSniffer:<\/a><\/p>\n
Nota:<\/strong> PHP_CodeSniffer tambi\u00e9n valida sus archivos JS y CSS.<\/p>\n
Fuente de grabaci\u00f3n:  artisansweb.net<\/a><\/div><\/p>\n","protected":false},"excerpt":{"rendered":"
\u00bfQuiere mejorar sus est\u00e1ndares de codificaci\u00f3n PHP? PHP_CodeSniffer es una biblioteca que le ayuda a mejorar los est\u00e1ndares de codificaci\u00f3n. En este art\u00edculo, estudiamos<\/p>\n","protected":false},"author":1,"featured_media":21909,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_wp_rev_ctl_limit":""},"categories":[271],"tags":[849],"class_list":["post-26721","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-php-2","tag-affiai-es"],"_links":{"self":[{"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/posts\/26721","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/comments?post=26721"}],"version-history":[{"count":0,"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/posts\/26721\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/media\/21909"}],"wp:attachment":[{"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/media?parent=26721"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/categories?post=26721"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/themewp.inform.click\/es\/wp-json\/wp\/v2\/tags?post=26721"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}