Revision as of 03:46, 31 May 2007 by Takayuki ISHIKAWA (talk | contribs) (link to Japanese)

Jump to: navigation, search

Any collaborative project needs consistency and stability to stay strong.

These coding guidelines are to provide a goal for all Moodle code to strive to. It's true that some of the older existing code falls short in a few areas, but it will all be fixed eventually. All new code definitely must adhere to these standards as closely as possible.

General rules

  1. All code files should use the .php extension.
  2. All template files should use the .html extension.
  3. All text files should use Unix-style text format (most text editors have this as an option).
  4. All php tags must be 'full' tags like <?php ?> ... not 'short' tags like <? ?>.
  5. All existing copyright notices must be retained. You can add your own if necessary.
  6. Each file should include the main config.php file.
  7. Each file should check that the user is authenticated correctly, using require_login() and isadmin(), isteacher(), iscreator() or isstudent().
  8. All access to databases should use the functions in lib/dmllib.php whenever possible - this allows compatibility across a wide range of databases. You should find that almost anything is possible using these functions. If you must write SQL code then make sure it is: cross-platform; restricted to specific functions within your code (usually a lib.php file); and clearly marked.
  9. Don't create or use global variables except for the standard $CFG, $SESSION, $THEME, $SITE, $COURSE and $USER.
  10. All variables should be initialised or at least tested for existence using isset() or empty() before they are used.
  11. All strings should be translatable - create new texts in the "lang/en_utf8" files with concise English lowercase names and retrieve them from your code using get_string() or print_string(). Never delete strings to ensure backwards compatibility of the language packs is maintained.
  12. All errors should be printed using print_error() to maximise translation and help for users (it automatically links to the docs wiki).
  13. All help files should be translatable - create new texts in the "lang/en_utf8/help" directory and call them using helpbutton(). If you need to update a help file:
    • with a minor change, where an old translation of the file would still make sense, then it's OK to make the change but you should notify translation AT moodle DOT org.
    • for a major change you should create a new file by adding an incrementing number (eg filename2.html) so that translators can easily see it's a new version of the file. Obviously the new code and the help index files should also be modified to point to the newest versions.
  14. Incoming data from the browser (sent via GET or POST) automatically has magic_quotes applied (regardless of the PHP settings) so that you can safely insert it straight into the database. All other raw data (from files, or from databases) must be escaped with addslashes() before inserting it into the database. Because this is so often done incorrectly, there is more explanation on this issue of adding and stripping slashes on a separate page.
  15. VERY IMPORTANT: All texts within Moodle, especially those that have come from users, should be printed using the format_text() function. This ensures that text is filtered and cleaned correctly. More information can be found on the page about output functions.
  16. User actions should be logged using the add_to_log() function. These logs are used for activity reports and Logs.
  17. When generating a HTML link, always make it relative to the full site root, i.e. link to $CFG->wwwroot/mod/blonk/view.php?id=99 rather than just view.php?id=99. This means that your code will work if called by a script in another folder, among other things.

Coding style

I know it can be a little annoying to change your style if you're used to something else, but balance that annoyance against the annoyance of all the people trying later on to make sense of Moodle code with mixed styles. There are obviously many good points for and against any style that people use, but the current style just is, so please stick to it.

1. Indenting should be consistently 4 spaces. Don't use tabs AT ALL.

2. Variable names should always be easy-to-read, meaningful lowercase English words. If you really need more than one word then run them together, but keep them short as possible. Use plural names for arrays of objects.

     GOOD: $quiz
     GOOD: $errorstring
     GOOD: $assignments (for an array of objects)
     GOOD: $i (but only in little loops)
     BAD: $Quiz
     BAD: $aReallyLongVariableNameWithoutAGoodReason
     BAD: $error_string

3. Constants should always be in upper case, and always start with the name of the module. They should have words separated by underscores.

     define("FORUM_MODE_FLATOLDEST", 1);

