Aina kun työskentelen projektin parissa, minulla on usein WordPress asetettu virheenkorjaustilaan ja tykkään kirjoittaa virhelokiin viestejä, joita voin helposti tarkastella, jäljittää ja seurata aina, kun työskentelen projektin parissa.
Kun teen tämän, on kaksi tapaa (ja se riippuu vain projektista):
- Käytän kirjastoa, kuten Monologia ,
- Käytän omaa, yksinkertaista lokitoimintoa.
Tässä postauksessa käsittelen jälkimmäistä. Toisin sanoen aion kertoa, kuinka kirjoitan viestejä WordPress-virheenkorjauslokiin, ja sitten joitain asioita, joihin sinun on ehkä kiinnitettävä huomiota aina, kun teet saman.
WordPressin virheenkorjausloki
Ensinnäkin on tärkeää huomata, että funktio, jonka aion jakaa, on yleensä perusluokan yhteydessä.
Oletetaan, että minulla on kaikilla tilaajillani AbstractSubscriber (kuten ScriptAssetSubscriber JavaScript-tiedoston rekisteröintiä ja jonoon lisäämistä varten).
AbstractSubscriber sisältää tämän toiminnon, jotta kaikki alaluokat voivat kutsua sitä. Toiminto on melko yksinkertainen:
<?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;
}
}Mutta tässä toiminnossa on useita asioita, jotka voivat rikkoa periaatetta tai aiheuttaa virheitä koodinlaatutyökaluissa.
Valinnaiset Boolen argumentit
Aina kun funktio hyväksyy valinnaisen loogisen argumentin, se voi tarkoittaa, että funktiolla on useampi kuin yksi vastuu (täten yhden vastuun periaatteen vastainen ).
Syynä tämä rikkoisi mainittua periaatetta, koska se antaa moduulille enemmän kuin yhden syyn muuttaa.
Minusta on mukava antaa tämä kirjoittaa tällä tavalla, koska käytän sitä virheenkorjaukseen, en tuotantoympäristöihin, ja koska joskus saatan haluta pysäyttää suorituksen, ja joskus en.
Ja toki, voisin kirjoittaa kaksi erillistä funktiota, mutta jos tämä on ainoa funktio, joka tekee tämän, en hyväksy sitä.
Kielletyt poistumisilmoitukset
Muut koodin laatutyökalut eivät pidä exit – lauseesta (ja vastaavasti he eivät pidä die – lauseesta). Ja se on ymmärrettävää: ne tyypillisesti pysäyttävät ohjelman kokonaan, kun meidän pitäisi tehdä poikkeus, palauttaa arvo tai yleensä tehdä jotain käsitelläksesi tilanteen sulavasti.
Kuitenkin, koska tässä funktiossa on aikoja, jolloin haluan pysäyttää suorituksen, voin hyvin käsitellä seurauksia, jotka johtuvat siitä, että funktiossa on koodirivi.
Vaihtoehtoisesti voisin käyttää wp_die():tä, ja useimmat koodinlaatutyökalut eivät todennäköisesti tajuaisi sitä, mutta se peittää pääongelman. Jos mitään, ehkä on parasta vain vaimentaa varoitus millä tahansa ohjauksella, jonka valitsemasi nuuskija sallii.
Siitä huolimatta, kirjaa viesti
Viime kädessä yllä olevan toiminnon tarkoitus on tarjota yksinkertainen tapa kirjoittaa WordPress-virheenkorjauslokiin ja valinnaisesti pysäyttää ohjelman suorittaminen.
Se ei selvästikään ole ongelmaton, ja laadukkaampia kirjastoja on saatavilla, mutta joskus et tarvitse vasaraa ongelman nastalle.