Desarrollo de un módulo: Difference between revisions

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea

$this->_load_tables('/mymodule/sql/');

esté descomentada y correctamente configurada.

Ejemplo de contenido de un fichero data.sql

  delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';

  insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');

Las órdenes SQL de los archivos deben de ser operacionales para la base de datos '''mysql'''.

=== Generar la clase PHP de acceso (DAO) ===

Una vez que sus tablas estén creadas en la base de datos, vaya al directorio '''dev/skeletons''', copie el archivo '''build_class_from_table.php''' en el directorio sql/ de su módulo module, y ejecute el script

  php build_class_from_table.php nombretabla

Nota: Si el comando no funciona, intente con php-cli en lugar de php.

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

// Array to add new pages in new tabs or remove existing one

$this->tabs = array('objecttype:+tabname1:Title1:@mymodule:/mymodule/mynewtab1.php?id=__ID__',  // To add a new tab identified by code tabname1

                             'objecttype:+tabname2:Title2:@mymodule:/mymodule/mynewtab2.php?id=__ID__',  // To add another new tab identified by code tabname2

                             'objecttype:-tabname');                                                    // To remove an existing tab identified by code tabname

La tabla debe contener una lista de cadena, cada cadena representa una nueva pestaña.

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

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :

''Ejemplo :''

$id=$_GET["id"];

$product = new Product($db) ;

$result = $product->fetch($id) ; //Tester $result pour vérifier que l'accès à la base s'est bien passé

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

La tabla devuelta se compone de la siguiente manera :

$head        // Tableau des onglets

$head[$h]    // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher

$head[$h][1] // Titre de l'ongLet

$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)

''Ejemplo :''

$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions

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

dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')

$links  // Tableau des onglets, appelé $head plus haut.

//            service

//            company

Esta función muestra las pestañas deseadas y abre un elemento ''< div class="" >'' 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.

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

// Load Dolibarr environment

$res=0;

if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");

if (! $res) die("Include of main fails");

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:

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

''Ejemplo :''

dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:

''Ejemplo :''

require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';

=== Acceso a la base de datos ===

Para un ''insert'', ''update'' o ''delete'':

  $db->begin();  // Debut transaction

  $db->query("Ma requete insert, update ou delete");

  $db->commit();      // Valide

  o $db->rollback()  // Annule

Para una lectura:

  $resql=$db->query("Ma requete select");

  if ($resql)

         }

  }

=== Definición de estilos ===

=== 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:

  $form=new Form($db);

  $form->select_date('','mykey',0,0,0,"myform");

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:

  $mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);

  print strftime('%A %d %B %Y', $mydate);

== Definir su página de configuración (opcional) ==

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

Si su módulo ofrece varias opciones parametrizables, es necesario crear una página PHP para editar las opciones (que serán guardadas en la [[Table llx_const|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''').

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

=== Probar su página ===

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

// Main menu entries

$this->menu = array(); // List of menus to add

'user'=>2); // 0=Menu for internal users,1=external users, 2=both

$r++;

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.

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:

  $this->rights_class = 'mimodulo';

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

  $this->rights[$r][0] = 10001;

  $this->rights[$r][1] = 'Texto por defecto de mi permiso';

  $this->rights[$r][5] = 'subaccion';

  $r++;

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:

  if ($user->rights->mimodulo->accion->subaccion) ...

== Definir sus propios paneles (opcional) ==

Ejemplo:

$this->boxes[0]['file']='mabox0.php@mimodulo'

$this->boxes[0]['note']='Mi panel 0'

$this->boxes[n]['file']='maboxn.php@mimodulo'

$this->boxes[n]['note']='Mi panel n'

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)

El valor a indicar debe ser la ruta URL relativa de su archivo css.

Por ejemplo

$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));

=== Probar su hoja de estilos ===

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

require('../main.inc.php');

$morejs=array("/mimomulo/js/monmodule.js");

llxHeader('','Titulo','','','','',$morejs,'',0,0);  

== Ejecutar código sobre un evento Dolibarr (opcional) ==

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)

  perl makepack-dolibarrmodule.pl

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:

  tar -xvf monmodule.zip

* 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: {{LinkToPluginDownload}} (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).