PHP_CodeSniffer – teek teie PHP kodeerimisstandardite täiustamiseks

Viimati uuendatud okt. 17, 2021

Sisu

Installige PHP_CodeSniffer Composeri abil

Kontrollime oma PHP kodeerimisstandardeid

Kas soovite oma PHP kodeerimisstandardeid täiustada? Ilmselgelt jah. Pole tähtis, kas olete värskem või kogenum PHP arendaja, kõik soovivad oma kodeerimisstandardeid täiustada.

Aga kuidas?

Internetis on saadaval mitu ressurssi, mida saate lugeda ja hakata rakendama.

On veel üks lahendus, mis ei nõua standardkodeerimise kohta lugemist. Selle asemel annab see teile soovitusi oma standardse käituse parandamiseks, vaadates oma PHP-faili. See viis on parem, kuna saate selge ettepaneku koos rea numbriga.

Sissejuhatus teenusesse PHP_CodeSniffer

Nagu nimigi ütleb, haiseb PHP_CodeSniffer teie failides või kaustades oleva koodi. Kui see lõhnab halba koodi, annab see teile aru, kus on vale kood ja milliseid samme peaksite selle parandamiseks tegema. PHP_CodeSniffer toimib nagu teie PHP-koodi kontrollija.

See on PHP-programmeerijale väga soovitatav raamatukogu. PHP-projektiga töötades ei tohiks te oma koodi lõpukliendile edastada enne, kui olete lõpetanud PHP_CodeSnifferi soovitatud PHP-kodeerimisstandardid.

Lõppude lõpuks peaks PHP programmeerija edastama parema koodi ja PHP_CodeSniffer aitab teil paremat kodeerimist.

Installige PHP_CodeSniffer Composeri abil

Composer on PHP sõltuvushaldur. See võimaldab teil installida / värskendada oma projekti jaoks vajalikku teeki.

PHP_CodeSnifferi saate installida oma projekti juurkataloogi. Kuid soovitan teil luua juurkataloogi kaust ‘php_codesniffer’ ja installida teek selle kausta sisse.

PHP_CodeSnifferi installimiseks helilooja abil avage kataloogis ‘php_codesniffer’ käsuviip ja käivitage järgmine käsk.

composer require "squizlabs/php_codesniffer=*"

Kontrollime oma PHP kodeerimisstandardeid

Järgmisena php_codesniffer/vendor/binminge käsuviibalt kataloogi. Sellest prügikasti kaustast kontrollime meie PHP kodeerimisstandardeid PHP_CodeSnifferiga.

Oletame näiteks, et meil on teie projektis fail nimega index.php. Minu fail index.php sisaldab allolevat koodi.

<?php
require_once ("vendor/autoload.php");
require_once ("config.php");
 
TinifysetKey(TINIFY_KEY);
 
$source = TinifyfromFile("large.jpg");
$resized = $source->resize(
    array(
        "method" => "cover",
        "width" => 150,
        "height" => 100
    ));
$resized->toFile("thumbnail1.jpg");
 
echo "Image resized.";
 
$bool = true;
?>

Seda koodi kasutati PHP-s pildi suuruse muutmiseks, kasutades TinyPNG-teeki. Meie kood töötab hästi ja annab oodatud tulemuse. Kuid meie failis jäid mõned kodeerimisstandardid tähelepanuta.

Uurime, milline standard meil ülaltoodud failis puudub.

Kontrollime seda faili PHP_CodeSnifferiga, käivitades alloleva käsu.

phpcs --standard=PEAR /path/to/your/file

Töötame Windowsiga, nii et meie puhul oleks käsk järgmine.

phpcs --standard=PEAR D:wampwwwapitinypngindex.php

Siin tähendab ‘–standard = PEAR’ meie faili vastavust PEAR-i kehtestatud standardile .

Pärast ülaltoodud käsu käivitamist saime kodeerimisstandardite osas vigu.

Parandage kood juhiste abil

Võtame ühe näite veast.

Teine viga öeldes ‘Nõua_kord’ on lause, mis ei ole funktsioon: sulge pole vaja

Selle vea abil saame teada välise faili kaasamise standardist.

Meie allpool olev kood

require_once ("vendor/autoload.php");
require_once ("config.php");

peaks asendama

require_once "vendor/autoload.php";
require_once "config.php";

See on üks näide koodi parandamisest. Teie puhul võite leida muid vigu. Peaksite selle parandama, järgides saadud juhiseid.

PHP_CodeSnifferi teegis on üks käsk, mis parandab kodeerimise standardrikkumised automaatselt. Pidage meeles, et see käsk ei paranda kõiki vigu. See hoolitseb mõne väiksema vea eest, nagu taane, sulgude sulgemine jne.

Ülaltoodud ekraanipilti vaadates märkate, et meie failist leiti kokku 7 viga. Pärast tõrke loendit vaadake rida

‘PHPCBF’ SAAB AUTOMAATSELT PARANDADA 6 MÄRGISTATUD SNIFF-RIKKUMIST

Esimene viga, mis on seotud faili doc kommentaari puudumisega, peame hoolitsema selle doc kommentaari eest. ‘PHPCBF’ käsk ei paranda seda.

Selle öeldes kirjutame selle jaoks käsu.

phpcbf --standard=PEAR D:wampwwwapitinypngindex.php

Ekraanipildil näete, et see on parandanud 6 viga ja 1 on alles. Allesjäänud viga on seotud faili doc kommentaariga.

Niisiis lisame faili kommenteerides ja meie lõplik kood on järgmine.

<?php
/**
 * This file will generate the resize version of an image
 *
 * PHP version 5.6.25
 *
 * @category Resize_Image
 * @package  TinyPNG
 * @author   Sajid <[email protected]>
 * @license  http://www.php.net/license/3_01.txt  PHP License 3.01
 * @link     https://artisansweb.net/resize-image-php-using-tinypng
 */
require_once "vendor/autoload.php";
require_once "config.php";
 
TinifysetKey(TINIFY_KEY);
 
$source = TinifyfromFile("large.jpg");
$resized = $source->resize(
    array(
        "method" => "cover",
        "width" => 150,
        "height" => 100
    )
);
$resized->toFile("thumbnail1.jpg");
 
echo "Image resized.";
 
$bool = true;
?>

Kui käivitame skripti ‘phpcs’, ei saa me ühtegi PHP kodeerimisstandardite viga.

Märkus. PHP_CodeSniffer valideerib ka teie JS- ja CSS-failid.

: artisansweb.net