This is an old revision of the document!

Naming conventions

Objects

When refering to [object name] below, object names are always lowercase and in singular form. user not Users

The property which determines what to do, should be named action

Functions should be dromedaryCase

Classes are CamelCase and in singular form

Functions should be dromedaryCase

Class functions should be named according to what they do:

calculate	Calculates something within the object
can	Check if the object is able to do something
get	Gets some information from the object
is	Check if the object is in a given state.
load	Retrieves object information from somewhere
save	Stores object information somewhere
set	Set some information in the object

Functions are places alphabetically in files, except for getAdditionalStructure in Datarecord class' which is allowed to be first.

Variables are initialized to the same name as the class they are representing. Variables in several words are split by underscore _

Tables are named after their corresponding classes, but in plural form, such as users

Keys	Keys are named [object name]_id such as `user_id`
Foreign keys	Foreign references are named [foreign object name]_ref such as `user_ref`

In other cases the object name should never be part of the field names, so not user_first_name but only first_name

Field names are lowercase and words are split by underscore _