Dolibarr ERP CRM Wiki - User contributions [en]

Table llx categorie societe

2016-11-11T03:36:11Z

Nnicolashr: /* Table */

[[Category:Table SQL]]
[[Category:Categories]]
[[Category:Catégories]]
[[Category:Categorías]]
{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains a "n to m" relationship between societies and the categories.

{{flag fr}} Contient une relation "n to m" entre les sociétés et les catégories.

{{flag sp}} Contiene una relación "n a m" entre las empresas y las categorías.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Field</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Null</b>
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Default</b>
|style="background-color: #e9e9ef"| <b>Extra</b>
|style="background-color: #e9e9ef"| <b>Description</b>
|-
| fk_categorie
| int(11)
| NO
| PRI
|
|
| ID of category ([[Table llx_categorie|llx_categorie]]->rowid)
|-
| fk_soc
| int(11)
| NO
| PRI
|
|
| ID of society ([[Table llx_societe|llx_societe]]->rowid)
|-
| import_key
| varchar(14)
| SÍ
|
| NULL
|
| import key
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Fields</b>
|-
| PRIMARY
| PRIMARY
| fk_categorie,fk_societe
|-
| idx_categorie_product_fk_categorie
| MULTIPLE
| fk_categorie
|-
| idx_categorie_product_fk_societe
| MULTIPLE
| fk_product
|} 

Table llx categorie societe

2016-11-11T03:35:52Z

Nnicolashr: /* Table */

[[Category:Table SQL]]
[[Category:Categories]]
[[Category:Catégories]]
[[Category:Categorías]]
{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains a "n to m" relationship between societies and the categories.

{{flag fr}} Contient une relation "n to m" entre les sociétés et les catégories.

{{flag sp}} Contiene una relación "n a m" entre las empresas y las categorías.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Field</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Null</b>
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Default</b>
|style="background-color: #e9e9ef"| <b>Extra</b>
|style="background-color: #e9e9ef"| <b>Description</b>
|-
| fk_categorie
| int(11)
| NO
| PRI
|
|
| ID of category ([[Table llx_categorie|llx_categorie]]->rowid)
|-
| fk_soc
| int(11)
| NO
| PRI
|
|
| ID of society ([[Table llx_societe|llx_societe]]->rowid)
|-
| import_key
| varchar(14)
| SÍ
|
|
| NULL
| import key
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Fields</b>
|-
| PRIMARY
| PRIMARY
| fk_categorie,fk_societe
|-
| idx_categorie_product_fk_categorie
| MULTIPLE
| fk_categorie
|-
| idx_categorie_product_fk_societe
| MULTIPLE
| fk_product
|} 

Table llx categorie societe

2016-11-11T03:35:04Z

Nnicolashr: /* Table */

[[Category:Table SQL]]
[[Category:Categories]]
[[Category:Catégories]]
[[Category:Categorías]]
{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains a "n to m" relationship between societies and the categories.

{{flag fr}} Contient une relation "n to m" entre les sociétés et les catégories.

{{flag sp}} Contiene una relación "n a m" entre las empresas y las categorías.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Field</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Null</b>
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Default</b>
|style="background-color: #e9e9ef"| <b>Extra</b>
|style="background-color: #e9e9ef"| <b>Description</b>
|-
| fk_categorie
| int(11)
| NO
| PRI
|
|
| ID of category ([[Table llx_categorie|llx_categorie]]->rowid)
|-
| fk_soc
| int(11)
| NO
| PRI
|
|
| ID of society ([[Table llx_societe|llx_societe]]->rowid)
|-
| import_key
| varchar(14)
| SÍ
|
|
|
| import key
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Fields</b>
|-
| PRIMARY
| PRIMARY
| fk_categorie,fk_societe
|-
| idx_categorie_product_fk_categorie
| MULTIPLE
| fk_categorie
|-
| idx_categorie_product_fk_societe
| MULTIPLE
| fk_product
|} 

Table llx facture rec

2016-11-09T04:09:46Z

Nnicolashr:

[[Category:Invoices]]
[[Category:Facture]]
[[Category:Facturas]]
[[Category:Table SQL]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the predefined invoices. The invoice details are in [[Table llx_facturedet_rec]]

{{flag fr}} Contient les factures prédéfinies. les détails de la facture sont dans la [[Table llx_facturedet_rec]]

{{flag sp}} Contiene las facturas predefinidas. Los detalles de la factura se encuentran en la [[Table llx_facturedet_rec]]

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Field</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Null</b>
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Default</b>
|style="background-color: #e9e9ef"| <b>Extra</b>
|style="background-color: #e9e9ef"| <b>Description</b>
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
|-
| titre
| varchar(50)
| NO
| UNI
|
|
| title
|-
| entity
| int(11)
| NO
| UNI
| 1
|
| multi company id
|-
| fk_soc
| int(11)
| NO
| MUL
|
|
| ID society ([[Table llx_societe|llx_societe]]->rowid)
|-
| datec
| datetime
| YES
|
| NULL
|
| creation date
|-
| amount
| real
| NO
|
| 0
|
| amount
|-
| remise
| real
| YES
|
| 0
|
| discount
|-
| remise_percent
| real
| YES
|
| 0
|
| percent discount
|-
| remise_absolute
| real
| YES
|
| 0
|
| absolut discount
|-
| tva
| real
| YES
|
| 0
|
| VAT
|-
| total
| real
| YES
|
| 0
|
| total
|-
| total_ttc
| real
| YES
|
| 0
|
| total with tax
|-
| fk_user_author
| int(11)
| YES
| MUL
| NULL
|
| ID of user author of invoice ([[Table llx_user|llx_user]]->rowid)
|-
| fk_projet
| int(11)
| YES
| MUL
| NULL
|
| ID of related proyect ([[Table llx_projet|llx_projet]]->rowid)
|-
| fk_cond_reglement
| int(11)
| NO
|
| 0
|
| Id of payment condition ([[Table llx_cond_reglement|llx_cond_reglement]]->rowid)
|-
| fk_mode_reglement
| int(11)
| NO
|
| 0
|
| Id of payment mode
|-
| date_lim_reglement
| date
| YES
|
| NULL
|
| date limit for payment
|-
| note
| text
| YES
|
| NULL
|
| comentary
|-
| note_public
| text
| YES
|
| NULL
|
| public comentary
|-
| frequency
| char(2)
| YES
|
| NULL
|
| invoice frequency
|-
| last_gen
| varchar(7)
| YES
|
| NULL
|
|
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Fields</b>
|-
| PRIMARY
| PRIMARY
| rowid
|-
| idx_facture_rec_uk_titre
| UNI
| titre, entity
|-
| idx_facture_rec_fksoc
| MULTIPLE
| fk_soc
|-
| idx_facture_rec_fk_soc
| MULTIPLE
| fk_soc
|-
| idx_facture_rec_fk_user_author
| MULTIPLE
| fk_user_author
|-
| idx_facture_rec_fk_projet
| MULTIPLE
| fk_projet
|} 

Table llx facture rec

2016-11-09T04:06:03Z

Nnicolashr: Undo revision 36454 by Nnicolashr (talk)

