Gör valet att följa standarder i PHP

PHP Framework Interop Group är en  sammansatt grupp av medlemmar ur många av de allra största ramverken i PHP. Tanken med gruppen är att de ska besluta om gemensamma kodstandarder i PHP-världen. Och med så många både stora och lite mindre aktörer som medlemmar så har (faktiskt) php-fig och deras standarder PSR (Proposed Standards Recommendation) blivit mer än väl accepterat.

Fördelen med att följa en standard är många. Det kan t.ex. handla om allt från att det blir lättare att läsa kod eftersom du är van vid utseendet, till att en standardiserad pakethantering gör det lättare att använda 3’e-parts kod i ditt egna projekt.

Fördelarna är kanske inte så stora om du bara sitter hemma i kammaren och programmerar endast själv, och för dina egna ändamål. Men om du har minsta intresse av att så småningom blanda in flera programmerare, eller kanske publicera ditt projekt för att andra ska kunna använda det, då blir det genast mycket viktigare.

För att inte tala om den dagen du blir anställd programmerare och kan nämna att du följer standarder! Då är det bra att var förberedd och inte så smart att säga ”jag har alltid gjort på detta viset, och kommer att fortsätta med det” ;)

Nedan följer en länkar och en kort beskrivning av några standarder:

PSR-0 beskriver standarder för autoloading av klasser, och därmed även filnamn. Det finns även exempel på hur en autoloader kan se ut med vanlig autoload och med SplClassLoader, som är att föredra framför de två.

PSR-1 beskriver enklare kodstandarder såsom php-taggar, teckenkodning, klass- och metodnamn, konstanter och namespaces.

PSR-2 tar över där PSR-1 slutar och beskriver detaljer kring kodstandarden. Bl.a. beskrivs när radbrytningar och mellanslag ska ske eller inte ske,  var klamrar och paranteser ska läggas, hur indentering i koden ska vara och mycket mer. Detta är den mest utförliga standarden när det gäller ”utseendet” på din kod.

PSR-3 beskriver hur ett interface för loggning av varningar och fel bör se ut. Exempelkod finns även här.

PSR-4 fortsätter att beskriva och komplettera PSR-0, dvs hur autoloadern ska fungera. Nämner även Composer och pakethantering.

 PSR-5 är ännu inte en accepterad standard, men mycket tyder på att den inte kommer att ändra sig så väldigt mycket innan den accepteras. PSR-5 tar upp det som kallas för docblocks, en standard för att kommentera din kod. Docblocks används bland annat av phpDocumentor för att automatiskt generera dokumentation.

Semantic Versioning 2.0.0 är inte en del av php-fig, men beskriver hur du bör tänka när du sätter versioner på ditt projekt.