Desarrollo de un módulo: Difference between revisions

Para crear un nuevo módulo hay distintas fases a seguir. Este tutorial tiene como meta describir cada una de estas fases con el fin de ayudar a comprender las posibilidades de Dolibarr, como por ejemplo añadir una o varias de las siguientes funcionalidades:

* Agregar nuevas tablas a la base de datos.

'''Cuándo''': Obligatorio cada vez que se desarrolla una extensión, cualquiera que sea su finalidad.

La primera fase es la de crear un fichero descriptor del módulo. Para ello, ve al directorio '''dev/skeletons''' y copia el fichero "modMyModule.class.php" en el directorio '''htdocs/includes/modules'''. A continuación, modifica el contenido de este fichero con el fin de reemplazar:

* los "modMyModule" por un valor que corresponda a la finalidad de tu módulo. Este valor debe siempre comenzar por mod.  

Ahora tu fichero descriptor está configurado.

Ejecuta Dolibarr y ve a la página "Configuration > Module". Debería aparecer una nueva línea con tu nuevo módulo y la posibilidad de activarlo o no (echa un vistazo a todas las pestañas de cada categoría para encontrarlo). Es el valor $this->special  el que determina en qué pestaña se encuentra tu módulo.

'''Cuándo:''' Si tu módulo necesita gestionar sus propios datos.

Si tu módulo de verdad requiere administrar datos que no existen en la base de datos en la versión estándar de Dolibarr, será necesario definir ciertas tablas SQL para registrar esos datos.

Una vez que los ficheros estén listos, puedes volver a Dolibarr para desactivar el módulo, eliminar las tablas de la base de datos y reactivar el módulo. Las tablas deben ser recreadas por la activación del módulo. Si no es así, verifica tus scripts o consulta los logs Dolibarr.

Una vez que tu/s tabla/s estén creadas en la base de datos, ve al directorio '''dev/skeletons''' y ejecuta el script

  php build_class_from_table.php nombretabla

'''Cuándo:''' Si tu módulo consiste en añadir funcionalidades que necesitan nuevas pantallas.

Debes crear a continuación pantallas PHP que se basen en los datos de tus tablas utilizando los esqueletos como ejemplo del directorio '''dev/skeletons'''. (Para el desarrollo de un script en línea de comandos, ver [[Desarrollar script]]).

Si necesitas realizar modificaciones en tu tabla de la base de datos, utiliza la clase generada más arriba.

  }

Para que el aspecto de la página guarde coherencia con el tema Dolibarr, es necesario utilizar los estilos CSS de Dolibarr.

Si quieres, puedes beneficiarte del selector de datos en las pantallas Dolibarr. Para ello, utiliza la siguiente línea:

  $form=new Form($db);

'''Cuándo:''' Si tu módulo ofrece varias opciones parametrizables.

Si tu módulo ofrece varias opciones parametrizacles, es necesario crear una página PHP para editar las opciones (que serán guardadas en la tabla '''llx_const'''). Crea una página PHP llamada '''mimodulo_setuppage.php''', que registre las opciones posibles y las ponga al día. Es necesario tomar como ejemplo una página de '''/admin''' que te muestre el método para leer o guardar en la base de datos tu opción. Coloca esta página de configuración también en el directorio '''/admin'''. A continuación, en el descriptor del módulo, modifica la variable para indicar el nombre de esta página PHP (no es necesario modificar la ruta, ya que la página estará forzosamente en el directorio '''/admin''').

  $this->config_page_url = array("monmodule_setupapage.php");

Ve a la página '''Configuración > módulo'''. Debería aparecer un icono que permite acceder a la página de configuración, y deberías poder modificar estas opciones y verlas en la base de datos.

'''Cuándo:''' Si has creado páginas PHP, es necesario que estas pantallas sean accesibles desde el menú Dolibarr.

Para ello, hace falta definir en el fichero descriptor de menú de tabla

  $this->menu

Desactiva y reactiva tu módulo bajo Dolibarr. Las entradas del menú deberían aparecer después de hacerlo.

'''Cuándo:''' Si quieres añadir nuevos permisos.

'''Cuándo:''' Si tu módulo tiene una o varias cajas.

Para ello, modifica las tablas $this->boxes del fichero descriptor de módulo. Es suficiente con añadir una línea por cada fichero de caja que se encuentre en el directorio '''htdocs/includes/boxes'''.

A continuación crea los ficheros mabox0.php, mabox1.php...  tomando como ejemplo las cajas existentes (en el directorio htdocs/include/boxes)

Ve al menú '''Bienvenida – Configuración – Caja'''. Tus cajas deben aparecer en la lista de cajas activables. Actívalas, ve a la página de bienvenida y verifica que se muestran correctamente.

'''Cuándo:''' Si tu módulo incorpora exportaciones predefinidas de datos (tanto para sus propias tablas o para otras tablas existentes de otros módulos de Dolibarr)

Para ello, descomenta y modifica las tablas $this->export_xxx  de tu fichero descriptor de módulo.

Ve al menú "Herramientas > Exportar" de Dolibarr. Tu exportación debería aparecer en la lista de exportaciones predefinidas disponibles (si tu módulo ha sido activado correctamente). Deberían aparecer, para que pudieras elegirlos, los campos que definiste en la fase anterior en las tablas correspondientes. Elige algunos campos y prueba a generar un fichero de exportación.

'''Cuándo:''' Si en tus pantallas PHP utilizas clases de estilos distintas a las de los temas de Dolibarr.

Esta funcionalidad todavía no es operativa en la versión 2.4., a pesar de estar ya descrita.

Esta funcionalidad ya no existe.

'''Cuándo:''' Si quieres que se ejecuten acciones particulares al activar ciertas acciones estandar de Dolibarr (por ejemplo, si deseáramos actualizar una tabla de mi módulo cada vez que se crea una factura en Dolibarr), hará falta crear un fichero '''disparador (triggers)'''.

Véase también [[Interfaces Dolibarr hacia el exterior]] e [[Interfaces Dolibarr hacia Dolibarr]]

* Ve al directorio '''/build''' y copia el fichero '''makepack-dolibarrmodules.conf''' como '''makepack-mimodulo.conf'''. Cuidado: este directorio puede no ser suministrado en los paquetes de versión estables. Si es el caso, puedes bajarte la última snapshot CVS  en la sección de Downloads del sitio de Dolibarr con el nombre “Development Version”1 (toma en este caso todos los directorios que sean autónomos e independientes de la versión).

  tar -xvf monmodule.tgz

Las reglas de código a seguir se definen en la [[Documentación Desarrolladores| Documentación para desarrolladores]], concretamente en la sección "Lenguaje" del capítulo de "Información General".