[[Category:Invoices]]
[[Category:Facture]]
[[Category:Facturas]]
[[Category:Table SQL]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the predefined invoices. The invoice details are in [[Table llx_facturedet_rec]]

{{flag fr}} Contient les factures prédéfinies. les détails de la facture sont dans la [[Table llx_facturedet_rec]]

{{flag sp}} Contiene las facturas predefinidas. Los detalles de la factura se encuentran en la [[Table llx_facturedet_rec]]

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Field</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Null</b>
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Default</b>
|style="background-color: #e9e9ef"| <b>Extra</b>
|style="background-color: #e9e9ef"| <b>Description</b>
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index {{flag sp}} Índice técnico
|-
| titre
| varchar(50)
| NO
| UNI
|
|
| title
|-
| entity
| int(11)
| NO
| UNI
| 1
|
| multi company id
|-
| fk_soc
| int(11)
| NO
| MUL
|
|
| ID society ([[Table llx_societe|llx_societe]]->rowid)
|-
| datec
| datetime
| YES
|
| NULL
|
| creation date
|-
| amount
| real
| NO
|
| 0
|
| amount
|-
| remise
| real
| YES
|
| 0
|
| discount
|-
| remise_percent
| real
| YES
|
| 0
|
| percent discount
|-
| remise_absolute
| real
| YES
|
| 0
|
| absolut discount
|-
| tva
| real
| YES
|
| 0
|
| VAT
|-
| total
| real
| YES
|
| 0
|
| total
|-
| total_ttc
| real
| YES
|
| 0
|
| total with tax
|-
| fk_user_author
| int(11)
| YES
| MUL
| NULL
|
| ID of user author of invoice ([[Table llx_user|llx_user]]->rowid)
|-
| fk_projet
| int(11)
| YES
| MUL
| NULL
|
| ID of related proyect ([[Table llx_projet|llx_projet]]->rowid)
|-
| fk_cond_reglement
| int(11)
| NO
|
| 0
|
| Id of payment condition ([[Table llx_cond_reglement|llx_cond_reglement]]->rowid)
|-
| fk_mode_reglement
| int(11)
| NO
|
| 0
|
| Id of payment mode
|-
| date_lim_reglement
| date
| YES
|
| NULL
|
| date limit for payment
|-
| note
| text
| YES
|
| NULL
|
| comentary
|-
| note_public
| text
| YES
|
| NULL
|
| public comentary
|-
| frequency
| char(2)
| YES
|
| NULL
|
| invoice frequency
|-
| last_gen
| varchar(7)
| YES
|
| NULL
|
|
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Fields</b>
|-
| PRIMARY
| PRIMARY
| rowid
|-
| idx_facture_rec_uk_titre
| UNI
| titre, entity
|-
| idx_facture_rec_fksoc
| MULTIPLE
| fk_soc
|-
| idx_facture_rec_fk_soc
| MULTIPLE
| fk_soc
|-
| idx_facture_rec_fk_user_author
| MULTIPLE
| fk_user_author
|-
| idx_facture_rec_fk_projet
| MULTIPLE
| fk_projet
|} 

Table llx facture rec

2016-11-09T04:05:27Z

Nnicolashr: /* Structure */

Table llx facture rec

2016-11-09T04:04:49Z

Nnicolashr: /* Table */

[[Category:Invoices]]
[[Category:Facture]]
[[Category:Facturas]]
[[Category:Table SQL]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the predefined invoices. The invoice details are in [[Table llx_facturedet_rec]]

{{flag fr}} Contient les factures prédéfinies. les détails de la facture sont dans la [[Table llx_facturedet_rec]]

{{flag sp}} Contiene las facturas predefinidas. Los detalles de la factura se encuentran en la [[Table llx_facturedet_rec]]

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Field</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Null</b>
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Default</b>
|style="background-color: #e9e9ef"| <b>Extra</b>
|style="background-color: #e9e9ef"| <b>Description</b>
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index {{flag sp}} Índice técnico
|-
| titre
| varchar(50)
| NO
| UNI
|
|
| title
|-
| entity
| int(11)
| NO
| UNI
| 1
|
| multi company id
|-
| fk_soc
| int(11)
| NO
| MUL
|
|
| ID society ([[Table llx_societe|llx_societe]]->rowid)
|-
| datec
| datetime
| YES
|
| NULL
|
| creation date
|-
| amount
| real
| NO
|
| 0
|
| amount
|-
| remise
| real
| YES
|
| 0
|
| discount
|-
| remise_percent
| real
| YES
|
| 0
|
| percent discount
|-
| remise_absolute
| real
| YES
|
| 0
|
| absolut discount
|-
| tva
| real
| YES
|
| 0
|
| VAT
|-
| total
| real
| YES
|
| 0
|
| total
|-
| total_ttc
| real
| YES
|
| 0
|
| total with tax
|-
| fk_user_author
| int(11)
| YES
| MUL
| NULL
|
| ID of user author of invoice ([[Table llx_user|llx_user]]->rowid)
|-
| fk_projet
| int(11)
| YES
| MUL
| NULL
|
| ID of related proyect ([[Table llx_projet|llx_projet]]->rowid)
|-
| fk_cond_reglement
| int(11)
| NO
|
| 0
|
| Id of payment condition ([[Table llx_cond_reglement|llx_cond_reglement]]->rowid)
|-
| fk_mode_reglement
| int(11)
| NO
|
| 0
|
| Id of payment mode
|-
| date_lim_reglement
| date
| YES
|
| NULL
|
| date limit for payment
|-
| note
| text
| YES
|
| NULL
|
| comentary
|-
| note_public
| text
| YES
|
| NULL
|
| public comentary
|-
| frequency
| char(2)
| YES
|
| NULL
|
| invoice frequency
|-
| last_gen
| varchar(7)
| YES
|
| NULL
|
|
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| <b>Key</b>
|style="background-color: #e9e9ef"| <b>Type</b>
|style="background-color: #e9e9ef"| <b>Fields</b>
|-
| PRIMARY
| PRIMARY
| rowid
|-
| idx_facture_rec_uk_titre
| UNI
| titre, entity
|-
| idx_facture_rec_fksoc
| MULTIPLE
| fk_soc
|-
| idx_facture_rec_fk_soc
| MULTIPLE
| fk_soc
|-
| idx_facture_rec_fk_user_author
| MULTIPLE
| fk_user_author
|-
| idx_facture_rec_fk_projet
| MULTIPLE
| fk_projet
|} 

Crear un modelo de documento PDF

2016-11-03T18:41:54Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Cambiar nombre del modelo en línea: Original --> "$this->name = "azur";", Nueva --> $this->name = "masocietebleu";
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Probar este modelo, antes de continuar, para ello seguir los siguientes pasos:
# En directorio /htdocs/core/modules/propale/doc poner la copia de la nueva plantilla (Dolibarr versión 3.9.2)
# Ir al sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
# Activar nueva plantilla en sección: Modelos de documentos de presupuestos
# Ir al sistema Dolibarr-->Comercial-->Listado de Presupuestos-->Seleccionar un presupuesto
# En sección Documentos, seleccionar nueva plantilla
# Presionar botón: Generar
# Verificar que se genera archivo PDF y abrirlo, se espera que se abra con éxito sin errores
* Borrar indicios de prueba de plantilla después de desactivar
# Desactivar en sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
# Mover archivo de plantilla desde directorio /htdocs/core/modules/propale/doc
# Eliminar registro creado en tabla llx_document_model

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Desarrollo Canvas

2016-10-15T02:32:54Z

Nnicolashr: /* Condiciones */

{{TemplateDocDesarrollo}}

Canvas es una funcionalidad destinada a desarrolladores para reemplazar a las pantallas de creación, actualización o visualización de fichas (productos, terceros, contactos, ...).

