Konvensjoner

Kofradia har mye gammel kode, hvor ting er gjort litt forskjellig. Med dette dokumentet er det ønskelig å sette en standard for fremtidig kode og endringer ved refaktorering.

Kode

Navn på klasser, funksjoner m.v.

• Sammensatte klassenavn skal separeres med stor bokstav for hvert nye ord, og første ordet skal begynne med stor bokstav. Eksempler: PollOption, Forum.
• Navn på funksjoner skal følge samme oppsett, men ha liten forbokstav, f.eks. getUser().

Flyt i controllere

• Controller skal returnere, ikke avbryte scriptet/laste siden.

Database

• Sammensatte tabellnavn skal separeres med understrek.
• Felter i en tabell skal ha prefiks. Ingen tabeller skal ha samme prefikser. Prefikser skal være korte og være assosiert til tabellnavnet, f.eks. u_ for users.