Projekti kallal töötades on mul sageli WordPress seatud silumisrežiimile ja mulle meeldib kirjutada vealogi sõnumeid, mida saan projekti kallal töötades hõlpsasti vaadata, jälgida ja jälgida.
Kui ma seda teen, on kaks võimalust (ja see sõltub projektist):
- Ma kasutan raamatukogu, näiteks Monolog ,
- Kasutan oma lihtsat logifunktsiooni.
Selles postituses käsitlen viimast. See tähendab, et ma jagan, kuidas ma WordPressi silumislogi sõnumeid kirjutan, ja seejärel mõningaid asju, millele peate võib-olla sama tehes tähelepanu pöörama.
WordPressi silumislogi
Esiteks on oluline märkida, et funktsioon, mida ma jagan, on tavaliselt põhiklassi kontekstis.
Oletame, et mul on kõigil minu tellijatel rakendus AbstractSubscriber (nt ScriptAssetSubscriber JavaScripti faili registreerimiseks ja järjekorda seadmiseks).
AbstractSubscriber sisaldab seda funktsiooni, nii et seda saavad kutsuda kõik alamklassid. Funktsioon on üsna lihtne:
<?php
/**
* Prints a message to the debug file that can easily be called by any subclass.
*
* @param mixed $message an object, array, string, number, or other data to write to the debug log
* @param bool $shouldNotDie whether or not the The function should exit after writing to the log
*
*/
protected function log($message, $shouldNotDie = true)
{
error_log(print_r($message, true));
if ($shouldNotDie) {
exit;
}
}Kuid selle funktsiooni juures on mitmeid asju, mis võivad põhimõtet rikkuda või käivitada koodikvaliteedi tööriistades vigu.
Valikulised Boole’i argumendid
Kui funktsioon aktsepteerib valikulist tõeväärtusargumenti, võib see viidata sellele, et funktsioonil on rohkem kui üks vastutus (see rikub ühe vastutuse põhimõtet ).
Põhjus, miks see nimetatud põhimõtet rikub, on see, et see annab moodulile rohkem kui ühe põhjuse muutmiseks.
Mul on mugav seda nii kirjutada, sest ma kasutan seda silumiseks, mitte tootmiskeskkondade jaoks, ja kuna mõnikord võib tekkida soov täitmine peatada, aga mõnikord mitte.
Ja kindlasti, ma võiksin kirjutada kaks erinevat funktsiooni, kuid kui see on ainus funktsioon, mis seda teeb, olen sellega nõus.
Keelatud lahkumise avaldused
Teistele koodikvaliteedi tööriistadele ei meeldi väljumisavaldus (ja sarnaselt ei meeldi neile ka die avaldus). Ja see on arusaadav: nad peatavad tavaliselt programmi täielikult, kui peaksime tegema erandi, tagastama väärtuse või üldiselt midagi ette võtma, et olukorda graatsiliselt käsitleda.
Jällegi, kuna selle funktsiooni puhul on aegu, kus tahan täitmise peatada, on minu jaoks täiesti okei tegeleda funktsioonis koodirea olemasolu tagajärgedega.
Teise võimalusena võin kasutada wp_die() ja enamik koodikvaliteedi tööriistu seda tõenäoliselt ei tabaks, kuid see varjab põhiprobleemi. Kui midagi, siis võib-olla on kõige parem hoiatus lihtsalt maha suruda, kasutades mis tahes käsku, mida teie valitud nuusutaja lubab.
Sellest hoolimata logige sõnum sisse
Lõppkokkuvõttes on ülaltoodud funktsiooni eesmärk pakkuda lihtsat viisi WordPressi silumislogi kirjutamiseks ja soovi korral programmi käivitamise peatamiseks.
Ilmselgelt pole see probleemideta ja saadaval on kvaliteetsemaid teeke, kuid mõnikord pole probleemse pöidla jaoks vaja haamrit.