{"id":24129,"date":"2021-05-12T09:42:00","date_gmt":"2021-05-12T06:42:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=24129"},"modified":"2021-10-17T21:04:24","modified_gmt":"2021-10-17T18:04:24","slug":"paranna-laravel-koodausstandardejasi-grumphp-n-avulla","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/fi\/paranna-laravel-koodausstandardejasi-grumphp-n-avulla\/","title":{"rendered":"Paranna Laravel-koodausstandardejasi GrumPHP: n avulla"},"content":{"rendered":"

Riippumatta siit\u00e4, oletko kokenut kehitt\u00e4j\u00e4 vai tuoreempi, sinun tulisi parantaa koodausstandardejasi tullaksesi paremmaksi kehitt\u00e4j\u00e4ksi. Joko ty\u00f6skentelet yksin tai tiimin kanssa, on aina hyv\u00e4 k\u00e4yt\u00e4nt\u00f6 olla samat koodausk\u00e4yt\u00e4nn\u00f6t koko projektin ajan. Mutta samojen standardien yll\u00e4pito kaikissa paikoissa ei ole helppoa, jos tarkistamme sen manuaalisesti. Saattaa tapahtua, ett\u00e4 menetit standardin, vaikka p\u00e4\u00e4titkin noudattaa sit\u00e4. Se on inhimillinen virhe, unohdimme joskus asioita, joita meid\u00e4n ei pit\u00e4isi. T\u00e4llaisten ongelmien est\u00e4miseksi meid\u00e4n pit\u00e4isi automatisoida ty\u00f6nkulku. Tekem\u00e4ll\u00e4 niin, automaattinen j\u00e4rjestelm\u00e4mme huolehtii meille osoittamastamme teht\u00e4v\u00e4st\u00e4 ja 99,99% ajasta ei koskaan ep\u00e4onnistu.<\/p>\n

GrumPHP<\/a> on kirjasto, joka pit\u00e4\u00e4 silm\u00e4ll\u00e4 jokaista sitoutumistasi. Jos koodisi ei noudata annettuja standardeja, kirjasto ei salli koodin antamista. Korjaa koodi ensin ja sitten vain sin\u00e4 pystyt sitoutumaan Gitiin.<\/p>\n

Kuulostaa hyv\u00e4lt\u00e4? Katsotaanpa se toiminnassa.<\/p>\n

P\u00e4\u00e4st\u00e4 alkuun<\/h3>\n

Kun puhumme Laravel-koodausstandardeista, sinulla pit\u00e4isi olla Laravel-projektiasetus. Jos sinulla ei ole sit\u00e4, asenna se komennolla:<\/p>\n

composer create-project --prefer-dist laravel\/laravel laravel-dev<\/code><\/pre>\n
T\u00e4ss\u00e4 ’laravel-dev’ on projektisi nimi. Avaa p\u00e4\u00e4te projektisi juurihakemistossa ja alusta git.<\/p>\n
git init<\/code><\/pre>\n
Git on pakollinen projektissasi, jotta voit hy\u00f6dynt\u00e4\u00e4 GrumPHP: t\u00e4. T\u00e4ss\u00e4 se toimii. Kun asennamme GrumPHP: n, se luo koukun .git<\/code>kansioon ja seuraa sitten jokaista sitoutumista.<\/p>\n
Lis\u00e4\u00e4 nyt ja sitouta nykyiset tiedostosi gitiin k\u00e4ytt\u00e4m\u00e4ll\u00e4 alla olevia komentoja yksi kerrallaan.<\/p>\n
git add -A<\/code><\/pre>\n
git commit -m 'initial commit'<\/code><\/pre>\n
Paranna Laravel-koodausstandardia GrumPHP: n avulla<\/h3>\n
Kun Laravel-projektissamme on git-m\u00e4\u00e4ritys, on hyv\u00e4 asentaa GrumPHP-kirjasto. Asenna se suorittamalla seuraava komento:<\/p>\n
composer require --dev phpro\/grumphp<\/code><\/pre>\n
Kun paketti on asennettu, sinun tulee n\u00e4hd\u00e4 alla oleva viesti terminaalissa:<\/p>\n
Varo! GrumPHP haistaa sitoutumistasi!<\/p>\n
Se tarkoittaa, ett\u00e4 paketti on asennettu onnistuneesti. Seuraavaksi avaa grumphp.yml<\/code>tiedosto ja lis\u00e4\u00e4 siihen alla oleva koodi.<\/p>\n
parameters:\n\u00a0\u00a0\u00a0\u00a0git_dir:. \u00a0\u00a0\u00a0\u00a0bin_dir: vendor\/bin\n\u00a0\u00a0\u00a0\u00a0tasks: { \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0phpcs: {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0standard: PSR2\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n\u00a0\u00a0\u00a0\u00a0\u00a0}<\/code><\/pre>\n
Yll\u00e4 olevassa koodissa t\u00e4rke\u00e4 osa on rivi standard: PSR2<\/code>. T\u00e4ss\u00e4 kerrotaan GrumPHP: lle, ett\u00e4 se tarkistaa PSR2-koodausk\u00e4yt\u00e4nn\u00f6t tiedostoihin, jotka aikovat sitoutua. K\u00e4ytimme PSR2: ta t\u00e4\u00e4ll\u00e4, koska Laravel noudattaa PSR2-koodausstandardeja. T\u00e4m\u00e4n j\u00e4lkeen GrumPHP suorittaa teht\u00e4v\u00e4ns\u00e4 ja ilmoittaa meille virheest\u00e4 konsolissa, jos se l\u00f6ytyy.<\/p>\n
Jos et ole asentanut koodauksen vakiokirjastoa, asenna se suorittamalla alla oleva komento:<\/p>\n
composer require \"squizlabs\/php_codesniffer=*\"<\/code><\/pre>\n
T\u00e4m\u00e4n kirjaston ytimess\u00e4 on PSR2-koodausstandardit. Joten, GrumPHP tarkistaa Laravel-koodisi PSR2: n perusteella ja ehdottaa muutoksia, jos et noudata PSR2-standardeja.<\/p>\n
Oletetaan ImageController.php<\/code>, ett\u00e4 projektissamme on tiedosto ja ett\u00e4 siin\u00e4 on seuraava koodikappale.<\/p>\n
public function store(Request $request)\n{\n\u00a0\u00a0\u00a0\u00a0if($request->hasFile('profile_image')) {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/get filename with extension\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$filenamewithextension = $request->file('profile_image')->getClientOriginalName();\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/get filename without extension\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$filename = pathinfo($filenamewithextension, PATHINFO_FILENAME);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/get file extension\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$extension = $request->file('profile_image')->getClientOriginalExtension();\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/filename to store\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$filenametostore = $filename.'_'.time().'.'.$extension;\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/Upload File\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$request->file('profile_image')->storeAs('public\/profile_images', $filenametostore);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0if(!file_exists(public_path('storage\/profile_images\/crop'))) {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0mkdir(public_path('storage\/profile_images\/crop'), 0755);\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ crop image\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$img = Image::make(public_path('storage\/profile_images\/'.$filenametostore));\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$croppath = public_path('storage\/profile_images\/crop\/'.$filenametostore);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$img->crop($request->input('w'), $request->input('h'), $request->input('x1'), $request->input('y1'));\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$img->save($croppath);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ you can save crop image path below in database\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$path = asset('storage\/profile_images\/crop\/'.$filenametostore);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return redirect('image')->with(['success' => \"Image cropped successfully.\", 'path' => $path]);\n\u00a0\u00a0\u00a0\u00a0}\n}<\/code><\/pre>\n
Yrit\u00e4 sitten sitoa yll\u00e4 oleva koodi ja sinun pit\u00e4isi n\u00e4hd\u00e4 ulostulo jotain alla olevaa:<\/p>\n
Se antaa koodausvirheen yksityiskohdissa sek\u00e4 rivinumeron ja kuvauksen. Saatat my\u00f6s huomata rivin:<\/p>\n
PHPCBF VOI KORJATAA AUTOMAATTISESTI 2 MERKITTYJ\u00c4 SNIFF-RIKKOMUSTEN<\/p>\n
Kuinka k\u00e4ytt\u00e4\u00e4 PHPCBF-komentoa<\/h3>\n
Suorittamalla PHPCBF-komento voimme korjata joitain virheit\u00e4 automaattisesti. Siirry p\u00e4\u00e4telaitteesta ’vendor \/ bin’ -hakemistoon ja suorita alla oleva komento korjataaksesi virheet PHPCBF: n avulla.<\/p>\n
PHPCBF --standard=PSR2 PATH_TO_YOUR_CONTROLLER<\/code><\/pre>\n
Korvaa paikkamerkki todellisilla arvoilla. Todenn\u00e4k\u00f6isesti, jos k\u00e4yt\u00e4t t\u00e4t\u00e4 komentoa Git bashissa, saat virheilmoituksen ’bash: phpcbf: komentoa ei l\u00f6ydy’. Suorita t\u00e4ll\u00f6in t\u00e4m\u00e4 komento Windowsin komentokehotteessa. Meid\u00e4n tapauksessamme n\u00e4emme seuraavan l\u00e4hd\u00f6n p\u00e4\u00e4telaitteessa.<\/p>\n
Muista, ett\u00e4 kaikkia virheit\u00e4 PHPCBH ei ole ratkaissut. Joskus sinun on ratkaistava virhe my\u00f6s manuaalisesti. Nyt kun yrit\u00e4t sitouttaa koodin, sinun pit\u00e4isi saada menestysviesti ja koodi sitoutua my\u00f6s.<\/p>\n
Lopulliset ajatukset<\/h3>\n
T\u00e4ss\u00e4 opetusohjelmassa olemme keskustelleet Laravel-koodausstandardien parantamisesta GrumPHP: n avulla. Mutta se ei rajoitu vain Laraveliin. Voit k\u00e4ytt\u00e4\u00e4 t\u00e4t\u00e4 kirjastoa my\u00f6s muussa CMS: ss\u00e4, kehyksiss\u00e4. K\u00e4yt\u00e4mme GrumPHP-kirjastoa Laravel-, WordPress- ja PHP-ydinprojekteihimme. Se todella auttaa meit\u00e4 yll\u00e4pit\u00e4m\u00e4\u00e4n koodaustyyli\u00e4mme johdonmukaisesti.<\/p>\n
Aiheeseen liittyv\u00e4t artikkelit<\/h4>\n