Reglas generales de código en Moodle

Reglas Generales

1. Todos los archivos deben utilizar la extensión .php.
2. Deben mantenerse todas las notas de copyright. Ud. puede colocar la suya si es necesario.
3. Cada archivo debe incluir el config.php principal.
4. Cada archivo debe certificar que el usuario esté correctamente autenticado, utilizando require_login() and isadmin(), isteacher(), iscreator() o isstudent().
5. Todo acceso a la base de datos debe utilizar las funciones incluidas en lib/datalib.php en cuanto sea posible --esto permite la compatibilidad entre un amplio rango de bases de datos. Con esas funciones es posible hacer casi todo. Cualquier otra sentencia SQL debe ser: inter-plataforma, restringida a funciones específicas dentro del código (a menudo un archivo lib.php), y señalado con claridad.
6. Todas las cadenas deben ser traducibles --crear nuevos textos en los archivos de "lang/en" y llamarlos utilizando get_string() o print_string().
7. Todos los archivos de ayuda deben ser traducibles --crear nuevos textos en los archivos de "lang/en/help" y llamarlos utilizando helpbutton().

Estilo de código

1. No utilice tabuladores. Use sangría consistente con 4 espacio.
2. Siempre se deben utilizar llaves para los bloques de código (aunque sean de una sola línea). Moodle usa este estilo:

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

3. Más por venir... este documento aún no está completo.

Moodle Documentation

Version: $Id: faq.html,v 1.6 2003/03/30 13:54:28 moodler Exp $