Por ejemplo, puede reemplazar el formulario de creación de terceros, el de actualización o el de visualización.

= Condiciones =
La funcionalidad Canvas se encuentra disponible con Dolibarr 3.2 o superior.

De momento disponible solamente para:
* formulario de creación de productos, contactos y terceros
* formulario de edición de productos, contactos y terceros
* pestaña visualización de productos, contactos y terceros. En la mayoría de los casos es la primera pestaña al abrir la ficha de un objeto. Puede echar un vistazo a la documentación de como crear un módulo nuevo para saber como desactivar o añadir otras pestañas, si es que lo necesita.

= Reemplazar un formulario de creación con su página canvas =
{{ToComplete}}

Lenguaje y Normas de Desarrollo

2016-10-15T02:24:16Z

Nnicolashr: /* Tabla structura */

{{TemplateDocDesarrollo}}

He aquí algunas normas sobre el lenguaje, la sintaxis y las norma de desarrollo en vigor para el proyecto Dolibarr:

= Versiones =

* Dolibarr debe funcionar con:
# Todos los SO (Windows, Linux, MACOS...)
# PHP {{PHPMinVersion}} (Debe funcionar sin ningún módulo PHP complementario, exceptuando los módulos de acceso a la base de datos).
# Mysql {{MySqlMinVersion}}

= Normas de Copyright =
* Todos los archivos PHP deben empezar con una cabezara como
<source lang="php">
<?php
/* Copyright (C) YYYY John Doe <email@email.com>
*
* Licence information
*/
...
</source>

Si edita un archivo existente del proyecto, debe añadir una línea de Copyright debajo de las otras.

= Normas PHP =

* Dolibarr está escrito en PHP y soporta todas las versiones de PHP superiores a la {{PHPMinVersion}}. Todos los archivos deben de contener la extensión .php

* La llamada a las variables superglobales PHP deben pasar a través de los operadores dedicados $_COOKIES, $_SERVER, $_ENV y a través de la función dolibarr GETPOST() para obtener el contenido de$_GET o $_POST...
Los otros operadores ($HTTP_SERVER_GET, ...) están siendo depreciados en el seno de PHP, no deben de ser ya utilizados. Por lo tanto, el código debe funcionar incluso cuando la opción '''register_long_arrays''' esté en off.
Además de que el código debe funcionar cuando la opción de PHP '''register_globals''' esté en off (recomendado por PHP), también lo deberá hacer cuando la opción '''register_globals''' esté en on (por defecto en muchas instalaciones).

* Los smart tags PHP no són utilizados. Las secciones de código deben de empezar por '''<?php'''

* No se permite el uso de la variable '''PHP_SELF'''. Utilice en su lugar $_SERVER["PHP_SELF"]

* Cuando varias variables deben ser inicializadas con el mismo valor, utilice múltiples líneas
<source lang="php">
$var1=1;$var2=1;$var3=1;
</source>
en lugar de
<source lang="php">
$var1=$var2=$var3=1;
</source>
que es menos eficiente.

* las cadenas deben de ser encuadradas con comillas simples y las variables sacadas de la cadena.
<source lang="php">
print 'Mi texo muestra mi '.$variable.' !';
</source>

* Los comentarios deben seguir la sintaxis de C, es decir, una doble barra invertida para una línea de comentario y el uso de una barra con arterisco para abrir un bloque de varias líneas
<source lang="php">
/* Bloque de comentarios
*
* Fin el bloque
*/

$monobjet = new MonObjet($db);
$result=$monobjet->fetch($idobject);

for ($i = 1 , $i < 2 ; $i++)
{
// comentario de una línea
print $i;
}

</source>

* Los ficheros deben ser guardados en formato Unix (LF) y no en formato Windows (CR/LF). El formato Unix es compatible con los SO Unix, Windows, Mac, mientras que el formato de archivo de texto de Windows es problemático en algunos PHP en Unix.

* Las funciones deben devolver >0 en caso de éxito, y un número <0 en caso de error.

* Sin código muerto (no usado) en el código principal de Dolibarr (El código usado únicamente por un módulo externo debe ser incluido en el módulo externo).

* Usar "include_once" para la inclusión de todo archivo que contenga definiciones de funciones o de clases (archivos *.class.php y *.lib.php), usar "include" para la inclusión de archivos de tipo template o que contenga una mezcla de HTML y PHP (archivos *.inc.php et *.tpl.php).

= Normas SQL =

== Estructura de Tabla ==
* Todas las tablas tienen prefijo para evitar conflictos de nombres. A día de hoy, el prefijo está determinado y no se puede cambiar. Su valor es <tt>llx_</tt>. Sin embargo, está pendiente de considerar, en una futura versión, el poder cambiarlo en el momento de la instalación.

* En la práctica, con la finalidad de set compatible con todas las precisiones de los paises, utilizaremos los siguientes tipos:
- integer para cualquier foreign key
- double(24,8) para cualquier importe
- double(6,3) para las tasas de IVA
- real para una cantidad
- varchar para una cadena (incluidos los de longitud 1, el tipo char se está depreciando)
- timestamp para fecha+hora que deba ser actualizado automáticamente
- datetime para fecha+hora
- date para fecha

== Clave primaria ==
La clave primaria de una tbla se llama <tt>rowid</tt>.

Hay unas pocas tablas que incumplen la norma ahora (ej [[Table llx_c_actioncomm]]), por razones históricas. Podrá ser estudiada una evolución para una próxima versión.

== Clave secundaria ==
El nombre de una clave secundaria empieza con el prefijo <tt>fk_</tt> seguido por el nombre de la tabla vinculada (necesario para evitar duplicaciones globales en la base de datos, problemáticas en algunos RDBMS como postgresql), seguido del campo vinculado (para permitir diferentes claves secundarias en la misma tabla).

Ejemplo:
fk_facture_fourn_fk_soc

== Clave alternativa ==

A veces no sólamente la clave primaria debe ser única. Por lo tanto, podemos añadir un índice de clave única alternativa. Este índice es llamado por un nombre que comienza con el prefijo <tt>uk_</tt> seguido por el nombre de la tabla (necesario para evitar la duplicación de índeces globales en la base de datos, problemáticos en algunos DBMS como postgresql) y de un sufijo que caracterice a la clave (para permitir múltiples índices en una sola tabla).

Ejemplo:
uk_societe_code_client

== Indices de rendimiento ==
Algunos campos se utilizan a menudo como un criterio para la búsqueda, clasificación o afiliación. Conviene en este caso, poner un índice de rendimiento. Tales índices se llamarán con un prefijo <tt>idx_</tt> seguidos del nombre de la tabla y el nombre del campo en el que el índice trabaja.

Ejemplo:
idx_societe_user_creat

== Formato de fichero DDL ==
Los ficheros que contienen la definición de la estructura de la base de datos (DDL) deben de estar repartidos en dos tablas:
* Cada tabla se define en su propio archivo cuyo nombre es <tt>llx_''mitabla''.sql</tt>
Donde habrá un comentario junto a cada campo para explicar su significado.
* Claves de relacionales y el índice de rendimiento o otras constraints de carácter único se definen en un archivo cuyo nombre es <tt>llx_''mitable''.key.sql</tt>

Estos ficheros se guardan el la carpeta '''install/mysql/tables''' para los ficheros standards ó '''mimodulo/tables''' para las tablas llevadas por un módulo.

Ejemplos '''Fichero tabla llx_matable.sql''':