4. Function names should be simple English lowercase words, and start with the name of the module to avoid conflicts between modules. Words should be separated by underscores. Parameters should always have sensible defaults if possible. Note there is no space between the function name and the following (brackets).

     function forum_set_display_mode($mode=0) {
         global $USER, $CFG;
         if ($mode) {
             $USER->mode = $mode;
         } else if (empty($USER->mode)) {
             $USER->mode = $CFG->forum_displaymode;

5. Blocks must always be enclosed in curly braces (even if there is only one line). Moodle uses this style:

     if ($quiz->attempts) {
         if ($numattempts > $quiz->attempts) {
             error($strtoomanyattempts, "view.php?id=$cm->id");

6. Strings should be defined using single quotes where possible, for increased speed.

     $var = 'some text without any variables';
     $var = "with special characters like a new line \n";
     $var = 'a very, very long string with a '.$single.' variable in it';
     $var = "some $text with $many variables $within it";

7. Comments should be added as much as is practical, to explain the code flow and the purpose of functions and variables.

  • Every function (and class) should use the popular phpDoc format. This allows code documentation to be generated automatically.
  • Inline comments should use the // style, laid out neatly so that it fits among the code and lines up with it.
     * The description should be first, with asterisks laid out exactly
     * like this example. If you want to refer to a another function,
     * do it like this: {@link clean_param()}. Then, add descriptions
     * for each parameter as follows.
     * @param int $postid The PHP type is followed by the variable name
     * @param array $scale The PHP type is followed by the variable name
     * @param array $ratings The PHP type is followed by the variable name
     * @return mixed
     function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {
         if (!$ratings) {
             $ratings = array();     // Initialize the empty array
             if ($rates = get_records("forum_ratings", "post", $postid)) {
                 // Process each rating in turn
                 foreach ($rates as $rate) {

8. Space should be used liberally - don't be afraid to spread things out a little to gain some clarity. Generally, there should be one space between brackets and normal statements, but no space between brackets and variables or functions:

     foreach ($objects as $key => $thing) {
     if ($x == $y) {
         $a = $b;
     } else if ($x == $z) {
         $a = $c;
     } else {
         $a = $d;

9. When making a COPY of an object, always use the php5 clone() function (otherwise you may end up with just a reference to the first object). Moodle will make sure this works consistently on php4 too.

     BAD:   $b = $a;
     GOOD:  $b = clone($a);

If the thing you want to copy is not an object, but may contain objects (eg an array of objects) then use fullclone() instead.

Database structures

To help you create tables that meet these guidelines, we recommend you use the built in database definition (XMLDB) editor.

  1. Every table must have an auto-incrementing id field (INT10) as primary index. (see IdColumnReasons)
  2. The main table containing instances of each module must have the same name as the module (eg widget) and contain the following minimum fields:
    • id - as described above
    • course - the id of the course that each instance belongs to
    • name - the full name of each instance of the module
  3. Other tables associated with a module that contain information about 'things' should be named widget_things (note the plural).
  4. Table and column names should avoid using reserved words in any database. Please check them before creation.
  5. Column names should be always lowercase, simple and short, following the same rules as for variable names.
  6. Where possible, columns that contain a reference to the id field of another table (eg widget) should be called widgetid. (Note that this convention is newish and not followed in some older tables)
  7. Boolean fields should be implemented as small integer fields (eg INT4) containing 0 or 1, to allow for later expansion of values if necessary.
  8. Most tables should have a timemodified field (INT10) which is updated with a current timestamp obtained with the PHP time() function.
  9. Always define a default value for each field (and make it sensible)
  10. Each table name should start with the database prefix ($CFG->prefix). In a lot of cases, this is taken care of for you automatically. Also, under Postgres, the name of every index must start with the prefix too.
  11. In order to guarantee cross-db compatibility follow these simple rules about the use of the AS keyword (only if you need table/colum aliases, of course):
    • Don't use the AS keyword for table aliases.
    • Do use the AS keyword for column aliases.
  12. Never create UNIQUE KEYs (constraints) at all. Instead use UNIQUE INDEXes. In the future, if we decide to add referential integrity to Moodle and we need UNIQUE KEYs they will be used, but not now. Please note that the XMLDB editor allows you to specify both XMLDB-only UNIQUE and FOREIGN constraints (and that's good, in order to have the XML well defined) but only underlying INDEXes will be generated.
  13. Those XMLDB-only UNIQUE KEYs (read previous point) only must be defined if such field/fields are going to be the target for some (XMLDB-only too) FOREIGN KEY. Else, create them as simple UNIQUE INDEXes.
  14. Tables associated with one block must follow this convention with their names: $CFG->prefix + "block_" + name_of_the_block + anything_else. For example, assuming that $CFG->prefix is 'mdl_', all the tables for the block "rss_client" must start by 'mdl_block_rss_client' (being possible to add more words at the end, i.e. 'mdl_block_rss_client_anothertable'...). This rule will be 100% enforced with Moodle 2.0, giving time to developers until then. See Task 6786 for more info about this.
  15. Never make database changes in the STABLE branches. If we did, then users upgrading from one stable version to the next would have duplicate changes occurring, which may cause serious errors.

Security issues (and handling form and URL data)

  1. Do not rely on 'register_globals'. Every variable must be properly initialised in every code file. It must be obvious where the variable came from.
  2. Initialise all arrays and objects, even if empty. $a = array() or $obj = new stdClass();.
  3. Do not use the optional_variable() function (this function is now deprecated). Use the optional_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.
  4. Do not use the require_variable() function (this function is now deprecated). Use the required_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.
  5. Use data_submitted(), with care. Data must still be cleaned before use.
  6. Do not use $_GET, $_POST or $_REQUEST. Use the appropriate required_param() or optional_param() appropriate to your need.
  7. Do not check for an action using something like if (isset($_GET['something'])). Use, e.g., $something = optional_param( 'something',-1,PARAM_INT ) and then perform proper test for it being in its expected range of values e.g., if ($something>=0) {....
  8. Wherever possible group all your required_param(), optional_param() and other variables initialisation at the beginning of each file to make them easy to find.
  9. Use 'sesskey' mechanism to protect form handling routines from attack. Basic example of use: when form is generated, include <input type="hidden" name="sesskey" value="<?php echo sesskey(); ?>" />. When you process the form check with if (!confirm_sesskey()) {error('Bad Session Key');}.
  10. All filenames must be 'cleaned' using the clean_filename() function, if this has not been done already by appropriate use of required_param() or optional_param()
  11. Any data read from the database must have addslashes() applied to it before it can be written back. A whole object of data can be hit at once with addslashes_object().
  12. Wherever possible, data to be stored in the database must come from POST data (from a form with method="POST") as opposed to GET data (ie, data from the URL line).
  13. Do not use data from $_SERVER if you can avoid it. This has portability issues.
  14. If it hasn't been done somewhere else, make sure all data written to the database has been through the clean_param() function using the appropriate PARAM_XXXX for the datatype.
  15. If you write custom SQL code, make very sure it is correct. In particular watch out for missing quotes around values. Possible SQL 'injection' exploit.
  16. Check all data (particularly that written to the database) in every file it is used. Do not expect or rely on it being done somewhere else.
  17. Blocks of code to be included should contain a definite PHP structure (e.g, a class declaration, function definition(s) etc.) - straight blocks of code promote uninitialised variable usage.zh:代码指南