En este artículo explicaré el código de un módulo que he creado para esta web. Es un módulo que genera automáticamente páginas con listados de enlaces (links) al contenido de la misma, ya sea de un término concreto, como “Drupal”, o de todos los términos de un vocabulario por defecto, como “Temas”.

En la página web oficial drupal.org puede encontrarse información detallada acerca del proceso de creación, instalación, configuración y desinstalación de módulos en Drupal.El módulo lo he llamado indexer, de forma que accediendo a la ruta indexer/drupal se muestra un listado de enlaces a todos los artículos de la serie dedicada a “Drupal”, y a través de la ruta indexer un listado de enlaces a todos los artículos de todos los términos de un vocabulario por defecto.

indexer.module

En la práctica, el módulo no es más que un fichero de nombre indexer.module, copiado en el directorio modules, y que contiene código PHP con una serie de funciones hooks (funciones gancho) que son llamadas por Drupal.

Los hooks son funciones de nombre hook_xxx, como hook_menu, hook_perm y hook_help. Los módulos las sobreescriben con funciones equivalentes de nombre modulo_xxx, como indexer_menu, indexer_perm e indexer_help.

En el resto de este artículo explicaré todas las funciones utilizadas en el módulo, de forma que para crearlo sólo habría que crear un fichero de nombre indexer.module, copiar en él todo el código listado en este artículo y moverlo al directorio modules de la instalación de Drupal en el servidor web.

indexer_menu

El módulo indexer puede verse como si tuviera dos puntos de interacción con la web. El primero de ellos cuando aparece como una opción más dentro del menú principal de administración, a través de la cual se permite configurar un vocabulario a utilizar por defecto. Y el segundo punto cuando se accede a la página a través de la cual se ven los índices del término dado.

La función hook_menu es llamada siempre por Drupal antes de crear las páginas, antes de mandarlas al navegador, y en ella pueden indicarse los puntos concretos en los que el módulo interactuará con la web.

La función devuelve un array de ítems en los que, a su vez, cada ítem es un array asociativo. Cada ítem representa un punto de interacción del módulo con la web para el que se definen algunas variables, como la ruta a través de la que se accederá, el título a mostrar en la página, la función a la que debe llamarse cuando se acceda a la ruta indicada, y los permisos que deben tener los usuarios para acceder a ella.

En el caso concreto del módulo indexer se definen dos ítems. El primer ítem representa la opción de configuración del menú de administración, y el segundo ítem la página a través de la que se mostrarán los índices. La variable type indica el tipo de interacción del módulo con la web. En el primer ítem es el de un menú estándar, y en el segundo ítem el de una función callback sin menú asociado.

El parámetro $may_cache que recibe la función indica si Drupal puede guardar en cache los ítems devueltos. Y la función t que se aplica a todas las cadenas de texto se encarga de gestionar la traducción de las mismas al idioma actual seleccionado para la web.

indexer_pem

Los permisos que se hayan indicado en la función indexer_menu del apartado anterior deben añadirse a la lista de permisos de la web a través de hook_perm.

Para este módulo sólo se ha creado un permiso nuevo, administer indexer, pero se pueden crear tantos como se quiera. Los que ya existieran previamente, como access content, no es necesario añadirlos.

El nuevo permiso aparecerá listado, como uno más, en la opción administrar->control de acceso.

indexer_help

La función hook_help permite indicar los textos de ayuda a mostrar en los distintos puntos de interacción del módulo con la web.

El parámetro $section contiene la ruta a la que se está accediendo, y lo que único que hace la función es retornar el texto con la ayuda correspondiente a la ruta dada.

indexer_adminis

Cuando un usuario de la web accede a la opción de menú administrar->indexer, Drupal llama a la función indexer_admin, tal y como se le indicó que hiciera en la función indexer_menu.

Esta función puede verse como si se llamara dos veces. La primera vez cuando el usuario accede al menú, para que el módulo construya el formulario. Y la segunda vez cuando pulsa el botón de guardar, para que el módulo valide y guarde la selección del usuario. En el código de la función aparece primero la parte que se encarga de recoger la selección del usuario, y después una segunda parte con la llamada a la función que se encarga de construir el formulario. Explicaré primero esta segunda parte.

El código de construcción del formulario está en la función _indexer_admin_display, que es una función privada, local al módulo, no un hook.