<source lang="sql">
-- ===========================================================================
-- Copyright (C) 2008 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================

create table llx_matable
(
rowid integer AUTO_INCREMENT PRIMARY KEY,
field_one integer,
field_two integer NOT NULL,
fk_field integer,
field_date datetime,
tms timestamp
)type=innodb;
</source>

Ejemplos '''Fichero de claves/índices llx_matable.key.sql'''

<source lang="sql">
-- ===========================================================================
-- Copyright (C) 2008 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================

ALTER TABLE llx_matable ADD UNIQUE uk_matable_field(field_one, field_two);

ALTER TABLE llx_matable ADD CONSTRAINT fk_matable_fk_field FOREIGN KEY (fk_field) REFERENCES llx_matablepere (rowid);
</source>

== SQL Coding rules ==
* Uso de alias / nombres de los campos
Dentro de los selects pueden utilizar alias para simplificar la redacción de las consultas:
<source lang="sql">
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
</source>
Sin embargo, no debemos utilizar este alias en las consultas de actualización porque no es compatible con mysql 3.1.

* ¡Los SELECT * están prohibidos! Cada Select deberá especificar la lista completa de los campos para recuperar. Esto permitirá evitar confusiones. Ejemplo:
<source lang="sql">
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
</source>

* En las consultas SQL, entrecomillaremos los campos, pero no los numéricos que contengan cantidades que se almacenen en los campos de tipo double o real. Los entrecomillados en los numéricos de tipo float se almacenan con un valor diferente. Por ejemplo 412.62 dentro del insert se guardara con el valor 412.61999512 en base si el campo es de tipo double(24,8). Y PHP sólo ve 412.61999512. Otras herramientas verán 412.62 dando la impresión de que no hay problemas. Y PHP tiene razón, hay un problema en base. Mediante la eliminación de las comillas en los numéricos, esto irá mejor.

Ejemplo:
<source lang="sql">
Bien:INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
Mal: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
</source>

Nota, el problema de los float es general y no sólamete en el acceso a la base de datos, está presente en todos los lenguajes cuando trabajamos sobre números reales, por lo que deberán ser limpiados por la función price2num con el segundo parámetro rellenado con:
'MU', 'MT' ó 'MS' según sea necesario. Consulte el capítulo "Los números reales, importes y cálculos" más abajo.

* las funciones NOW, SYSDATE ó IFNULL están prohibidas en las órdenes de SQL. Si se necesita indicar la fecha del momento en un campo, el valor debe provenir de PHP y no del motor de la base de datos. Esto además de ofrecer una mejor portabilidad del código, también permite una gestión correcta de la zona horaria.

== Reglas de migración de base de datos ==
* Los scripts de migración de estructura se encuentran en el directorio '''install/mysql/migration/a.b.c-x.y.z.sql'''. En un archivo de migración de n a n+1, no destruiremos una tabla (DROP TABLE) que no sea utilizada en n+1, se realizará en la migración de la versión n+1 a n+2. Esto tiene el fin de conservar las tablas depreciadas durante una versión para poder reparar una situación de error de migración.

== Particularidades de MySQL ==

* Las tablas deben de estar en formato InnoDB.
En efecto, este formato soporta claves secundarias, las eventuales restricciones que se adjuntan y la noción de integridad de transacciones requeridas para obteter datos coherentes entre tablas en la base de datos.

* Dolibarr debe trabajar incluso con la opción '''strict''' de Mysql activa.
Para activarla, añada la siguiente línea en su archivo config del servidor MySql (my.cnf o my.ini)
<source lang="ini">
sql-mode="STRICT_ALL_TABLES,ONLY_FULL_GROUP_BY,NO_ZERO_DATE"
</source>

== Particularidades de PostgreSQL ==
Sólo los archivos de MySQL deben mantenerse.
Los archivos para otras bases de datos se convierten "al vuelo" por el gestor de la base de datos.

= Normas HTML =

* Todos los atributos de las etiquetas HTML deben de estar *en minúscula* y entrecomillados con *doble comilla*.

* Los enlaces href deben de ser absolutos. para las páginas, basarse en la function dol_buildpath(). Para las imágenes basarse en la llamada de la función img_picto.
Por ejemplo:
<source lang="php">
print '<a href="'.dol_buildpath('/monrep/mapage.php').'">'.img_picto('Texte alt','nompictopng','').'</a>';
</source>

* Las tablas HTML deben tener las columnas sin valores forcados, a excepción de las columnas que contienen información cuya longitud no es variable. Por ejemplo, una columna con una imagen puede forzarse a un with="20px". En los otros casos, hay que evitar forzar la longitud de las columnas. Esto es porque en la mayoría de los casos el navegador realiza un buen trabajo al definir automáticamente la longitud de las columnas, independientemente de la resolución de la pantalla.

* Javascript/ajax y la llamada a scripts java en las páginas php está fuera de las normas. Si de todas maneras se incluye código javascript, debe estar condicionado mediante el test "$conf->use_javascript_ajax"
<source lang="php">
if ($conf->use_javascript_ajax) {
... // El código PHP que genera el javascript va aquí
}
</source>

* Las ventanas emergentes no deben de ser utilizadas, exceptuando los tooltips (y quedan condicionados por el punto anterior).

* Los scripts externos son escritos en Perl si no pueden serlo en php, la utilización de otro lenguaje no está prohibido, pero debe de ser discutido priero en la lista de correo de desarrollo.

= Normas Dolibarr y plantillas de código =

== Plantillas de código ==
Para estandarizar el código y acelerar el desarrollo de nuevos componentes en Dolibarr, en la carpeta '''dev/skeletons''' encontraremos 4 plantillas de código preparadas.

* 1 que sirve de ejemplo de descriptor de módulo: '''myModule.class.php'''
* 1 que sirve de ejemplo de código para crear una nueva clase: '''skeleton_class.class.php'''
* 1 que sirve de ejemplo de código para crear una nueva página: '''skeleton_page.php'''
* 1 que sirve de ejemplo de código para crear una nuevo script a ejecutar en línea de comandos: '''skeleton_script.php'''

Úsenlas como ejemplo.
Tenga en cuenta que estas plantillas también son utilizadas por el generador de código PHP que se describe en el capítulo de Desarrollo de módulos Dolibarr módulo para acelerar su desarrollo.

== Las fechas y la Zona Horaria ==
Dolibarr es una aplicación multi-usuario y multi-ubicación. Por lo tanto, es necesario almacenar las fechas en el formato correcto. Para evitar problemas de conversión, deben aplicarse las siguientes reglas:
* Una fecha en memoria debe de estar en formato Timestamp GMT.
* Una fecha guardada en la base de datos contiene el Timestamp GMT en relación con la fecha que figura en la consulta en hora local <b>del servidor PHP</b>. No se trata de las fechas de actualización de la base de datos (campo '''tms''' en la base de datos).
Por lo tanto, el 1 de enero de 1970, a las 3 en París (TZ=+1) = las 2 en Greenwitch (TZ=0) será almacenado en memora 7200 y será enviado a la base de datos con la cadena '19700101030000' (PHP convierte en hora de su TZ y la base de datos la deconvierte con su TZ que es la misma que la de PHP).

Los métodos select deben traducir los campos fecha al formato de cadenta TZ de la base ('19700101030000') mediante la llamada del método db->jdate para recuperar la información en memoria en formato Timestamp GMT. Y los métodos insert deben deben generar la petición convirtiendo la fecha en memoria conocida en variable, mediante el método db->idate (Ver ejemplos generados por la plantilla).

