Desarrollo de un módulo

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:
 * Añadir nuevas tablas a la base de datos.
 * Añadir sus propias entradas en los menús.
 * Añadir pantallas de edición/consulta de nuevas tablas.
 * Añadir o eliminar pestañas en las páginas de vista/edición de objetos (factura, producto, pedido, evento, etc.)
 * Añadir exportaciones predefinidas a la función “Exportar”.
 * Añadir variables de substitución
 * Añadir nuevas cajas a la página de inicio.
 * Definir nuevos permisos.
 * Activar código automático sobre una acción particular de Dolibarr.
 * Insertar nuestro código mediante los hooks de Dolibarr
 * Añadir un módulo de numeración
 * Añadir un modelo de documento
 * Añadir un nuevo tema

etc. Todas estas operaciones sólo están disponibles a partir de la versión 3.2 de Dolibarr.

= Cear un módulo = Los capítulos siguientes describen las acciones a realizar para crear un módulo Dolibarr. Los primeros capítulos son obligatorios cualquiera que sea la vocación de los módulos, los siguientes dependerán de lo que deba hacer el módulo

[[File:Art.png]] Crear un descriptor de Módulo (obligatorio)
Cuándo: Obligatorio cada vez que se desarrolla una extensión, cualquiera que sea su finalidad.

Crear su descriptor
La primera fase es la de crear un fichero descriptor del módulo. Para ello: A continuación, modificar el contenido del archivo, reemplazando: ATENCIÓN: El MiModulo debe estar compuesto por una serie de caracteres, siendo los únicos permitidos [A-Za-z_] con longuitud max de MyModule de 12 caracteres. Ahora su fichero descriptor está configurado.
 * Crear el directorio /htdocs/mimodulo/core/modules. Seguidamente ir al directorio dev/skeletons y copiar el archivo modMyModule.class.php en el directorio htdocs/monmodule/core/modules.
 * los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
 * $this->numero = 100000 por un número de módulo que esté libre. Ver Listado de los id de módulos
 * Modificar eventualmente otras variables definidas por los desarrolladores (ver el comentario en el código del esqueleto para ver su significado)
 * Crear el directorio /htdocs/mimodulo/

