Configuración de Módulos EXM System

El archivo xoops_version.php se compone de una variable (matriz) que contiene toda la configuración básica para el módulo. Es precisamente este archivo el que lee exm para instalar y configurar un módulo específico, por tanto todos los módulos deben contar con este archivo.
La variable contenida en este archivo es $modversion y según sus índices se divide en las siguientes secciones:

Los archivo especificados en los índices ‘onInstall’, ‘onUninstall’ y ‘onUpdate’ deben contener funciones especiales que serán llamadas por EXM y dichas funciones deben ser las siguientes:

onInstall = xoops_module_install_modir(XoopsModule $module);
onUninstall = xoops_module_ninstall_modir(XoopsModule $module);
onUpdate = xoops_module_update_modir(XoopsModule $module, $tversion);

Las funciones deben dar como valor de retorno ‘true’ o ‘false’ dependiendo de si se complete con éxito o no. Además deben aceptar los parámetros $module que es el objecto XoopsModule que se esta instalando y en el caso de ‘onUpdate’ el parámetro $tversion que contiene la version actual del módulo.

Además es posible especificar un archivo de inclusión para el módulo. Este archivo será incluido automáticamente por EXM System en la zona donde se haya especificado.

Las zonas son las siguiente:

• common. Inlcuye el archivo en el archivo include/common.php después de la inclusión de el archivo include/functions.php, rmcommon, después de comprobar la seguridad.
• common_bottom. Incluye el archivo en el final del archivo include/common.php
• header. Incluye el archivo en el archivo header.php.
• footer. Incluye el archivo en el archivo footer.php.

Las opciones de configuración son las que permiten al módulo ser configurados desde EXM de manera automática. La configuración de los módulos en $modversion consta de dos partes o índices: category y config.

Tal y como se puede inferir del nombre de los índices category corresponde a la creación de categorías de configuración mientras que config son las opciones de configuración que existirán dentro de las categorías creadas. Un categoría se configura mediante los índices en $modversion de la manera siguiente: $modversion[‘category’][0][‘indice’], donde ‘0’ indica el número de categoría e índice los datos de la categoría.

Los índices para la creación de categorías de configuración son los siguientes:

Si en el archivo xoops_version.php no se han especificado categorías entonces EXM creará automáticamente la categoría de configuración general y todas las opciones de configuración serán asignadas a esta categoría.

El método para crear una opción de configuración es similar al de creación de categorías, de tal modo que debería ser algo como $modversion[‘config’][0][‘indice’], donde ‘0’ es un identificador numérico en el array e índice la opción.

Los índices de las opciones de configuración son los siguientes:

Un módulo para EXM puede contener o no una sección administrativa al igual que en XOOPS. Para habilitar esta opción es necesario establecerlo mediante $modversion de la manera siguiente:

Al igual que la sección administrativa, un módulo EXM puede contener una sección frontal, es decir, mostrar la sección donde los usuarios del sitio web interactuarán con el módulo. Para activar la sección frontal mediante $modversion es necesario crear los siguientes índices:

Adicionalmente se puede especificar un menú principal que se mostrará al usuario cuando navegue en las páginas del módulo. El menú se especifica con el índice ‘sub’ especificado en la tabal anterior y con los subindices:

El formato para crear un menú principal entonces sería:

$modversion[‘sub’][0][‘name’] = ‘Nombre del Menu’;
$modversion[‘sub’][0][‘url’] = ‘http://’;

La presentación del módulo, tanto en la sección frontal como en la sección administrativa, esta basada en plantillas Smarty. En EXM dichas plantillas deben compilarse antes de poder utilizarse para lo cual es necesario declararlas en el archivo xoops_version.php.
La declaración de las plantillas se realiza con el índice ‘templates’ de la manera siguiente:

$modversion[‘templates’][0][‘file’] = ‘nombre_del_archivo.html’;
$modversion[‘templates’][0][‘description’] = ‘Descripción del archivo’;

Estas líneas declarán una nueva plantilla que será compilada por EXM. El subíndice ‘file’ indica el nombre de un archivo que debe existir dentro de la carpeta templates del módulo ya que EXM buscará los archivos de plantillas solamente en esa carpeta.

Una de las características mas importantes de EXM al igual que en XOOPS es el manejo de bloques de módulos ya que estos agregán funcionalidad extra al sistema y al módulo mismo.

Para crear y administrar bloques en EXM es necesario que se especifiquen en el archivo xoops_version.php mediante el índice $modversion[‘blocks’] utilizando los siguiente subíndices:

Es posible modificar la base de datos de EXM en la instalación de un módulo para lo cual es necesario contar con un archivo sql y a su vez este debe ser especificado en el archivo de configuración de la siguiente manera:

Code:

$modversion["sqlfile"]["mysql"] = "sql/rmdp.sql";

Esto permite a EXM ejecutar este archivo durante la instalación del módulo y generar las tablas necesarias para el módulo.
Además, en caso de que el módulo cree tablas en la base de datos, será necesario especificar que tablas son para poder eliminarlas en la desinstalación del módulo. Esto se hace de la siguiente forma:

Code:

$modversion["tables"][0] = "rmdp_categos";

Al especificar este valor el módulo podrá limpiar la base de datos para evitar errores.

Estas son todas las opciones que debe contener el archivo xoops_version.php para la configuración del módulo.

1. ↑ Existen métodos alternativos para llamar a las plantillas Smarty sin necesidad de declararlas, sin embargo esos métodos no se tratan en este documento.
2. ↑ El valor de este subindice puede quedar vacío