Tutorial de creación de un módulo para Moodle 1.9 (II)

¡¡ Atención !! Este tutorial consta de 4 partes que sólamente cubren el comienzo del desarrollo de un módulo para moodle. Debido a la publicación del libro Moodle 1.9 Extension Development que explica paso a paso la forma de desarrollar un módulo, el tutorial no va a ser continuado. Si estás interesado en el desarrollo en moodle, te recomiendo su compra.


Estructura de archivos de un módulo

Para que moodle reconozca nuestro módulo de actividad este debe seguir una estructura de archivos (algunos necesarios y otros opcionales). Para ello, a partir de este momento vamos a considerar que nuestro módulo de prueba va a llamarse “modsms“. Por tanto la estructura sería:

/ – raíz de moodle.
 /mod – carpeta de módulos.
  /modsms – carpeta raíz de nuestro módulo. Aquí dentro irán todos nuestros archivos y carpetas.
   /db – carpeta con datos a introducir en la base de datos durante la instalación/actualización del módulo.
    /access.php – contiene las capacidades/permisos del módulo.
    /install.xml – esquema de la base de datos en xmldb para la instalación del módulo.
    /upgrade.php – procedimientos de actualización del módulo.
   /icon.gif – icono de la actividad que se muestra en el curso (entre otros sitios).
   /index.php – muestra la lista de instancias de actividades de nuestro módulo que hay en el curso.
   /lib.php – funciones requeridas por moodle para comunicarse con nuestro módulo.
   /locallib.php – funciones propias que necesitemos para nuestro módulo.
   /mod_form.php – formulario de configuración de la actividad al ser creada o editada.
   /version.php – información sobre versiones relacionadas con el módulo.
   /view.php – página de inicio de la actividad (cuando entra en la actividad un alumno por ejemplo).
   /styles.php – definición de estilos css para nuestro módulo.
   /backuplib.php – funciones para realizar la copia de seguridad del módulo.
   /restorelib.php – funciones para realizar el restablecimiento de una copia de seguridad del módulo.
   /lang – directorio de idiomas
    /es_es_utf8 – directorio de idioma correspondiente al español de España versión UTF8.
     /modsms.php – archivo con las cadenas usadas en el módulo en el idioma de arriba.
     /help – carpeta con los archivos de ayuda.
      /modsms – ayuda de este módulo.
       /index.html – índice con enlaces a los demás archivos de ayuda de este módulo.
       /mods.html – información general de nuestro módulo.
       /miayuda5.html – archivo de ayuda propio con ayuda sobre algo de nuestro módulo.
   /miarchivo.php – también podemos crear tantos archivos (páginas) como necesitemos.

Los archivos en negrita son los archivos “obligatorios” que deberemos tener en nuestro módulo, siendo el resto opcionales.

Referencias básicas a la hora de desarrollar un módulo

Dado que como comentábamos en la anterior entrega de este tutorial la documentación de moodle es bastante escasa, cuando estemos desarrollando nuestro módulo o mirando cómo están hechos los otros (algo muy recomendable por otra parte) nos encontraremos con funciones que no sabemos qué hacen o que parámetros se le pueden pasar. Para ello moodle posee dos webs donde tiene subido la documentación generada por phpDocumentor y PHPXref que nos van a ser muy útiles para lo anterior:

Una vez conocida la estructura de archivos de los módulos, en la siguiente entrega comenzaremos de lleno a programar nuestro módulo modsms.

Publicado el 22/07/2009

Sobre el autor

Es un analista / programador en NoSoloSoftware, una empresa de desarrollo software de nueva creación radicada en Córdoba (España). Le gusta investigar las tecnologías web usadas en el cloud computing, especialmente el mundo que rodea a Ruby y Rails, y sobre todo emprender y resolver problemas de ingeniería.

Redes sociales