Probar su descriptor
Ejecute Dolibarr y vaya a la página "Configuración > Módulo". Debería aparecer una nueva línea con su nuevo módulo y la posibilidad de activarlo o no (eche 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 su módulo.

[[File:Art.png]] Árbol de un nuevo módulo
Crear un directorio 'mimodulo' que contendrá los archivos del módulo. Este directorio debe de estar en el directorio htdocs y contendrá los siguientes subdirectorios:

[[File:Art.png]] Crear sus tablas SQL y la clase PHP con los métodos de acceso (opcional)
Cuándo: Si su módulo necesita gestionar sus propios datos.

Crear sus ficheros .sql
Si su 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.

Cree un subdirectorio sql en el directorio de su módulo (por ejemplo, htdocs/mimodulo/sql), con el fin de colocar los scripts sql que va a crear.

Regla a respetar:
 * Agregue los archivos de orden de creación de sus tablas siguiendo el principio de un fichero llx_mitabla.sql por tabla, eventualmente acompañado del archivo llx_mitabla.key.sql' (ver los archivos existentes en install/mysql/tables, para tomar ejemplo).
 * En términos de orden de gestión de datos, todos deben estar en un archivo llamado data.sql situado en la misma carpeta /mimodulo/sql/.

Ejemplo de contenido de un fichero data.sql

Las órdenes SQL de los archivos deben de ser operacionales para la base de datos mysql. Nota: Los archivos de otras bases de datos no se mantienen. Se leen y se convierten al vuelo por el driver de la base de datos.

Probar su archivo .sql
Una vez que los archivos estén listos, puede 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í, verifique sus scripts o consulte los logs Dolibarr.

Generar la clase PHP de acceso (DAO)
Una vez que su/s tabla/s estén creadas en la base de datos, vaya al directorio dev/skeletons, copie el archivo build_class_from_table.php en la el directorio sql/ de su módulo module, y ejecute el script Nota: Si el comando no funciona, intente con php-cli en lugar de php.

Esto genera un archivo out.nombretabla.class.php que contiene la clase de gestión de la tabla “nombretabla”. En esta clase se encuentran los métodos CRUD (Create/Read/Update/Delete) ya operativos para hacer un insert, un fetch (select), un update, y un delete de una línea de la tabla. Suprima justo el "out" del nombre del archivo y pógalo en un subdirectorio de htdocs propio en su módulo (Por ejemplo en htdocs/mimodulo).

Un archivo out.nombretabla_script.php se genera igualmente y contiene un ejemplo de código para utilizar la clase para cada uno de los cuatro métodos CRUD.

Añadir o eliminar pestañas en las fichas entidad
Cuándo : Para añadir su propia pestaña en las pestañas estandard de una ficha entidad (factura, pedido, presupuesto, miembro...)

Para ello, vaya al archivo descriptor del módulo creado anteriormente y modifique la tabla $this->tabs:

La tabla debe contener una lista de cadena, cada cadena representa una nueva pestaña. El formato de la cadena se compone de 4 partes separadas por ":"
 * Parte 1: El código de la entidad (objecttype) en la que debe aparecer la pestaña siendo el valor de ella misma:


 * Parte 2: El título de la pestaña. Puede ser una etiqueta directa o mejor un código de traducción de un archivo lang.
 * Parte 3: El nombre del archivo .lang (sin la extensión .lang) que contiene la correspondencia entre el código de traducción y la etiqueta a mostrar. Si el nombre empieza con @, Dolibarr buscará el archivo en el directorio lang del propio módulo, es decir, htdocs/mimodulo/langs/code_CODE/mimodulo.lang, de lo contrario Dolibarr buscará el archivo de en /langs/code_CODE/mimodulo.lang


 * Parte 4: La url de la página a mostrar cuando se haga click en las pestaña. La cadena __ID__ será reemplazada automáticamente por el Id de la entidad concerniente.

Para alimentar el contenido de la pestaña con los datos de la base de datos, vea el capítulo siguiente.

Añadir pestañas de una ficha entidad en su propia página
Cuándo : Para mostrar las pestañas estandard de ficha entidad (producto, tercero, etc.) en su propia pestaña de una entidad.

Hay que hacer lo siguiente :

1. Incluir los archivos que definen las funciones útiles dentro de sus archivos

Para cada ficha entidad, hay que incluir dos archivos con la instrucción

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
 * Entidad tercero (thirdparty) :
 * DOL_DOCUMENT_ROOT/societe.class.php
 * DOL_DOCUMENT_ROOT/lib/company.lib.php
 * Entidad producto (product) :
 * DOL_DOCUMENT_ROOT/product.class.php
 * DOL_DOCUMENT_ROOT/lib/product.lib.php
 * Entidad factura (invoice) :
 * DOL_DOCUMENT_ROOT/facture.class.php
 * DOL_DOCUMENT_ROOT/lib/invoice.lib.php

2. Crear y cargar el objeto a mostrar en su pestaña

Crear el objeto de la clase deseada, y recuperar los datos del objeto a partir de la base de datos. Para ello deberá utilizar las funciones fetch de la clase correspondiente, pasando el parámetro del indentificador del objeto que recupera desde la url (ej : /mononglet.php?id=1).

Ejemplo :

3. Recuperar la lista de pestañas correspondientes a la entidad seleccionada

Usar la función XXX_prepare_head($obj), donde XXX es le nombre de la entidad, para crear una tabla que contiene las definiciones de las pestañas a mostrar. El parámetro a pasar es el objeto del que desea mostrar las pestañas.

La tabla devuelta se compone de la siguiente manera :

Ejemplo :

4. Mostrar las pestañas en su pestaña

Use la función dol_fiche_head que muestra las pestañas contenidas en la tabla $head devuelta por XX_prepare_head.

Esta función muestra las pestañas deseadas y abre un elemento   que corresponde a la zona azul bajo las pestañas (si el parámetro $notab = 0). Para cerrar la zona azul, simplemente cierre el elemento < /div > en el código PHP.

Nota: Para más detalles, consulte la documentación Doxygen o directamente el código de Dolibarr.

Crear sus páginas pantalla PHP (opcional)
Cuándo: Si su módulo consiste en añadir funcionalidades que necesitan nuevas pantallas.

Crear una página pantalla PHP
Debe crear a continuación pantallas PHP que se basen en los datos de sus tablas utilizando los esqueletos como ejemplo del directorio dev/skeletons. (Para el desarrollo de un script en línea de comandos, ver Desarrollo de scripts).

Para crear una nueva página de usuario, cree un subdirectorio de htdocs (si es que no existe ya) propio en su módulo (En htdocs/mimodulo, por ejemplo), con el fin de ubicar en él las páginas que va a crear.

Copie allí el archivo skeletons_page.php, que va a servir de punto de partida a su página. Modifique el archivo para que la ruta relativa de

sea la correcta, en función de la profundidad del directorio en el que se encuentra el archivo (quitando o añadiendo "../"). Es en el "main" donde se carga el entorno técnico y las habilitaciones. Los objetos variables se posicionan ahora:
 * $user – El objeto que contiene las características del usuario y sus derechos.
 * $conf – El objeto que contiene la configuración de Dolibarr.
 * $db – El objeto que contiene el gestor de conexión abierto a la base de datos.
 * $langs – El objeto que contiene el idioma del usuario.

Exemple :
 * La inclusión de una clase o una biblioteca dedicada al módulo, sin saber a dónde se llamará el archivo, se realiza mediante una función de Dolibarr (no directamente mediante include_once):

Exemple :
 * Las clases de llamadas Dolibarr utilice la siguiente sintaxis:

Reemplazar partes de templates de pantalla (versión 3.3+)
Algunas partes de la pantalla de Dolibarr están aisladas en archivos de plantilla. Puede desarrollar un módulo para reemplazar una o más de estas plantillas con las suyas.

Acceso a la base de datos
Si necesita realizar modificaciones en su tabla de la base de datos, utilice la clase generada más arriba.

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

Para un insert, update o delete:

Para una lectura:

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

Por ejemplo:


 * class="liste_titre"1 en las etiquetas tr y td para una línea de título de tabla.
 * class=”pair” o class=”impair” en las etiquetas tr y td de las líneas de datos de la tabla.
 * class=”flat” en todos los campos en los que se teclea (input, select, textarea...)
 * class=”button” en los objetos de tipo input type=”submit”.

Utilizar el selector de fechas de Dolibarr
Si quiere, puede beneficiarse del selector de fechas en las pantallas Dolibarr. Para ello, utilice la siguiente línea:

La cadena "mikey" identifica el campo fecha. Hace falta introducir un valor diferente en caso de que haya varios campos. La cadena "myform" es el nombre del campo "FORM" (en el formulario, name="myform" de la página html). La visualización de un selector de fecha debe por tanto estar integrada en un formulario html.

Para recuperar el valor, a la herencia de POST, el comando es:

Definir su página de configuración (opcional)
Cuándo: Si su módulo ofrece varias opciones parametrizables.

Crear su página de edición de configuración
Si su 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). Cree 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 le muestre el método para leer o guardar en la base de datos su opción. Coloque esta página de configuración también en el directorio /admin. A continuación, en el descriptor del módulo, modifique 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 su página
Vaya 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ía poder modificar estas opciones y verlas en la base de datos.

