Desarrollo de un módulo: Difference between revisions

Crea un subdirectorio sql en el directorio de tu módulo (por ejemplo, htdocs/mimodulo/sql), con el fin de color los scripts sql que vas a crear. A continuación, en la función load_tables de tu fichero descriptor, modifica la línea

  $dir = DOL_DOCUMENT_ROOT.'/mymodule/sql/';

por

  $dir = DOL_DOCUMENT_ROOT.'/mimodulo/sql/';

''Regla a respetar:''  

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 ficheros deben de ser operacionales para la base de datos '''mysql'''.

Copia allí el fichero '''skeletons_page.php''', que va a servir de punto de partida a tu pagina, y copia también el fichero '''pre.inc.php'''. Modifica el fichero '''pre.inc.php''' para que la ruta relativa de

  include("../../main.inc.php)";

sea la correcta, en función de la profundidad del directorio en el que se encuentra el fichero pre.inc.php (quitando o añadiendo "../"). Es en el "main" donde se carga el entorno técnico y las habilitaciones. Los objetos variables se posicionan ahora:

=== Completar su descriptor de módulo ===

En su descriptor de módulo, complete la declaración de this->const para añadir la constante MAIN_MODULE_mimodulo_NEEDSMARTY.

$this->const=array(1=>array('MAIN_MODULE_MIMODULO_NEEDSMARTY','chaine',1,'Need smarty',0));

Esto dará como resultado, durante la inicialización del objeto $conf, el llenado de $conf->need_smarty de los módulos que necesita de smarty y si un módulo es necesrio, el código de main.inc.php cargará sistemáticamente las librerías de Smarty.

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

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.

A continuación, rellena la tabla $this->rights con tantas entradas como permisos diferentes vayas 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], 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:

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

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

Ejemplo:

  this->boxes[0][1]='mabox0.php'

  this->boxes[1][1]='mabox1.php'

  ...

  this->boxes[n][1]='maboxn.php'

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

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)

  perl makepack-dolibarrmodule.pl

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:

  tar -xvf monmodule.tgz

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