Desarrollo de un módulo: Difference between revisions

'''Cuando''' : Para añadir su propia pestaña en las pestañas estandard de una ficha entidad (factura, pedido, presupuesto, miembro...)

'''Cuando''' : Para mostrar las pestañas estandard de ficha entidad (producto, tercero, etc.) en su propia pestaña de una entidad.

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

Si de todos modos quieres acceder a las tablas sin objeto PHP dedicado, esto es posible (por ejemplo para recuperar una lista de registros). En ese caso, piensa en seguir estos ejemplos.

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

= [[File:Art.png]] Definir tu página de configuración (opcional) =

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

==Crear tu página de edición de configuración==

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 [[Table llx_const|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''').

== Probar tu página ==

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.

= [[File:Art.png]] Definir tus entradas de menú (opcional) =

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

== Definir tus entradas de menú==

Para ello, hace falta definir en el fichero descriptor de menú de tabla this->menu, que declara los menús.

Esta tabla contiene todas las entradas que aparecerán en los menús una vez que el módulo sea activado. Los ficheros de descriptor de módulo contienen un ejemplo de cómo se declara el menú superior, así como las entradas correspondientes en el menú de la derecha

== Probar tus entradas de menú ==

Desactiva y reactiva tu módulo bajo Dolibarr. Las entradas del menú deberían aparecer después de hacerlo (si la condición 'enabled' está activada).

= [[File:Art.png]] Definir tus propios permisos (opcional) =

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

La definición de permisos que gestionará tu módulo se hace en el fichero descriptor creado en la primera fase. Modifica la línea $this->rights_class = 'facture' para que diga:

A continuación, rellena la tabla $this->rights con tantas entradas como permisos diferentes vayas a definir:

En $this->rights[$r][0], introduce un id de permiso que no haya sido ocupado ya (para saber qué id están siendo ya utilizadas, ver el menú '''Información del Sistema''' en una instalación de Dolibarr que esté funcionando. En $this->rights[$r][3], introduce 1 si este permiso se atribuye por defecto a los usuarios según son creados. En $this->rights[$r][1] introduce un texto por defecto -que será mostrado si no se encuentra traducción para tu permiso en el fichero '''admin.lang'''). En $this->rights[$r][4] y $this->rights[$r][5], introduce una cadena de acción y subacción sin espacios. Después puedes probar si un usuario tiene los permisos bien, introduciendo la siguiente secuencia en el código PHP:

= [[File:Art.png]] Definir tus propias cajas (opcional) =

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

== Define tus 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)

== Prueba tus cajas en Dolibarr ==

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.

= [[File:Art.png]] Definir tus propias exportaciones (opcional) =

'''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.

= [[File:Art.png]] Definir tus estilos CSS (opcional) =

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

= [[File:Art.png]] Definir tus funciones Javascript (opcional) =

'''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)'''.

= [[File:Art.png]] Crear un paquete para liberar e instalar tu módulo =

* 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).

Teclea en este archivo la lista de nombres de los nuevos ficheros que has creado para tu módulo (descriptor de módulo, nuevos ficherossql de tablas, páginas php, imágenes, etc...)

* Lanza el script vía Perl (necesitas la versión 5.0. o superiores de Perl)

El script te pide el nombre de tu módulo, su versión más reciente y la más antigua. Se va a crear un fichero '''mimodulo.tgz''', que incluirá tu módulo listo para ser desplegado.

* La persona que reciba tu módulo deberá ubicar el fichero en el directorio raíz de Dolibarr y ejecutar el comando:

* Si  deseas que tu módulo sea aprovechado por todos, puedes enviarlo(el fichero tgz) al sitio web de Dolibarr, en la sección de descargar: http://www.dolibarr.org -> downloads -> contrib -> submit a file (debes de haber creado una cuenta y estar logeado para que aparezca el link).

** Si tu módulo está correctamente realizado, será rápidamente validado.

** Si la calidad es suficiente, la licencia lo permite y la funcionalidad del módulo es de interés general, el código podrá añadirse al código fuente de Dolibarr (salvo que no lo desees).