Definir sus entradas de menú (opcional)
Cuándo: Si ha creado páginas PHP, es necesario que estas pantallas sean accesibles desde el menú Dolibarr.

Definir sus entradas de menú
Para ello, hace falta definir en el archivo 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 archivos 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

He aquí un ejemplo de declaración de entradas de menú en el fichero descriptor:

Para condicionar el acceso al menú segun los permisos, modificar la propiedad perms de la tabla. Ver el capítulo sobre permisos, un poco más abajo, para saber como realizar los permisos.

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

Definir sus propios permisos (opcional)
Cuándo: Si quiere añadir nuevos permisos.

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

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

En $this->rights[$r][0], introduzca 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], introduzca 1 si este permiso se atribuye por defecto a los usuarios según son creados. En $this->rights[$r][1] introduzca un texto por defecto -que será mostrado si no se encuentra traducción para su permiso en el archivo admin.lang). En $this->rights[$r][4] y $this->rights[$r][5], introduzca una cadena de acción y subacción sin espacios. Después puede probar si un usuario tiene los permisos bien, introduciendo la siguiente secuencia en el código PHP:

Definir sus propios paneles (opcional)
Cuándo: Si su módulo tiene uno o varios paneles.

Defina sus paneles
Para ello, modifique las tablas $this->boxes del archivo descriptor de módulo. Es suficiente con añadir 2 líneas por cada archivo de panel que se encuentre en el directorio htdocs/mimodulo/core/boxes.

Ejemplo:

A continuación cree los archivos htdocs/mimodulo/core/boxes/mabox0.php, htdocs/mimodulo/core/boxes/mabox1.php... tomando como ejemplo los paneles existentes (en el directorio htdocs/core/boxes)

Pruebe sus paneles en Dolibarr
Vaya al menú Inico – Configuración – Paneles. Sus paneles deben aparecer en la lista de paneles activables. Actívelos, vaya a la página de bienvenida y verifique que se muestran correctamente.

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

Definir la exportación
Para ello, descomente y modifique las tablas $this->export_xxx de su archivo descriptor de módulo.