Para la construcción de formularios se utiliza un API proporcionado por Drupal que se compone de funciones de nombre form_xxx, como form_button, form_checkbox o form_textfield. El módulo indexer en concreto, utiliza una lista desplegable, form_select, donde se muestran todos los vocabularios dados de alta en la aplicación, y un botón, form_submit para guardar el vocabulario escogido. La lista de vocabularios mostrada en el desplegable se recupera de base de datos con la función _indexer_get_all_vocabularies que se verá más adelante.

A los controles del formulario se les asocian nombres, como indexer_vocabulary, para que cuando se pulse el botón de guardar, Drupal recoja los valores introducidos en cada control y los guarde en un array asociativo utilizando dichos nombres como clave.

Una vez visto como funciona el formulario de configuración, veamos que ocurre cuando Drupal llama a la función indexer_admin por segunda vez. En ese momento, en el parámetro ‘edit’ de $_POST, se encuentra el array asociativo con los valores tomados de los controles del formulario, lo que da la posibilidad de almacenarlos en base de datos, para que cuando se vuelva a abrir el formulario se puedan recuperar y aparezcan así dichos valores seleccionados.

Los valores se guardan en base de datos como variables, es decir, con un nombre asociado, a través de la función variable_set, y se recuperan con variable_get.

indexer_page

La función indexer_page es la encargada de construir las páginas con los índices. Drupal la ejecuta cuando un usuario de la web accede a la ruta indexer, tal y como se le indicó que hiciera en la función indexer_menu.

Esta función se comporta de forma distinta dependiendo de los parámetros que se indiquen en la URL. Si se indica el nombre de un término, como “Drupal”, entonces construye un listado de enlaces (links) a todos los nodos del término “Drupal”. Y si no se le indica el nombre de un término, entonces construye un listado con enlaces a todos los nodos de todos los términos del vocabulario por defecto.

La función se compone de tres partes. La primera parte en la que se extrae el nombre del término de la URL y se comprueba que sea un término válido existente en la tabla term_data. La segunda parte en la que se recupera el detalle del término indicado, o de todos los términos del vocabulario por defecto si no se especificó un término válido. Y una tercera parte en la que se accede a la tabla node, a través de term_node, para recuperar el título de los nodos con los que se construye el índice con la lista de enlaces.

El modelo de datos es sencillo y no debería suponer ningún problema interpretar las consultas. Como mucho comentar que en la última consulta se utiliza la condición status = 1 para recuperar sólo los nodos que hayan sido publicados.

Todos los accesos a base de datos que realiza el módulo utilizan el API de uno de los módulos de Drupal. Dicho API ofrece funciones del tipo db_xxx, como db_query o db_fetch_object, que permiten independizar el software de una base de datos concreta.

Los nombres de las tablas aparecen entre llaves “{}” para permitir que las funciones del API las detecten y modifiquen su nombre cuando se estén utilizando prefijos para los nombres de las tablas. Es decir, cuando hay varias versiones de Drupal instaladas en una misma base de datos, y para distinguirlas se ha añadido un prefijo a cada una de las tablas, como v463_xxx por ejemplo.

La función l se utiliza en Drupal para construir todos los enlaces (links) de una misma forma, muy importante cuando se tienen habilitadas las opciones de alias de URLs.

Miscelánea

Las funciones auxiliares, siguiendo la guía de estilo propuesto por los desarrolladores de Drupal, empiezan con un guión bajo.

La función _indexer_get_all_vocabularies se utiliza para obtener la lista de vocabularios dados de alta en base de datos.

Conclusiones

Uno de los puntos fuertes de Drupal es la facilidad con la que puede extenderse o modificarse el funcionamiento del mismo a través de módulos. No es frecuente encontrar software que lo ponga tan fácil.

En este artículo se ha expuesto el ejemplo de un módulo muy sencillo creado para la versión 4.6.3 de Drupal. Aunque ni se han implementado todos los hooks existentes, ni la forma en que se ha hecho es la única forma de construir un módulo.

A modo de resumen, y como aspecto positivo, señalar que hacer un módulo sencillo es relativamente fácil si se tiene cierta experiencia como programador y se sabe leer el modelo de datos. Drupal da bastantes facilidades a la hora de construir formularios, acceder a base de datos, e integrar el funcionamiento de nuestro módulo dentro del funcionamiento normal de Drupal. Aunque apuntar también que las APIs de Drupal parecen cambiar con cada nueva versión, y eso podría implicar tener que modificar el código de los módulos para que funcionen con cada nueva versión.