Coding standards - Naming Conventions - Functions and methods.php 1.02 KB
Newer Older
hansbrix's avatar
hansbrix committed
1

2
* Function names may only contain alphanumeric characters. Underscores are not permitted. Numbers are permitted in function names but are discouraged.
hansbrix's avatar
hansbrix committed
3 4 5



6
* Function names must always start with a lowercase letter. When a function name consists of more than one word, the first letter of each new word must be capitalized. This is commonly called the "studlyCaps" or "camelCaps" method.
hansbrix's avatar
hansbrix committed
7 8 9



10
* Verbosity is encouraged. Function names should be as verbose as is practical to enhance the understandability of code.
hansbrix's avatar
hansbrix committed
11 12 13



14
* For object-oriented programming, accessors for objects should always be prefixed with either "get" or "set". This applies to all classes except for Doctrine_Record which has some accessor methods prefixed with 'obtain' and 'assign'. The reason
hansbrix's avatar
hansbrix committed
15 16 17 18
for this is that since all user defined ActiveRecords inherit Doctrine_Record, it should populate the get / set namespace as little as possible. 



19
* Functions in the global scope ("floating functions") are NOT permmitted. All static functions should be wrapped in a static class.
hansbrix's avatar
hansbrix committed
20

21