Probar la exportación
Vaya al menú "Herramientas > Exportar" de Dolibarr. Su exportación debería aparecer en la lista de exportaciones predefinidas disponibles (si su módulo ha sido activado correctamente). Deberían aparecer, para que pudiera elegirlos, los campos que definió en la fase anterior en las tablas correspondientes. Seleccione algunos campos y pruebe a generar un archivo de exportación.

Definir sus estilos CSS (opcional)
Cuándo: Si en sus pantallas PHP utiliza clases de estilos distintas a las de los temas de Dolibarr (no recomendado).

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

Crear y declarar su hoja de estilos
Crear un archivo de estilos llamada mimodulo.css o mimodule.css.php y guardarla en el directorio mimodulo dentro de htdocs. Solo puede haber un archivo css propio a cada módulo. Recordamos que es mejor usar los estilos ya existentes en Dolibarr (el archivo css usado por Dolibarr es el archivo themes/nomtheme/nombretema.css.php.

Una vez su hoja de estilos esté disponible, declárela en su archivo descriptor de módulo modificando la propiedad $this->module_parts. El valor a indicar debe ser la ruta URL relativa de su archivo css. Por ejemplo

Probar su hoja de estilos
Desactivar y reactivar su módulo.

Ir la página de inicio de Dolibarr. Ver el código de la página HTML.

Debería ver en el encabezado HTML, una línea de declaración de su hoja de estilos.

Definir sus funciones Javascript (opcional)
Cuando: Si en sus pantallas en PHP utiliza funciones de Javascript no disponibles en estandard (archivo lib_head.js)

Si en sus pantallas en PHP utiliza funciones javascript, es necesario asegurarse de que las funciones declaradas en un archivo javascript htdocs/mimodulo/js/monmodule.js sea cargado en la cabecera del head html.

Para pedir a Dolibarr que gestione en la generación de la sección header la inclusión de uno de sus archivos javascript, es necesario proporcionar como parámetro a la función llxHeader, al inicio de su página, la URL hacia el js a incluir.

Ejemplo para la página /htdocs/mimodulo/mapage.php :

Ejecutar código sobre un evento Dolibarr (opcional)
Cuándo: Si quiere 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 archivo disparador (triggers).

Véase también Interfaces Dolibarr hacia el exterior e Interfaces del Exterior hacia Dolibarr

Insertar su código usando los hooks de Dolibarr (opcional)
Cuándo: Cuando desee cambiar o añadir otro tipo de código en un evento de negociado (véase lel capítulo anterior para esto).

Véase la página El sistema Hooks.

Añadir un módulo de numeración (opcional)
Cuándo: Si quiere añadir una regla de numeración no cubierta por los módulos por defecto.

Véase la página Crear un módulo de numeración.

Añadir un nuevo módulo de documento (opcional)
Cuándo: Si quiere añadir un nuevo modelo de documento.

La documentación relativa a la generación de documentos desde los modelos se encuentra disponible en la página Crear un modelo de documento PDF o Crear un modelo de documento ODT.

Añadir un tema (opcional)
Cuándo: Si quiere un interface con colores personalizados.

Véase la página Temas.

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

= Utilización de MDA = Un método para generar un módulo funcional desde UML se encuentra en curso de puesta a punto. Más información en la página UML2Dolibarr - Crear un módulo usando MDA.

= Crear un paquete para liberar e instalar su módulo = Este proceso debe ser usado para fabricar un paquete con el fin de enviarlo a la tienda oficial http://www.dolistore.com.

También puede usarlo para distribuir fácilmente su módulo vía su propio método de distribución.


 * Vaya al directorio /build y copie el archivo 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, puede bajarte la última snapshot en la sección de Downloads del sitio de Dolibarr con el nombre “Development Version” (tome en este caso todos los directorios que sean autónomos e independientes de la versión).

Teclee en este archivo la lista de nombres de los nuevos archivos que ha creado para su módulo (descriptor de módulo, nuevos ficheros sql de tablas, páginas php, imágenes, etc...)
 * Lance el script vía Perl (necesita la versión 5.0. o superiores de Perl)

El script le pide el nombre de su módulo, su versión mayor y menor. Se va a crear un fichero mimodulo.zip, que incluirá su módulo listo para ser liberado.
 * La persona que reciba su módulo deberá ubicar el archivo en el directorio raíz de Dolibarr y ejecutar el comando:


 * Si desea que su módulo sea aprovechado por todos, puede enviarlo (el fichero zip) al sitio web de Dolibarr, en la sección de descargas:  (debe de haber creado una cuenta y estar logeado para que aparezca el link "Submit a product").
 * Si su 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 desee).