Guía de apoyo para el uso de Moodle
2.3 Manual de estilo de código Este manual de estilo ha sido creado para conseguir que todo el código de Moodle cumpla estas características, de forma que sea más fácil de entender a los futuros desarrolladores. Es cierto que la parte más antigua del código no cumple estas normas en algunos casos, pero la comunidad Moodle está trabajando para solucionarlo gradualmente. Todo el código nuevo definitivamente deberá adherirse a estos estándares de la forma más exacta posible.
2.3.1
Reglas generales
Este apartado se basa en las “Reglas Generales” que propone Moodle para sus desarrolladores. •
Todos los archivos de código deberían utilizar la extensión .php.
•
Todas las plantillas deberían utilizar la extensión .html.
•
Todos los archivos de texto deberían utilizar el formato de texto Unix (la mayoría de los editores de texto tienen esto como una opción).
•
Todas las etiquetas php deben ser 'completas' como <?Php ?> ... No 'reducidas' como <? ?>.
•
Todos los avisos de copyright deben ser mantenidos. Puede incluir los suyos propios si resulta necesario.
•
Todos los archivos deben incluir el archivo principal config.php.
•
Cualquier otro include/require debería utilizar una ruta absoluta que comience por $CFG->dirroot o $CFG->libdir, nunca relativos, ya que estos en algunas ocasiones funcionan de forma extraña en PHP.
•
Cada archivo debería comprobar que el usuario está autenticado correctamente, utilizando las funciones require_login() y isadmin(), isteacher(), iscreator() o isstudent().
•
Todos los accesos a la base de datos deberían utilizar las funciones definidas en lib/datalib.php cuando sea posible - esto permite la compatibilidad con un gran número de bases de datos. Debería encontrar que prácticamente todo es posible utilizando estas funciones. Si quiere escribir código SQL entonces deberá comprobar que: funciona en cualquier plataforma; restringido a funciones específicas de su código (normalmente un archivo lib.php); y claramente comentado.
•
No cree o utilice variables globales distintas de las estándar $CFG, $SESSION, $THEME, $SITE, $COURSE y $USER.
•
Todas las variables deberían ser inicializadas o, al menos, comprobada su existencia utilizando isset() o empty() antes de ser utilizadas.
EUITIO - Universidad de Oviedo | Ana Teresa González de Felipe