* Las actualizaciones automáticas de la base de datos (campo '''tms''' en la base) contienen el Timestamp GMT del momento en que se ha realizado la modificación. Los métodos select recuperan directamente este dato en memoria en formato Timestamp GMT.

* La manipulación de fechas en PHP debe realizarse usando las funciones de fechas de Dolibarr: '''dol_now(), dol_mktime(), dol_stringtotime(), dol_getdate(), dol_time_plus_duree()'''. También se encuentran otras funciones listas para su uso en el archivo date.lib.php.

== Codificación UTF8/ISO ==
Dolibarr guarda la información de la manera siguiente:

* En la base de datos, los datos en UTF8 ó ISO. Esto depende del pagecode de la base de datos, y por lo tanto, de las opciones en la creación de esta base de datos. En todos los casos, el controlador de base de datos Dolibarr (dentro de /lib/database) lee e inserta por conversión desde y hacia UTF8.
* Los datos en memoria se guardan en UTF8 (instancias de objetos PHP).
* las páginas web mostradas en pantalla se encuentran en formato UTF8 (con versiones < 2.5.1, es el antiguo parámetro $character_set del fichero conf.php quien define el formato de salida).

== Los números reales, importes y cálculos ==
Tanto en PHP como en otros lenguajes (Java, por ejemplo), los datos no enteros (float, real, double) no son fialbes.
Pruebe a realizar por ejemplo
<source lang="php">
print 239.2 - 229.3 - 9.9;
</source>
No obtendrá 0, sino un número muy pequeño en potencia 10 negativo . Si obtiene cero, puede encontrar otros ejemplos que no funcionan.
El problema de los float es general, una variable resultante del cálculo de números reales debe SISTEMATICAMENTE ser limpiada mediante la función '''price2num()''' con el segundo parámetro rellenado con: 'MU', 'MT' ó 'MS' según el caso (ver doc de la función).
<source lang="php">
print price2num(239.2 - 229.3 - 9.9, 'MT');
</source>
Si no es un precio que se ajuste a los parámetros de MU, MT, MS debe utilizar la función '''round()'''.

== Creación de tablas ==
No crear una tabla a utilizar, es decir, al '''primer uso''' del módulo.
Si crea un módulo que usa tablas que no se incluyen como estándar en el código de Dolibarr, asegúrese de seguir el tutorial Creación de un módulo que explica cómo incluir las tablas que se crean en la activación del módulo y no en su uso (ver más arriba).

== Logs ==
Añada traces dentro de su código mediante la función
<source lang="php">
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
</source>

== Carpetas de trabajo ==
Si tiene que crear una carpeta de trabajo, en el código, haga referencia a esta carpeta de la siguiente forma
'''DOL_DATA_ROOT.'/mimodulo''''

La carpeta puede crearse en desde su código mediante el código siguiente:
<source lang="php">
$mymoduledir=DOL_DATA_ROOT.'/mimodulo';
dol_mkdir($mymoduledir);
</source>

Si necesita una carpeta de datos temporales, esta carpeta deberá ser '''DOL_DATA_ROOT.'/minmodulo/temp''''

