Differences

This shows you the differences between two versions of the page.

--- naming_conventions [2019/09/13 12:25] – created sahl
+++ naming_conventions [2024/02/29 12:56] (current) – [Functions] sahl
@@ Line 1: / Line 1: @@
 ====== Naming conventions ======
-===== Objects =====
+This is the internal naming convention for Platform.
-When refering to [object name] below, object names are always lowercase and in singular form. //user// not //Users//
+===== PHP =====
-===== File names =====
+==== Classes and Objects ====
-^File type^Naming^Example^
+Classes are named with CamelCase and in singular case, so we have //User// and not //Users//
-|Form|[object name]_[action].frm|user_edit.frm|
-|Data loader|load_[object name].php|load_user.php|
-|Data saver|save_[object name].php|save_user.php|
-|Data load+save|io_[object name].php|io_user.php|
-===== HTML =====
+Objects are named in lowercase and with _ between words, so:
-==== Elements ====
+$user_property = new UserProperty();
-^Element^Form^Example^
+==== Functions ====
-|Button|[object name]-[activity]-button|user-edit-button|
-|Dialog|[object name]-[activity]-dialog|user-edit-dialog|
-|Form|[object name]-form|user-form|
-|Table|[object name]-table|user-table|
+Functions are dromedaryCase such as //deleteUsers()// and are named according to the following scheme:
-===== Javascript =====
+^add...|Add further information to an object, meaning that nothing is replaced but something is added.|
+^attach...|Attach something to the object.|
+^build...|Build something inside the object relying on information already present|
+^calculate...|Make some kind of calculation. Typically something that's complex or can take some amount of time.|
+^can...|Check if the object is able to do something or if the user is allowed to do something with the object|
+^copy...|Copy some information or the entire object.|
+^check...|Check if something external to the object but relevant for the object have occured.|
+^decode...|Decode some information from something else. The opposite of encode.|
+^delete...|Delete something. Typically the object|
+^encode...|Encode some information into something else. The opposite of decode.|
+^ensure...|Ensure that something is in place or have been performed, by doing it if it haven't already been done|
+^find...|Find some information. Typically used for fuzzy searching. Otherwise we use get.|
+^get...|Get some information either from inside the object or one or more objects in a static context.|
+^is...|Check if the object is in a given state.|
+^job...|A job typically called from the [[Job class]].|
+^load...|Read data into the object.|
+^on...|Used for specific events that take place in the object.|
+^register...|Register some information to the object.|
+^remove...|Removes something from the object or the object from something.|
+^replace...|Replaces something with something else.|
+^retrieve...|Retrieve some information from somewhere else. The opposite of store.|
+^parse...|Input some data which is transformed to something else.|
+^prepare...|Prepare some data to later usage.|
+^render...|Renders something to the page.|
+^reset...|Resets something to a previous state.|
+^save...|Save data from the object.|
+^set...|Set information in the object.|
+^store...|Store some information somewhere else (ie not in the object). The opposite of retrieve.|
+^validate...|Ensures that something is correct.|
-==== Functions ====
+Functions are places alphabetically in files, except for //getAdditionalStructure// in Datarecord classes which is allowed to be first.
-Functions should be dromedaryCase
+==== Variables ====
-===== PHP =====
+Variables are initialized to the same name as the class they are representing. Variables in several words are split by underscore _
-==== Functions ====
-Functions should be dromedaryCase
+===== SQL =====
-Class functions should be named according to what they do:
+Tables are named after their corresponding classes, but in plural form, such as //users//
-^calculate|Calculates something within the object|
+^Keys|Keys are named [object name]_id such as ''user_id''|
-^can|Check if the object is able to do something|
+^Foreign keys|Foreign references are named [foreign object name]_ref such as ''user_ref''|
-^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|
+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 _