= Patrones de Diseño y programación con objetos =
== Patrones de Diseño Creacionales (GoF) ==
Design patterns definidos por el le Gang Of Four (ver la wikipedia sobre los [http://es.wikipedia.org/wiki/Patr%C3%B3n_de_dise%C3%B1o Design patterns]).
No hay design patterns creacionales particulares.
Hay objetos cercanos a los Singleton y creados conforme al 100% en el espíritu, pero no en la sintaxis, a fin de ser compatible con PHP 4 que no es un lenguaje orientado a objetos completo.

== Design patterns Estructurales (GoF) ==
(ver la wikipedia sobre los [http://es.wikipedia.org/wiki/Patr%C3%B3n_de_dise%C3%B1o Design patterns]).
No hay design patterns estructurales particulares.

== Design patterns de Comportamiento (GoF) ==
(ver la wikipedia sobre los [http://es.wikipedia.org/wiki/Patr%C3%B3n_de_dise%C3%B1o Design patterns]).
No hay design patterns de Comportamiento particulares.

== Design patterns enterprise (Martin Fowler) ==

=== Motivos de organización del código ===

[[wikipedia:Martin Fowler|Martin Fowler]] ha identificado 3 métodos de organización de código llamados '''principios''':
* El '''Transaction Script''' (El código es lineal en función de una acción del usuario).
Es el antiguo principio utilizado en los lenguajes de procedimiento.
Inconveniente: Redundancia de código. Necesidad de conocer el modelo físico a desarrollar.
* El '''Domain Model'''
Es un modelo posible desde los lenguajes orientados a objeto. Son procedimentos funcionales (que deben de ser indentificados antes) que sirven de base para las clases objeto.
Inconveniente: Motivo de mantenimiento complejo.
* El '''Table Module'''
Un intermedio entre los 2 anteriores donde se tiene una sola clase por tabla de la base de datos.

-> Como se muestra en el código de la plantilla (ver sección anterior) Dolibarr se basa en el principio de '''Table Module'''.

=== Comunicación lógica de negociado - datos (ORM) ===

Existen 3 tipos de conexiones:
* '''Data Gateway a tablas y filas'''
Es el más simple. Creamos una tabla por clase y cada clase es un puente con la tabla correspondiente, ver una clase por línea tabla. Una instancia de la clase será pues un registro de la tabla. La clase contiene sólo el código de acceso a líneas o columnas de tablas.

Ejemplo: Es el método utilizado al utilizar ciertos Frameworks de ORM como '''iBatis''' (http://ibatis.apache.org/).

* El '''Active Record'''
Idéntico al anterior, pero podemos añadir algunas funciones de negociado en la clase, siempre que estas funciones sean exclusivas de la tabla o la grabación.

Ejemplo: Es el método utilizado por los desarrollos de Dolibarr y por otras muchas aplicaciones en PHP que disponen de su propio propio framework y prácticas de desarrollo.

* El '''Data Mapper'''
Las clases representan las entidades del problema y no los datos. Por lo tanto hay que doblar, triplicar... estas clases con clases de mapeo para acceder a los datos.
Más "purista" en el papel ya que el negociado está más cercano, este método también tiene la desventaja de ser más complejo en la práctica.

Ejemplo: Es el utilizadao si utilizamos el Framework de ORM '''Propel''' (http://propel.phpdb.org/trac/). Lo encontraremos pues en aplicacciones más pesadas basadas en este ORM.

-> Para los desarrollos de Dolibarr, es recomendado utilizar el modo '''Active Record ''' que ofrece las ventajas de un modelo cercano de negociado sin la complejidad y sin dificultar mucho la técnica. Es en este modo mediante el cual el desarrollo, la comprensión del código y el mantenimiento técnico y/o funcional parece ser la más productivo (Sin embargo, se trata de un eterno debate entre los puristas y los pragmáticos, el debate en el que nadie puede realmente estar en lo cierto, porque todo depende de los objetivos a atender).

FAQ Mejorar el rendimiento

2016-10-15T02:18:22Z

Nnicolashr:

[[Category:FAQ ES]]
{{TemplateDocDesarrollo}}
{{TemplateDocUsuario}}
Dolibarr es una aplicación web diseñada para tener un tiempo de respuesta lo más optimizado posible. Utiliza muchas tecnologías, pero algunas de ellas no están habilitadas por defecto, ya que necesitan algunas configuraciones específicas para su uso. Esta es una lista de todo lo que puede hacer para aumentar la velocidad Dolibarr.

= Soluciones recomendadas =
== Desactivación de xdebug ==
Eficacia: *****

Principio: Si el módulo php xdebug está activado, habrá que desactivarlo. Este módulo es una funcionalidad de PHP que le sirve a los desarrolladores, pero que ralentiza el funcionamiento de toda aplicación PHP.
Para averiguar si el módulo está activado, vaya a la página '''Inicio-Configuración-Info del Sistema-PHP''' y realice una búsqueda de '''xdebug'''. Si no encuentra nada, el módulo no está atcivado. Si encuentra una ocurrencia, está activado y puede desactivarse.
Su activación/desactivación depende de su sistema PHP y SO, lo más corriente suele ser desactivarlo comentando una línea en el archivo php.ini
== Aplicación Cache vía MemCached ==
Eficacia: *****

Principio: Instalar un servidor de caché Memcached y el [[Módulo MemCached]].

== Caché PHP OPCODE ==
Eficacia: ****

Principio: Instalar un módulo apache/php que mete en caché la compilación de sus páginas PHP. En cada acceso, una página que ya haya sido accedida cargará más rápidamente.
Para ello puede instalar cualquier [http://en.wikipedia.org/wiki/List_of_PHP_accelerators acelerador]. xcache parte como solución recomendada.
Este cache trabaja a un nivel diferente que el [[Módulo MemCached]], ¡las mejoras son acumulativas!

== Cache HTTP de las páginas de estadísticas ==
Eficacia: ***

Principio: Puede configurar apache para activar la caché explicita de recursos estadísticos añadiendo las directivas:
<source lang="ini">
# Cache for static resources (Enable expiration and set it to A2592000 = 1 month)
ExpiresActive On
ExpiresByType image/x-icon A2592000
ExpiresByType image/gif A2592000
ExpiresByType image/png A2592000
ExpiresByType image/jpeg A2592000
ExpiresByType text/css A2592000
ExpiresByType text/javascript A2592000
ExpiresByType application/x-javascript A2592000
ExpiresByType application/javascript A2592000
</source>
Las mejoras se acumulan a los cachés anteriores.

== Compresión de los recursos por Apache ==
Eficacia: ***

Principio: Puede configurar Apache para activar la compresión de los recursos reenviados por el servidor gracias a las siguientes directivas:

<source lang="ini">
# Compress returned resources of type php pages, text file export, css and javascript
AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css text/javascript application/javascript application/x-javascript
</source>

== Uso del driver mysqli en lugar de mysql ==
Eficacia: ***

Principio: Si usa una base de datos Mysql, comprueba en su archivo de configuración de Dolibarr htdocs/conf/conf.php que tiene bien la línea
<source lang="php">
$dolibarr_main_db_type='mysqli';
</source>
Si el valor tiene '''mysql''', cambie lo por '''mysqli''' que da mejor rendimiento (gana 30ms en cada página).

== Búsqueda al inicio del campo ==
Eficacia: ***

Principio: Si tiene activado en el módulo Productos la búsqueda "autocompletar" y la lista tarda un tiempo en aparecer en cada tecleo de carácter, es por que tiene un número importante de productos. La búsqueda se realiza en cualquier lugar del texto, el índice de la base de datos no puede usarse. Añadiendo la constante PRODUCT_DONOTSEARCH_ANYWHERE con valor 1 en '''Inicio-Configuración-Varios''', limitará la búsqueda al inicio de la cadena, permitiendo el uso del índice y obteniendo una respuesta inmediata.

== Uso de un navegador reciente ==
Eficacia: ***

Principio: Muchas funcionalidades se basan en las tecnologías Ajax o JavaScript para proporcionar una ergonomía moderna. Estas tecnologías tienen un papel importante en el tiempo de visualización de las páginas y son mucho mejor aprovechadas con un navegador web reciente. Las diferencias de rendimiento de una versión a otra son a veces muy importantes, también hay que considerar el uso de un navegador web optimizado y con la última versión disponible (Firefox, Chrome, Safari u Opera). Evite el IE u otros navegadores exóticos.

== Actualizar las estadísticas de la base de datos ==
Eficacia: **

Principio: Si su base de datos es voluminosa (más de 100 000 registros), compruebe que las estadísticas de sus datos están actualizadas. Requiere de acceso como administrador a la base de datos y de conocimientos de administración. Consulte el manual de la base de datos acerca de como "actualizar las estadísticas".

= Otras soluciones =
Todas las soluciones que aquí se clasifican por separado en este capítulo "Otras soluciones", ya que no son recomendables. Pueden requerir conocimientos técnicos avanzados, pueden ser inestables, no soportadas o pueden impedir el funcionamiento de ciertas características... pero existen, así que ¡Uselas solamente si sabe lo que hace!

== Aplicación Cache vía Shared memory ==
Eficacia: ****

Prerrequisito: Uso del servidor web Apache

Principio: Añadir en '''Inicio-Configuración-Varios''' la constante MAIN_OPTIMIZE_SPEED. Si el valor de la constante tiene el bit 1 definido (Ejemplo: MAIN_OPTIMIZE_SPEED=2), la memoria compartida de su SO se utilizará para guardar en caché los archivos lang, aunque también implica que todo el interfaz solamente será visible en un único idioma, el del primero que se conecte al arrancar el servidor web (quien cargue los archivos de idioma en caché). Usar en lugar del [[Módulo MemCached]] para una optimización mediante una aplicación de caché que no tenga ninguna de estas limitaciones y sea de mayor rendimiento.

== Desactivar la generación de PDF "al vuelo" ==
Eficacia: **

Principio: Añadir en '''Inicio-Configuración-Varios''' la constante MAIN_DISABLE_PDF_AUTOUPDATE con valor 1. Esto desactivará la generación de un PDF cada vez que modifique un elemento (factura, pedido, etc.). La generación del PDF solo se realizará mediante el clic al botón "Generar".

== Compresión para Dolibarr ==
Eficacia: **

Principio: Añadir en '''Inicio-Configuración-Varios''' la constante MAIN_OPTIMIZE_SPEED. Si el valor de esta constante tiene el bit 2 definido (Ejemplo: MAIN_OPTIMIZE_SPEED=4), Dolibarr devolverá las páginas comprimidas en GZ (y si el navegador lo soporta). Consume más CPU en el servidor pero reduce el tiempo de transferencia.

== Desactivar la función Canvas ==
Eficacia: *

Principio: Añadir en '''Inicio-Configuración-Varios''' la constante MAIN_DISABLE_CANVAS con valor 1. Esto desactivará las funciones de gestión de canvas, que puede usarse por ciertos módulos externos y que ahorrará una consulta a base de datos cada vez que acceda a la ficha de un objeto.
Si un módulo externo usa esta función de canvas, esto dejará al módulo defectuoso. Si no tiene instalado ningún módulo complementario externo, no hay ningún riesgo.

Nota: Para obtener la totalidad de las optimizaciones usando MAIN_OPTIMIZE_SPEED, hay que activar todos los bits (Ejemplo: MAIN_OPTIMIZE_SPEED=7 entonces 1+2+4 contiene el bit 0, 1 y 2).

Crear un modelo de documento PDF

2016-10-15T01:22:06Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Cambiar nombre del modelo en línea: Original --> "$this->name = "azur";", Nueva --> $this->name = "masocietebleu";
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Probar este modelo, antes de continuar, para ello seguir los siguientes pasos:
# En directorio /htdocs/core/modules/propale/doc poner la copia de la nueva plantilla (Dolibarr versión 3.9.2)
# Ir al sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
# Activar nueva plantilla en sección: Modelos de documentos de presupuestos
# Ir al sistema Dolibarr-->Comercial-->Listado de Presupuestos-->Seleccionar un presupuesto
# En sección Documentos, seleccionar nueva plantilla
# Presionar botón: Generar
# Verificar que se genera archivo PDF y abrirlo, se espera que se abra con éxito sin errores
* Borrar indicios de prueba de plantilla después de desactivar
# Desactivar en sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
# Mover archivo de plantilla desde directorio /htdocs/core/modules/propale/doc
# Eliminar registro creado en tabla llx_document_model (verificar)

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Crear un modelo de documento PDF

2016-10-15T01:11:08Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Cambiar nombre del modelo en línea: Original --> "$this->name = "contrato";", Nueva --> $this->name = "masocietebleu";
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Probar este modelo, antes de continuar, para ello seguir los siguientes pasos:
# En directorio /htdocs/core/modules/propale/doc poner la copia de la nueva plantilla (Dolibarr versión 3.9.2)
# Ir al sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
# Activar nueva plantilla en sección: Modelos de documentos de presupuestos
# Ir al sistema Dolibarr-->Comercial-->Listado de Presupuestos-->Seleccionar un presupuesto
# En sección Documentos, seleccionar nueva plantilla
# Presionar botón: Generar
# Verificar que se genera archivo PDF y abrirlo, se espera que se abra con éxito sin errores
* Borrar indicios de prueba de plantilla después de desactivar
# Desactivar en sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
# Mover archivo de plantilla desde directorio /htdocs/core/modules/propale/doc
# Eliminar registro creado en tabla llx_document_model (verificar)

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Crear un modelo de documento PDF

2016-10-15T01:03:39Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Cambiar nombre del modelo en línea: Original --> "$this->name = "contrato";", Nueva --> $this->name = "masocietebleu";
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Probar este modelo, antes de continuar, para ello seguir los siguientes pasos:
#En directorio /htdocs/core/modules/propale/doc poner la copia de la nueva plantilla (Dolibarr versión 3.9.2)
#Ir al sistema Dolibarr-->Inicio-->Configuración-->Módulos-->Presupuestos-->Configuración del módulo Presupuestos
#Activar nueva plantilla en sección: Modelos de documentos de presupuestos
#Ir al sistema Dolibarr-->Comercial-->Listado de Presupuestos-->Seleccionar un presupuesto
#En sección Documentos, seleccionar nueva plantilla
#Presionar botón: Generar
#Verificar que se genera archivo PDF y abrirlo, se espera que se abra con éxito sin errores

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Crear un modelo de documento PDF

2016-10-15T00:54:41Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Cambiar nombre del modelo en línea: Original --> "$this->name = "contrato";", Nueva --> $this->name = "masocietebleu";
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Probar este modelo, antes de continuar, para ello seguir los siguientes pasos:
#a
#b
#c

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Crear un modelo de documento PDF

2016-10-15T00:23:53Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Testear este modelo (ver A) antes de ir mas lejos...

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Crear un modelo de documento PDF

2016-10-15T00:03:41Z

Nnicolashr: /* Crear el nuevo modelo */

{{TemplateDocDesarrollo}}

Este documento describe como crear su propio modelo de generación de documentos PDF para así personalizar sus documentos (presupuestos, facturas, etc.)
Tomaremos como ejemplo los presupuestos, pero todo ello se aplica a cualquier tipo de documento.

Para documentos ODT, ver [[Crear un modelo de documento ODT]].

= Encontrar el modelo existente más cercano =
En Dolibarr probar los modelos existentes activando todos los modelos existentes en la configuración del módulo y, a continuación, generar y visualizar un documento borrador para cada uno de ellos.

Entre los disponibles, elegir el modelo que mejor se adapte a sus necesidades. En este ejemplo, el modelo azur (correspondente al fichero pdf_propale_azur.modules.php).

Para su información, todos los modelos se encuentran en '''htdocs\core\modules''' si trabaja bajo Windows y '''htdocs/core/modules''' si trabaja bajo Unix.

= Crear el nuevo modelo =
Por seguridad, hay que conservar los modelos de origen. Para el ejemplo, comenzaremos creando un nuevo modelo de presupuesto al que llamaremos 'masocietebleu' y que se inspira en el modelo 'azur':
* Copiar-pegar pdf_propale_azur.modules.php
* Renombrar la copia como pdf_propale_masocietebleu.modules.php
* Editarla realizando las siguientes modificicaciones en el código:
# Renombrar 'Class pdf_propale_azur{ ' como 'Class pdf_propale_masocietebleu { '
# Renombrar 'Function pdf_propale_azur($db=0)' como 'Function pdf_propale_masocietebleu($db=0)'
# Guardar : el modelo 'masocietebleu' se encuentra disponible en la lista de modelos de presupuestos de Dolibarr
* Testear este modelo (ver A) antes de ir mas lejos...

= Personalizar =
Personalizar el modelo creado.
Siempre en pdf_propale_masocietebleu.modules.php, buscar la función 'Function _pagehead(&$pdf, $fac)'. Ella gestiona la visualización de la cabecera.

== Librería de creación PDF ==
La librería utilizada para la creación de documentos PDF se llama FPDF y se puede encontrar en htdocs/includes/tcpdf/tcpdf.class.php. En esta clase también encontraremos muchos métodos utilizados para generar los diferentes elementos de los documentos.

Los modelos instancian ellos mismos la clase FPDF y utilizan sus métodos, combinados con los datos de una factura, pedido u otro tipo de datos.

Normalmente encontraremos las siguientes llamadas en los scripts de creación de documentos:
* $pdf->SetFont() - ''Designa la fuente utilizada para el texto que continua''
* $pdf->SetXY() - ''Designa el punto de partida para señalar el siguiente texto en coordenadas X,Y que se expresan en milímetros de la página''
* $pdf->MultiCell() - ''Dibuja una caja que puede contener texto, y que primero debe dar el ancho y altura - muy utilizado''
* $pdf->GetY() - ''Devuelve la posición actual en Y''
* $pdf->SetDrawColor() - ''Designa el color a utilizar para el siguiente texto a ser escrito - generalmente negro (0,0,0) o blanco (255,255,255)''
* $pdf->Rect() - ''Dibuja un rectángulo cuya esquina superior izquierda se encuentra en el punto indicado por los dos primeros parámetros y la esquina inferior derecha por los dos últimos parámetros en modo relativo a los dos primeros''

== Estructura de los scripts ==
Los scripts de generación de documentos PDF, durante el desarrollo de la versión 2.2, disponen de los siguientes métodos (tomando como ejemplo el modelo "crabe") en el seno de la clase del nombre del modelo:
* pdf_crabe() - ''Constructor del objeto pdf''
* write_pdf_file() - '' Método general para la generación del archivo. Este método llama a todos los siguientes después de inicializar algunas variables''
* _pagehead() - ''Método de dibujo de la cabecera del documento, incluyendo generalmente el logotipo, el título del documento (y la fecha) así como los marcos de datos del emisor y el destinatario del documento''
* _tableau() - ''Método de dibujo de la tabla de datos (productos, servicios, etc)''
* _tableau_info() - ''Método de dibujo de la tabla con una lista de informaciones de la factura''
* _tableau_tot() - ''Método de dibujo de la tabla de los totales''
* _tableau_versement() - ''Método de dibujo de la tabla de las forma de pago''
* _pagefoot() - ''Método de dibujo del pié de página''

== Ejemplo ==
=== Inserción de un logo ===
* Añadir la instrucción:
<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5,60.00);
</source>

=== Inserción de una firma u otros en pié de página de la factura ===
* abrir el modelo a modificar crabe u oursin (en htdocs/core/modules/facture/)
* insertar (por mi parte, justo antes de la línea 618 // Show payment mode CHQ)
<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
la imagen (largo 74mm) aparece en la columna de la derecha justo antes del pie de página.
* copiar la imagen en el directorio. Parece ser que una imagen png con transparencias trae problemas.
* generar el pdf, la firma aparece.

=== Inserción de textos ===
Principales funciones utilizadas
<source lang="php">
$pdf->setX(float a); // establece la posición actual x
$pdf->setY(float b); // establece la posición actual y
$pdf->setXY(float a,float b); // establece las posición actual x e y
$pdf->SetTextColor(0,0,200); // establece el color del texto
$pdf->SetFont('Arial','B',14); // establece la fuente, le tipo ( 'B' para negrita, 'I' para itálica, '' para normal,...)
$pdf->MultiCell(60, 8, 'My text', 0, 'L'); // imprime 'My text' con salto de línea
</source>
Recuerde: el origen es la esquina superior izquierda

== Para más información ==
http://www.fpdf.org/?lang=es

= Elegir un modelo por defecto en Dolibarr =
En Inicio => Configuración => Módulos => :
* indicamos que modelos deben de estar activos,
* precisaremos el modelo propuesto por defecto.

Desarrollo de un módulo

2016-09-15T14:40:19Z

Nnicolashr: /* Crear su página de edición de configuración */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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 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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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óngalo 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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Ejemplo :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 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''').
<source lang="php">
$this->config_page_url = array("monmodule_setuppage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-15T14:27:12Z

Nnicolashr: /* Crear su página de edición de configuración */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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 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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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óngalo 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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Ejemplo :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-15T14:25:25Z

Nnicolashr: /* Crear una página pantalla PHP */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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 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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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óngalo 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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Ejemplo :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-12T05:01:26Z

Nnicolashr: /* Generar la clase PHP de acceso (DAO) */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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 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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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óngalo 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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-12T05:00:35Z

Nnicolashr: /* Generar la clase PHP de acceso (DAO) */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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óngalo 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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-10T01:48:59Z

Nnicolashr: /* Crear su descriptor */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T02:21:18Z

Nnicolashr: /* Añadir pestañas de una ficha entidad en su propia página */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

Nota: En versión 3.9.2 de Dolibarr, el directorio donde se ubican los ficheros descriptor de módulo es '''/htdocs/''core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''dolibarr/htdocs/''') :
* Entidad tercero (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T02:04:25Z

Nnicolashr: /* Añadir pestañas de una ficha entidad en su propia página */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

Nota: En versión 3.9.2 de Dolibarr, el directorio donde se ubican los ficheros descriptor de módulo es '''/htdocs/''core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

Aquí le mostramos la lista de estos archivos (DOL_DOCUMENT_ROOT correspondiente al directorio '''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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T02:02:26Z

Nnicolashr: /* Añadir pestañas de una ficha entidad en su propia página */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

Nota: En versión 3.9.2 de Dolibarr, el directorio donde se ubican los ficheros descriptor de módulo es '''/htdocs/''core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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 estándar 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
<source lang="php">require_once($url_fichier) ;</source>

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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T01:38:38Z

Nnicolashr: /* Crear su descriptor */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.

Nota: En versión 3.9.2 de Dolibarr, el directorio donde se ubican los ficheros descriptor de módulo es '''/htdocs/''core/modules'''.

A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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
<source lang="php">require_once($url_fichier) ;</source>

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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T01:12:06Z

Nnicolashr: /* Crear su descriptor */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* Crear el directorio '''/htdocs/''mimodulo''/core/modules'''. Seguidamente ir al directorio '''dev/skeletons''' y copiar el archivo modMyModule.class.php en el directorio '''htdocs/''mimodulo''/core/modules'''.
A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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
<source lang="php">require_once($url_fichier) ;</source>

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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T00:57:08Z

Nnicolashr: /* Añadir o eliminar pestañas en las fichas entidad */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* 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'''.
A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== Añadir o eliminar pestañas en las fichas entidad ===
'''Cuándo''' : Para añadir su propia pestaña en las pestañas estándar 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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
<source lang="php">require_once($url_fichier) ;</source>

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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T00:48:35Z

Nnicolashr: /* Visualización de pestañas pestañas (opcional) */

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* 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'''.
A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas (opcional) ==

=== 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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
<source lang="php">require_once($url_fichier) ;</source>

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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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

Desarrollo de un módulo

2016-09-08T00:37:19Z

Nnicolashr:

[[Category:Básico]]
{{TemplateDocDesarrollo}}
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.

= [[File:Art.png]] Crear 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:
* 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'''.
A continuación, modificar el contenido del archivo, reemplazando:
* los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod.
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.
* $this->numero = 100000 por un número de módulo que esté libre. Ver [[List of modules id|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/
Ahora su fichero descriptor está configurado.

=== 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:
{{TemplateModuleTreeSimple}}

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

Revisa que en el descriptor de archivo (mymodule/core/modules/mymodule.class.php) la línea
<source lang="php">
$this->_load_tables('/mymodule/sql/');
</source>
esté descomentada y correctamente configurada.

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
<source lang="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__');
</source>

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
<source lang="bash">
php build_class_from_table.php nombretabla
</source>
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.

== Visualización de pestañas pestañas (opcional) ==

=== 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:
<source lang="php">
// 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
</source>

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:
{{TemplateModuleTabs-es}}
* 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
<source lang="php">require_once($url_fichier) ;</source>

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 :''
<source lang="php">
$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é
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l'ongLet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Ejemplo :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

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

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
$links // Tableau des onglets, appelé $head plus haut.
$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
$title // ?
$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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.

''Nota'':
Para más detalles, consulte la [http://www.dolibarr.fr/doxygen/ 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
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>

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.

* 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 :''
<source lang="php">
dol_include_once('/mimodulo/class/miclass.class.php', 'MiClass');
</source>

* Las clases de llamadas Dolibarr utilice la siguiente sintaxis:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== 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.
{{ToComplete}}

=== 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'':
<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
o $db->rollback() // Annule
</source>

Para una lectura:
<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>

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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== 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 [[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''').
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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:
<source lang="php">
$this->rights_class = 'mimodulo';
</source>

A continuación, rellene la tabla $this->rights con tantas entradas como permisos diferentes vaya a definir:
<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Texto por defecto de mi permiso';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'accion';
$this->rights[$r][5] = 'subaccion';
$r++;
</source>

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:
<source lang="php">
if ($user->rights->mimodulo->accion->subaccion) ...
</source>

== 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:
<source lang="php">
$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'
</source>

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
<source lang="php">
$this->module_parts = array('css' => array('/mimodulo/css/mimodulo.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mimomulo/js/monmodule.js");
llxHeader('','Titulo','','','','',$morejs,'',0,0);
</source>

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

= [[File:Art.png]] Algunas reglas de código =
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".

= [[File:Art.png]] 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]].

= [[File:Art.png]] 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)
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>

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:
<source lang="bash">
tar -xvf monmodule.zip
</source>

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