Dolibarr ERP CRM Wiki - User contributions [en]

Créer un modèle de document PDF

2020-09-14T08:54:18Z

Unareil: /* Trouver le modèle existant le plus proche */ ajout du chemin précis pour la facture

[[en:Create_a_PDF_document_template]]
[[es:Crear_un_modelo_de_documento_PDF]]
[[zh:创建PDF模板]]


{{TemplateDocDev}}
Ce document décrit comment créer son propre modèle de génération de document PDF afin de personnaliser ses documents (propales, factures, etc...)
Il se base sur les propositions commerciales comme exemple mais s'applique à tout type de document.

Pour savoir comment générer un modèle de document ODT, voir la page [[Créer un modèle de document ODT]].
Créer un modèle PDF requiert des connaissances en programmation PHP mais pas la création de modèles ODT.

=Prérequis=

*Dolibarr: 3.0+
*Connaissance en PHP

=Trouver le modèle existant le plus proche=
Dans Dolibarr, tester les modèles existants en allant dans la configuration du module puis en consultant l'aperçu en cliquant le picto "Aperçu" en fin de ligne du modèle. Consulter chacun des modèles disponibles.

Parmi ceux existant, noter le modèle le plus proche de vos besoins. Dans cet exemple, c'est le modèle azur (correspondant au fichier pdf_propale_azur.modules.php).

Pour info, tous les modèles sont dans '''htdocs/core/modules''' puis le sous-répertoire propale pour les propositions commerciales, facture pour les factures, commandes pour les commandes, etc... et enfin '''doc'''.
Par exemple, un modèle personnalisé de proposition sera dans '''...core/modules/propale/doc/''' pour un modèle personnalisé de facture ce sera dans '''...core/modules/facture/doc/''' ,etc ...

=Créer le nouveau modèle=
Par sécurité, on conservera les modèles d'origine. Pour l'exemple, on part du principe qu'on crée un nouveau module de proposition commerciale qu'on nommera 'masocietebleu' et qui s'inspire du module 'azur':

*Copier-coller pdf_propale_azur.modules.php
*Renommer la copie en pdf_propale_masocietebleu.modules.php
*L'éditer et faire les modifs suivantes dans le code:

#Renommer “''Class pdf_propale_azur {''” en “''Class pdf_propale_masocietebleu {''” (important : le nom de la classe et celui du fichier doivent correspondre)
#Renommer la variable $this->name pour refléter le nouveau nom. Par exemple pour le modèle 'azur', changer la ligne '$this->name = "azur";' en '$this->name = "masocietebleu";'.
#Sauvegarder : le modèle 'masocietebleu' est disponible dans la liste des modèles de propales de Dolibarr

*Tester ce modèle (Voir chapitre précédent) avant d'aller plus loin...
*Ajouter dans la table '''llx_document_model''' le nouveau modéle que vous venez de créer

=Personnaliser votre nouveau modèle=
Personnaliser le modèle créé en modifiant le code:

Toujours dans pdf_propale_masocietebleu.modules.php, chercher la fonction '_pagehead()'. C'est elle qui gère l'affichage de l'entête.

Chercher la fonction '_pagefooter()'. C'est elle qui gère l'affichage du pied de page.

Chercher la fonction 'write_file()'. C'est elle qui affiche le corps du PDF.

==Librairie de manipulation de PDF==
La librairie utilisée pour la création de documents en PDF se nomme TCPDF et peut être trouvée dans htdocs/includes/tcpdf/tcpdf.class.php. C'est également dans cette classe que l'on trouve les nombreuses méthodes utilisées pour générer les différents éléments des documents.

Les modèles eux-même instancient la classe FPDF et utilisent ensuite ses méthodes, combinées avec les données d'une facture, d'une commande ou d'autres types de données.

On retrouve généralement les appels suivants dans les scripts de création de documents:

*$pdf->SetFont() - ''Désigne la fonte à utiliser pour le texte qui suivra''
*$pdf->SetXY() - ''Désigne le point de départ pour dessiner le prochain texte en coordonnées X,Y qui sont exprimées en millimètres de la page''
*$pdf->MultiCell() - ''Dessine une boîte pouvant contenir du texte, et dont on doit d'abord donner la largeur et la hauteur - très utilisée''
*$pdf->GetY() - ''Renvoie la position courante en Y''
*$pdf->SetDrawColor() - ''Désigne la couleur à utiliser pour le prochain texte à écrire - généralement noir (0,0,0) ou blanc (255,255,255)''
*$pdf->Rect() - ''Dessine un rectangle dont le coin supérieur gauche est au point indiqué par les deux premiers paramètres et le coin inférieur droit utilise les deux derniers paramètres en mode relatif aux deux premiers''

==Structure des scripts==
Les scripts de génération des documents PDF, disposent des méthodes suivantes (prenant pour exemple le modèle "crabe") au sein de la classe du modèle:

*pdf_crabe() - ''Constructeur de l'objet pdf''
*write_pdf_file() - ''Méthode générale pour la génération du fichier. Cette méthode appelle toute les suivantes après avoir initialisé quelques variables''
*_pagehead() - ''Méthode de dessin de l'en-tête du document, incluant généralement le logo, le titre du document (et la date) ainsi que les cadres de l'émetteur et du destinataire du document''
*_tableau() - ''Méthode de dessin du tableau de détails (produits, services, etc)''
*_tableau_info() - ''Méthode de dessin du tableau reprenant une liste d'informations sur la facture''
*_tableau_tot() - ''Méthode de dessin du tableau des totaux''
*_tableau_versement() - ''Méthode de dessin du tableau des règles de versement''
*_pagefoot() - ''Méthode de dessin du pied de page''

==Example de personnalisation==
===Insertion d'un logo===

*Ajouter l'instruction:

<source lang="php">
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);
</source>
Avec dans l'exemple: 10=abscisse, 5=ordonnée, 60=largeur logo

*Si le logo se trouve par dessous ou dessus du text existant, supprimer le texte existant en commentant le code qui affiche l'information ou en modifiant sa position.

===Insertion d'une signature ou autre en bas de page facture===

*ouvrir le modèle à modifier crabe ou oursin (dans htdocs/core/modules/facture/)
*insérer (pour ma part ligne 618 juste avant // Show payment mode CHQ)

<source lang="php">
$pdf->Image('http://localhost/dolibarr/doc/images/signature.jpg',120,250,74);
</source>
l'image (largeur 74mm) est affichée colonne de droite juste avant le pied de page.

*copier l'image dans le répertoire. il semble qu'une image png avec transparence pose problème.
*générer le pdf, la signature apparaît.

===Insertion de texte===
Principales fonctions utilisées
<source lang="php">
$pdf->setX(float a); // fixe la position x courante
$pdf->setY(float b); // fixe la position y courante
$pdf->setXY(float a,float b); // fixe les positions x et y courantes
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne
</source>
Rappel: l'origine des fonctions setXY est le coin supérieur gauche de la page

==Pour plus d'infos==

*http://www.fpdf.org/?lang=fr
*Liste des méthodes: tcpdf.org/doc/code/classTCPDF.html

=Activer son modèle dans Dolibarr=
Dans la fonction d'initialisation du module ajoutez votre modèle:

<source lang="php">
sql=array("INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES(".$MODELNAME.",".$MODEL_TARGET_MODULE.",".$conf->entity." )");
</source>

avant

<source lang="php"> return $this->_init($sql,$option);</source>

Puis

Dans Accueil => Configuration => Modules =>

*activer votre module qui doit apparaitre
*éventuellement le mettre en modèle proposé par défaut.

List of modules id

2020-09-04T12:20:32Z

Unareil: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}}
This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here. Please pick range into existing holes first.

{{Flag fr}}
Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici. Merci de prendre dans les trous existant en priorité !

{{Flag sp}}
Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

=ID 0 - 99999=
{{Flag en}}
Reserved for Dolibarr's internal modules.

{{Flag fr}}
Réservé aux modules internes de Dolibarr.

{{Flag sp}}
Reservado a los módulos internos de Dolibarr.

=ID 100000 - 499999=
{{Flag en}}
Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 50 numbers only the first time, 1000 max per company)

{{Flag fr}}
Zone réservé aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limité à 50 valeurs la première fois, 1000 maximum par société)

{{Flag sp}}
Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 50 valores por editor)

[[File:Warning.png]] If you reserve more than 50, we may automatically change your reservation range without information and you may experience conflicts with other modules in a future, so please follow the rules !

*ID 100000 - 100999: OpenThink (http://www.openthink.be)
*ID 101000 - 101999: NLTechno (https://www.nltechno.com)
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
*ID 105000 - 105999: GPC.solutions
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Oas services ([http://www.oas-services.fr https://www.oas-services.fr])
*ID 110000 - 110999: Librethic (https://librethic.io)
*ID 111000 - 111999: Asset IT (www.assetit.ch)
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
*ID 113000 - 113999: Asilib - Alexandre Spangaro
*ID 114000 - 114999: Iceleaf OÜ
*ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
*ID 116000 - 116999: Wolftec GmbH
*ID 117000 - 117999: Oscim (http://www.oscim.fr)
*ID 118000 - 118999: Oarces Web (dev.oarces.com)
*ID 119000 - 119999: Manuel Berrocal - Absolacom
*ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
*ID 121000 - 121999: Oscss - Shop
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: backbone internet service (www.backbone.co.at)
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br)
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
*ID 131000 - 131999: Joan Louis (itaca.fr)
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr)
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 135000 - 135999: Net-Logic (http://netlogic.fr)
*ID 140000 - 140999: Altairis (http://altairis.fr)
*ID 141000 - 141050: Projet2Team (https://www.projet2team.fr)
*ID 141051 - 141099: Elistair (http://elistair.com)
*ID 141100 - 141149: Blue Networks Technologies (https://www.blnt.fr)
*ID 141150 - 141199: Florian DUFOURG - France
*ID 142000 - 142049: ITANéA (https://www.itanea.fr)
*ID 142050 - 142099: ERP Consulting NZ ([https://www.erpconsulting.co.nz www.erpconsulting.co.nz])
*ID 150000 - 150999: Jeffinfo
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (http://dolipar.org)
*ID 162000 - 162999: Jacques Rébiscoul
*ID 163000 - 163999: Open-DSI (https://www.open-dsi.fr)
*ID 164000 - 164999: Pixelada S. Coop. And. (https://pixelada.org)
*ID 165000 - 165049: DovConnect
*ID 165050 - 165099: Mind Operated Systems (https://www.mosystems.biz)
*ID 165100 - 165150: SD-Formation (https://sdformation.fr)
*ID 170000 - 170999: TRIDENT CONSULTING LTD (www.tridentdxb.com)
*ID 171000 - 171999: LVSInformatique (www.lvsinformatique.com)
*ID 172000 - 172299: Ray Soft-Systems (https://www.ray-soft-systems.com)
*ID 172300 - 172349: Günter Lukas Consulting (https://gl.co.at)
*ID 172350 - 172399: MB Informatique (https://www.mb-informatique.fr)
*ID 172400 - 172449: Professional Structures Limited (https://pstructures.com)
*ID 172450 - 172699: IT-BS (https://www.it-bs.fr)
*ID 172700 - 172749: Indelog (https://www.indelog.fr)
*ID 172750 - 172799: NS-INFO90 (https://www.ns-info90.fr)
*ID 180000 - 180999: Triangle Ingénierie
*ID 181000 - 181999: TI Sin Problemas (https://www.tisinproblemas.com)
*ID 182000 - 182049: Chipserv Pawel Wlizlo (https://www.testware.it)
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 199000 - 199999: RFMS
*ID 200000 - 200999: Noxiome
*ID 201000 - 201999: Sasa Ostrouska (saxa)
*ID 202000 - 202999: Z-Application
*ID 203000 - 203099: Elidee - elidee.com
*ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
*ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
*ID 205000 - 205999: Kreiz IT
*ID 206000 - 206999: GBINFO (www.gbinfo.fr)
*ID 207000 - 207099: MacroProg (https://www.macroprog.com)
*ID 207100 - 207149: Reactiva Software
*ID 207150 - 207199: David Bensel
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 230000 - 230049: Unareil (https://www.unareil.eu)
*ID 230050 - 230099: Lyra Network (https://www.lyra.com/)
*ID 230100 - 230149: Gheorghe Iftimi - CTW - RO
*ID 230150 - 230199: MEMA Machinery & Tools (https://www.mema.be)
*ID 230200: '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350: '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: '''Free'''
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 399999: (take ranges of 50 only please, 1000 max per company)
*ID 400000 - 400999: 2byte.es (http://www.2byte.es)
*ID 401000 - 401999: B&D Informática
*ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
*ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 409000 - 409999: LliureTIC (www.lliuretic.cat)
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423050: cyberesprit
*ID 423051 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 424000 - 424049: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
*ID 426000 - 426099: Arkesis-Solution
*ID 426100 - 426149: GetLandy (www.getlandy.com)
*ID 426150 - 426649: OOB Software
*ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
*ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
*ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 429000 - 429999: induslab
*ID 430000 - 430099: Mixity sprl (www.mixity.be)
*ID 430100 - 430199: sgiraud
*ID 430200 - 430299: Merlion TI (www.merlion-si.com.br)
*ID 430300 - 431299: Libre Expert (www.libre-expert.com)
*ID 431300 - 431399: ptibogxiv (www.ptibogxiv.net)
*ID 431400 - 431499: Befox (www.befox.fr)
*ID 431500 - 431599: rue Béjo (www.ruebejo.fr)
*ID 431600 - 431699: Avizzeo (www.avizzeo.com)
*ID 431700 - 432199: Multisistemas (www.multisistemas.com.sv)
*ID 432200 - 432399: Burbuja - Chile (www.burbuja.cl)
*ID 432400 - 433399: INOVEA CONSEIL (https://www.inovea-conseil.com)
*ID 433400 - 434399: Rachid HRICH - Maroc (HricH ServiceS.)
*ID 434400 - 435399: Lance Bleakley - LanceIT (www.lanceit.net)
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 438400 - 439399: Tetras Libre - France - Développement logiciels libres (www.tetras-libre.fr)
*ID 439400 - 440399: Dolibarr-pro - France - Développement Dolibarr (www.dolibarr-pro.com)
*ID 440400 - 441399: Quidlab Co., Ltd - Thailand - ( www.quidlab.com )
*ID 441400 - 442399: Ide@log - France - (https://www.idealog-info.net) - Laurent Leblanc
*ID 442400 - 443399: Valerio Bianchi (www.valeriobianchi.com)
*ID 443400 - 444399: delassalle - France - (www.delassalle.fr) - Joseph Delassalle
*ID 444400 - 445399: Webartis - Maroc - (www.webartis.net) - François Dry
*ID 445400 - 445499: SCOP Au-delà des nuages - France
*ID 446000 - 446999: iouston (http://www.iouston.com) - France - Julien Marchand
*ID 447000 - 447999: rSanjoSEO - Rafael San José Tovar (www.rsanjoseo.com) - Spain
*ID 448000 - 448999: Code 42 (www.code42.fr)
*ID 449000 - 449999: TakePOS (www.takepos.com)
*ID 450000 - 450999: Pierre ARDOIN
*ID 451000 - 451999: Éditeur depordi.fr
*ID 452000 - 452999: Dylan NAKONG
*ID 453000 - 453999: Menahd Ouchenir - France - menahd-ouchenir.com
*ID 454000 - 454999: Withheld - Canada
*ID 455000 - 455999: Gaëtan MAISON - Info Libre @ Dom - France (https://www.infolibreadom.com)
*ID 456000 - 456999: Laurent LEBLEU - B.L.C. - Blue Line Company - Lille - France (www.bluelinecompany.fr/dolibarr)
*ID 457000 - 457999: Sébastien BOUCHER
*ID 458000 - 458999: Lester HERNÁNDEZ - Argentina - (freelancerlrhd@gmail.com)
*ID 459000 - 459999: Infopen - France
*ID 460000 - 460050: torvista - Spain
*ID 461000 - 461999: MEGALOGI - Maroc (www.erpcloud.ma)
*ID 462000 - 462999: Making Digital (www.making-digital.fr) - France
*ID 463000 - 463999: linx s.r.l.s.
*ID 464000 - 464999: NimbleCubed Inc. (www.nimblecubed.com)
*ID 465000 - 465999: Artefacts - CourantAlternatif
*ID 466000 - 466999: CDM Consultores - (www.cdm.guru)
*ID 467000 - 467999: M71 Service GmbH - (www.m71-service.de)
*ID 468000 - 468049: Clément Segonzac - France (clement.segonzac@gmail.com)
*ID 468050 - 468099: Flavien Belli - France (https://github.com/Marshlyin || belliflaviencontactpro@gmail.com)
*ID 468100 - 468119: Chl (https://code.bugness.org/Dolibarr)
*ID 468120 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 468175 - 468199: Gaëlle Rauffet - France (kiwiscan.net)
*ID 468200 - 468250: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468251 - 468270: CD-Systems - France (https://www.cd-systems.fr)
*ID 468300 - 468349: Uvensys - Germany (https://uvensys.de)
*ID 468350 - 468399 : Laudeco - Belgium (http://github.com/laudeco)
*ID 468400 - 468449 : Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 468450 - 468499 : Mehdi Belkhayat - Maroc (https://opensi.ma)
*ID 468500 - 468599 : InvIT GmbH - Germany (https://invit.sh)
*ID 468600 - 468649 : Ricardo Sequeira - Portugal (https://ricardo-sequeira.com)

...

=ID > 500000=

This range can't be reserved. It is a common range. If you don't plan to distribute your module, you can use an ID in this range with no need to reserve it.

{{Flag en}}
If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (50 ids at once, 1000 ids maximum per partner).

{{Flag fr}}
Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (par lot de 50 d'abord, pas plus de 1000 numéros par partenaire).

{{Flag sp}}
Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

Module Services Web API SOAP (développeur)

2020-06-08T12:42:23Z

Unareil: Ajout de la mention module déprécié et redirection vers les API REST

[[en:Module_Web_Services_API_SOAP_(developer)]]
[[es:Módulo Services Web SOAP (programador)]]


{{TemplateDocDev}}
{{TemplateModFR}}
[[Category:Liste des Modules]]
{{BasculeDevUser|
nom=Web services|
num=2600|
devdoc=Cette page|
userdoc=Non applicable|}}

=Fonction=
En activant ce module (attention ce module est déprécié, utilisez plutôt le module [[Module Web Services API REST (développeur)|Module Web Services API REST]]), vous activez les fonctions web services serveurs de Dolibarr.
Vous pouvez alors solliciter les différents services SOAP fournis par Dolibarr.

[[File:warning.png]] SOAP est un protocol en cours d'abandon. Il est fortement recommandé d'utiliser le [[Module Web Services REST (développeur)]] à la place.

=Serveur de web services Dolibarr=
Une fois le module activé, Dolibarr se comporte en serveur de web service. Vous pouvez alors soumettre votre propre requête SOAP en les soumettant à l'URL relative
'''/webservices/server_xxx.php'''

où xxx peut valoir
{{TemplateListOfWebServices}}

Par exemple, sur la démo en ligne de Dolibarr, envoyez votre requête à '''http://demo.dolibarr.org/webservices/server_other.php'''

Seulement quelques services sont disponibles. Vous pouvez obtenir une liste complète des services fournis en appelant l'URL sans paramètres POST.

Par exemple, pour voir tous les webservices fournis avec la version de demo, appelez simplement l'URL suivante sans paramètres:
http://demo.dolibarr.org/webservices/server_other.php

Pour obtenir le fichier WSDL qui décrit les contrats webservices, vous pouvez appeler:
http://demo.dolibarr.org/webservices/server_other.php?wsdl

=Client de web services Dolibarr=
Notez que vous trouverez un example de code PHP client qui appelle les web services Dolibarr en sollicitant l'URL
'''/webservices/server_other.php'''

Par exemple, sur la démo en ligne, appeler la page de client web service suivante
http://demo.dolibarr.org/webservices/demo_wsclient_other.php

=Liste des services disponibles=
La liste des services disponibles peut être consultée en appelant la page '''/webservices/'''.
Par exemple, pour le serveur Dolibarr de démo, ce sera l'URL: https://demo.dolibarr.org/webservices/

Cette liste est très courte actuellement mais elle sera enrichie avec de futures versions...

Fonctions utiles Développeur Dolibarr

2019-08-19T10:52:54Z

Unareil: /* GETPOSTISSET() */

{{TemplateDocDev}}

La page suivante décrit quelques fonctions importantes utilisées par dolibarr.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé. Les méthodes PHP $_GET et $_POST ne doivent donc pas être utilisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

*'none' pour pas de vérification du type de paramètre,
*'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
*'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
*'alpha'=vérifie que c'est du texte et des signes
*'aZ'=vérifie que c'est a-z seulement
*'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
*'array'=vérifie que c'est un tableau
*'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
*'nohtml'=verifie qu'il n'y a pas de code html
*'alphanohtml'=verifie qu'il n'y a pas de code html
*'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

==GETPOSTISSET()==
GETPOSTISSET(nomDeLaVariable) permet de savoir si la variable GET ou POST passée en paramètre est définie.

Exemple en php : <syntaxhighlight lang="PHP">
if (isset($_POST['monChamp'])){...}
</syntaxhighlight>devient : <syntaxhighlight lang="PHP">
if (GETPOSTISSET('monChamp')){...}
</syntaxhighlight>Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

==img_picto==
img_picto() fonction permettant d'insérer une image.<syntaxhighlight lang="PHP">
print img_picto(titreDelimage,nomDeLimage);
</syntaxhighlight>

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

Fonctions utiles Développeur Dolibarr

2019-08-19T10:49:14Z

Unareil: ajout de la fonction GETPOSTISSET

{{TemplateDocDev}}

La page suivante décrit quelques fonctions importantes utilisées par dolibarr.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé. Les méthodes PHP $_GET et $_POST ne doivent donc pas être utilisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

*'none' pour pas de vérification du type de paramètre,
*'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
*'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
*'alpha'=vérifie que c'est du texte et des signes
*'aZ'=vérifie que c'est a-z seulement
*'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
*'array'=vérifie que c'est un tableau
*'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
*'nohtml'=verifie qu'il n'y a pas de code html
*'alphanohtml'=verifie qu'il n'y a pas de code html
*'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

== GETPOSTISSET() ==
GETPOSTISSET(nomDeLaVariable) permet de savoir si la variable GET ou POST passée en paramètre est définie.

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

==img_picto==
img_picto() fonction permettant d'insérer une image.<syntaxhighlight lang="PHP">
print img_picto(titreDelimage,nomDeLimage);
</syntaxhighlight>

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

Fonctions utiles Développeur Dolibarr

2019-08-19T10:37:15Z

Unareil: /* img_picto */

{{TemplateDocDev}}

La page suivante décrit quelques fonctions importantes utilisées par dolibarr.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé. Les méthodes PHP $_GET et $_POST ne doivent donc pas être utilisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

*'none' pour pas de vérification du type de paramètre,
*'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
*'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
*'alpha'=vérifie que c'est du texte et des signes
*'aZ'=vérifie que c'est a-z seulement
*'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
*'array'=vérifie que c'est un tableau
*'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
*'nohtml'=verifie qu'il n'y a pas de code html
*'alphanohtml'=verifie qu'il n'y a pas de code html
*'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

==img_picto==
img_picto() fonction permettant d'insérer une image.<syntaxhighlight lang="PHP">
print img_picto(titreDelimage,nomDeLimage);
</syntaxhighlight>

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

Fonctions utiles Développeur Dolibarr

2019-08-19T10:33:02Z

Unareil: Ajout de la fonction img_picto

{{TemplateDocDev}}

La page suivante décrit quelques fonctions importantes utilisées par dolibarr.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé. Les méthodes PHP $_GET et $_POST ne doivent donc pas être utilisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

*'none' pour pas de vérification du type de paramètre,
*'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
*'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
*'alpha'=vérifie que c'est du texte et des signes
*'aZ'=vérifie que c'est a-z seulement
*'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
*'array'=vérifie que c'est un tableau
*'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
*'nohtml'=verifie qu'il n'y a pas de code html
*'alphanohtml'=verifie qu'il n'y a pas de code html
*'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

== img_picto ==
img_picto() fonction permettant d'insérer une image.<syntaxhighlight lang="PHP">
print img_picto(titreDelimage,nomDeLimage);
</syntaxhighlight>

Langages et normes

2019-08-19T10:11:45Z

Unareil: /* PHP */ ajout d'un lien vers fonctions utiles Dolibarr

[[en:Language_and_development_rules]]
[[es:Lenguaje_y_Normas_de_Desarrollo]]
[[zh:语言和开发规则]]


{{TemplateDocDev}}

Voici les quelques règles sur le langage, la syntaxe et normes de développement en vigueur pour le projet Dolibarr:

=Versions=

*Dolibarr doit fonctionner sur:

#Tous OS (Windows, Linux, MACOS...)
#PHP {{PHPMinVersion}} (Doit fonctionner sans aucun module PHP complémentaire hors les modules d'accès base de donnée).
#Mysql {{MySqlMinVersion}}

=Normes Copyright=

*Tout fichier PHP doit avoir un en-tête selon le masque suivant

<source lang="php">
<?php
/* Copyright (C) YYYY John Doe <email@email.com>
*
* Licence information
*/
...
</source>
Quand vous éditez un fichier existant du projet, ajouter une ligne Copyright sous celles existantes.

=Normes PHP=

==PHP==

*Dolibarr est écrit en PHP et supporte toutes versions PHP supérieures à la {{PHPMinVersion}}. Les fichiers doivent tous comporter l'extension .php

*L'appel aux variables superglobales PHP doit passer par les opérateurs dédiés $_COOKIES, $_SERVER, $_ENV mais par la fonction dolibarr [[Fonctions utiles Dolibarr|GETPOST()]] pour récupérer les contenus de $_GET ou $_POST.

Les autres opérateurs ($HTTP_SERVER_GET, ...) ayant été passés en deprecated au sein de PHP, ne doivent plus être utilisés. Ainsi le code doit fonctionner y compris quand l'option '''register_long_arrays''' est à off.
De plus, le code doit fonctionner aussi bien quand l'option PHP '''register_globals''' est à off (recommandé par PHP) que quand l'option '''register_globals''' est à on (par défaut sur de nombreuses installations).

*Pas d'utilisation de la variable '''PHP_SELF'''. Utiliser à la place $_SERVER["PHP_SELF"]. Notez aussi que le framework Dolibarr passe une routine pour rendre plus sûr le contenu du $_SERVER["PHP_SELF"] (dans le fichier main.inc.php, donc avant tout traitement métier)

*Quand plusieurs variables doivent être initialisées avec la même valeur, il faut utiliser plusieurs instructions:

<source lang="php">
$var1=1;$var2=1;$var3=1;
</source>
plutôt que
<source lang="php">
$var1=$var2=$var3=1;
</source>
qui est moins performant.

*Les chaines doivent être encadrées de simple quote et les variables sorties de la chaine.

<source lang="php">
print 'Mon texte affiche ma '.$variable.' !';
</source>

*Les commentaires doivent suivre la syntaxe C, ie un double antislash pour un commentaire d'une ligne et utilisation slash-étoile pour ouvrir un bloc de plusieurs lignes

<source lang="php">
/* Bloc de commentaire
*
* Fin du bloc
*/

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

for ($i = 1 , $i < 2 ; $i++)
{
// commentaire sur une ligne
print $i;
}

</source>

*Les fonctions doivent retourner une valeure strictement > à 0 en cas de succès, et un nombre < à 0 en cas d'erreur.

*Pas de code mort (non utilisé) dans le code principal de Dolibarr (le code utilisé uniquement par un module externe doit être inclus dans le module externe).

*Utiliser "include_once" pour l'inclusion de tout fichier contenant des définitions de fonction ou de classes (donc fichiers *.class.php et *.lib.php), utiliser "include" pour tout inclusion de fichier de type template ou contenant un mixte de HTML et PHP (donc fichiers *.inc.php et *.tpl.php).

*Le style de code a utiliser est le PSR-2 (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). Seules les règles "MUST" sont imposées. Notez aussi les points/excetions suivants:
**La longueur des lignes: PSR-2 indique que la longueur des lignes a une limite "soft" à 120. Il est en effet préférable d'avoir de longues lignes de données de déclaration plutôt que de longues pages car ce code ne contient aucune logique, toutefois une limite "hard" a été instauré à '''1000''' caractères. Du code qui ira au dela provoquera des erreurs dans la plateforme d'Intégration Continue.
**Les tabulations sont acceptées: L'autre exception est qu'on ne remplace pas les tabulations systématiquement par des espaces. L'utilisation des tabulations simplifie la vie de certains développeurs. De plus, l'utilisation d'espaces rend certaines fonctions d'autoformatage défectueuses (comme sur certaines versions d'Eclipse, lors de copié-collé).
**Note 1: Les règles suivantes sont particulièrement importantes:
***Les fichiers doivent être sauvés en format Unix (LF) et non Windows (CR/LF). Le format Unix étant compatible sur les OS Unix like, Windows, Mac, alors que le format fichier texte Windows pose problème sous certains PHP sous Unix.
***Les smart tags PHP ne sont pas utilisés. Les sections de code doivent commencer par '''<?php'''
**Note 2: Vous pouvez utiliser le fichier '''dev/codesniffer/ruleset.xml''' comme fichier de contrôle pour vérifier votre style de code avec PHPCodeSniffer.
**Note 3: Vous remarquerez que le code actuel ne suit pas forcément tout cela. La raison est historique. La règle fut instaurée en cours de route, aussi, si vous trouvez du code non respectueux de ce standard, n'hésitez pas à le corriger.

==Structures des classes et champs==

Certaines propriétés de classes se retrouvent dans de nombreuses classes. Pour homogénéité, on utilisera les noms suivants:
{{TemplatePHPFields}}

=Normes SQL=

==Structure des tables et champs==

*Toutes les tables sont préfixées pour éviter les conflits de nommage. Aujourd'hui, le préfixe est modifiable au moment de l'installation. Sa valeur par défaut est <tt>llx_</tt>.

*Structure des tables.

Lorsque vous créez une table, il est recommandé de prendre les même conventions de nommages de tables que les autres tables Dolibarr. Avec, à minima les champs suivant:
- rowid INTEGER AUTO_INCREMENT PRIMARY KEY qui est l'id technique
- entity INTEGER default 1 that is id for the multicompany feature
- date_creation datetime that is the creation date
- tms timestamp qui sera un champ contenant la date de chaque mise à jour (la base de donnée le gère tout seul, pas besoin de le gérer par le code)
- import_key qui contiendra le code d'import YYYYMMDDHHMMSS si vous faites des imports en masse dans la table.

Eventuellement
- fk_user_creat integer qui est l'id du user de création (fk_user_author also found)
- fk_user_modif integer qui est l'id du user de modification
- fk_user_valid integer qui est l'id du user de validation
- fk_soc integer qui est l'id du tiers (si applicable)

*Type des champs

Dans la pratique, afin d'etre compatible avec toutes les précisions des pays, syntaxes des bases, on utilisera uniquement les types suivants:
- smallint pour tout petit nombre entier
- integer pour tout nombre entier, id ou clé étrangère
- double(24,8) pour tout montant
- double(6,3) pour les taux de tva
- real pour une quantité
- varchar pour une chaine (y compris de longueur 1, le type char est de plus en plus déprécié)
- timestamp pour un champ date+heure devant être mis a jour automatiquement
- datetime pour un champ date+heure
- date pour un champ date

==Clé primaire==
La clé primaire d'une table s'appelle <tt>rowid</tt>.

Il y a quelques tables qui échappent à cette règle actuellement (ex [[Table llx_c_actioncomm]]), pour des raisons historiques. Une évolution pourra être étudiée pour une prochaine version.

==Clés étrangères==
Le nom d'une clé étrangère commence par le préfixe <tt>fk_</tt> suivi du nom de la table liée (requis pour éviter doublons globales à la base, problématiques sous certains SGBD comme postgresql) puis du champ lié (pour permettre plusieurs clés étrangères différentes sur une même table).

Exemple:
fk_facture_fourn_fk_soc

Note: Si vous développez votre propre module externe, il ne doit pas y avoir de clé étrangère depuis vos tables qui pointent sur les tables standards de Dolibarr. Ceci casserait les fonctionnalités de mise à jour, de réparation, de sauvegardes et de restauration.

==Clés alternatives==
Parfois, il n'y a pas que la clé primaire qui doit être unique. On peut donc ajouter aussi un index clé alternative unique. Un tel index est nommé par un nom qui commence par le préfixe <tt>uk_</tt> suivi du nom de la table (requis pour éviter doublons d'index globals à la base, problématiques sous certains SGBD comme postgresql) puis d'un suffixe qui caractérise la clé (pour permettre plusieurs index uniques sur une même table).

Exemple:
uk_societe_code_client

==Index performance==
Certains champs sont souvent utilisés comme critère de recherche, de tri ou de jointure. Il convient dans ce cas, d'y mettre un index de performance. De tels indexes seront nommés avec un préfix <tt>idx_</tt> puis le nom de la table et le nom du champ sur lequel porte l'index.

Exemple:
idx_societe_user_creat

==Format de fichier DDL==
Les fichiers qui contiennent la définition de la structure de la base (DDL) doivent être au nombre de 2 par tables:
Chaque table est définie dans son propre fichier dont le nom est <tt>llx_''matable''.sql</tt>.
On mettra un commentaire à côté de chaque champ pour en expliquer la signification.
Les clés étrangères et index de performance ou autres contraintes d'unicité sont définies dans un fichier séparé dont le nom est <tt>llx_''matable''.key.sql</tt>

Ces fichiers sont placés dans le répertoire '''install/mysql/tables''' pour les fichiers standards ou '''monmodule/tables''' pour les tables amenées par un module.

Exemple '''fichier table 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
)ENGINE=innodb;
</source>

Exemple '''fichier clés/index 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>

==Règles de codage SQL==

*Utilisation des alias/nommage de champs

Dans le cas des select on pourra utiliser les alias pour simplifier l'écriture des requêtes:
<source lang="sql">
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
</source>
Toutefois, il ne faut pas utiliser ces alias sur des requêtes update car non compatible avec mysql 3.1.

*Les SELECT * sont interdits ! Chaque SELECT doit spécifier la liste complète des champs à récupérer. Cela permet d'éviter les confusions. Exemple:

<source lang="sql">
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
</source>

*Dans les requêtes SQL, on quote les champs mais pas les numériques qui contiennent des montants destinés à être stockés dans des champs de type double ou real. Les quotes sur les numériques de type float provoquent parfois un stockage d'une valeur différente. Par exemple 412.62 dans le insert sera en fait stocké avec la valeur 412.61999512 en base (suite à des conversions chaines-numériques implicites) si le champ est de type double(24,8). Et seul le PHP voit 412.61999512. Les autres outils verront 412.62 donnant l'impression qu'il n'y a pas de problème. Et c'est le PHP qui a raison, il y a problème en base. En supprimant les quotes sur les numériques, cela va mieux.

Exemple:
<source lang="sql">
Bon: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
Mauvais: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
</source>

Remarque, le problème des float est général et pas seulement sur les accès base, il est présent dans tous les languages quand on travaille sur des nombres réels, aussi ils doivent être, dès que affectés, nettoyés par la fonction price2num avec le 2eme paramètre renseigné à:
'MU' (si il s'agit d'un prix unitaire), 'MT' (s'il s'agit d'un prix total) ou 'MS' (autres cas) selon le besoin.
Voir aussi le chapitre "Les nombres réels, montants et calculs" plus bas.

*Les fonctions NOW, SYSDATE ou DATEDIFF sont interdites au sein des ordres SQL. S'il faut saisir la date du moment dans un champ, la valeur doit venir du PHP, par exemple par la fonction dol_now(), et non du moteur de base de données. Ceci afin d'avoir une meilleure portabilité du code mais surtout d'avoir une gestion correcte des TimeZone et ne pas dépendre du TimeZone de la base de donnée.

Par exemple, on ne fera pas:
<source lang="php">
$sql="SELECT rowid FROM table where datefield = NOW()";
</source>
mais:
<source lang="php">
$sql="SELECT rowid FROM table where datefield = '".$this->db->idate(dol_now())."'";
</source>

Par exemple, on ne fera pas:
<source lang="php">
$sql="SELECT rowid FROM table where DATEDIFF(table.datefield, NOW()) > 7";
</source>
mais:
<source lang="php">
$sql="SELECT rowid FROM table where datefield < '".$this->db->idate(dol_now() - (7 * 24 * 3600))."'";
</source>

Un autre avantage de cette règle est que la requête peut bénéficier de l'utilisation de l'index puisqu'on compare datefield à une valeur fixe. Dans le cas du datediff, on applique un traitement sur le champ avant comparaison, rendant impossible l'utilisation de l'index de ce champ. Les conséquences sont des performances très dégradées par rapport à la version sans datediff.

==Règles de migration de base==

*Les scripts de migration de structure sont les fichiers de type '''install/mysql/migration/a.b.c-x.y.z.sql'''. Dans un fichier de migration de n vers n+1, on ne détruit une table (DROP TABLE) qui n'est plus utilisée en n+1 que lors de la migration de la version n+1 vers n+2. Ceci afin de toujours conserver les tables deprecated le temps d'une version pour réparer une situation en cas d'erreur de migration.

==Spécificités MySQL==

*Les tables doivent être au format InnoDB.

En effet, ce format gère les clés étrangères, les éventuelles restrictions qui y sont attachées et la notion d'intégrité de transactions requise pour avoir des données en base cohérente entre tables.

*Dolibarr DOIT fonctionner même avec les options '''strict''' de Mysql active.

Pour l'activer, ajouter la ligne suivante dans le fichier config du serveur Mysql (my.cnf ou my.ini)
<source lang="ini">
sql-mode="STRICT_ALL_TABLES,ONLY_FULL_GROUP_BY,NO_ZERO_DATE"
</source>

==Spécificités PostgreSQL==
Seuls les fichiers pour Mysql doivent être maintenus.
Les fichiers pour les autres bases sont convertis "à la volée" par le driver Dolibarr de la base.

Il existe une exception.
Les requêtes "UPDATE FROM" :
Syntax MySQL :
<source lang="sql">
UPDATE table_taget as target, table_source as source SET fieldtarget=source.fieldsource
WHERE source.rowid=target.rowid;
</source>

Syntax PgSQL:
<source lang="sql">
UPDATE table_taget as target SET fieldtarget=source.fieldsource
FROM table_source as source WHERE source.rowid=target.rowid;
</source>

Il n'en existe pas dans Dolibarr, mais pour vos modules Vous devriez faire tel que :
<source lang="php">
if ($this->db->type=='pgsql') {
$sql="UPDATE table_taget as target SET fieldtarget=source.fieldsource
FROM table_source as source WHERE source.rowid=target.rowid";
} else {
$sql= "UPDATE table_taget as target, table_source as source SET fieldtarget=source.fieldsource
WHERE source.rowid=target.rowid";
}
</source>

=Normes HTML=

*Tous les attributs dans les balises HTML doivent être *en minuscule* et quotés avec des *doubles quote*.

*Les liens href doivent être absolus en se basant sur la fonction dol_buildpath() pour obtenir un chemin absolu depuis un chemin relatif au répertoire htdocs. Pour les tags img, il faut faire appel à la fonction img_picto().

Par example:
<source lang="php">
print '<a href="'.dol_buildpath('/monrep/mapage.php').'">'.img_picto('Texte alt','nompictopng','').'</a>';
</source>

*Les tables HTML doivent avoir des colonnes sans valeurs forcées, excepté pour les colonnes qui contiennent une information dont la longueur est non variable. Par exemple, une colonne avec un picto peut être forcée à with="20px". Dans les autres cas, il faut éviter de forcer la largeur des colonnes. La raison est que, dans la plupart des cas, le navigateur fait un meilleur travail pour définir automatiquement la bonne largeur des colonnes qu'en forçant manuellement les largeurs. Et ceci marche quelque soit la résolution de l'écran.

*Le javascript/ajax et l'appel aux scripts java dans les pages php est à proscrire. Si toutefois du code javascript est inclus, il doit être conditionné par le test sur "$conf->use_javascript_ajax"

<source lang="php">
if ($conf->use_javascript_ajax) {
... // Le code php qui génère du javascript est ici
}
</source>

*Les popups windows ne doivent pas être utilisées, sauf pour des tooltips (et restent conditionnées par le point ci-dessus).

*Les scripts externes sont écrits en Perl s'ils ne peuvent l'être en php, l'utilisation d'un autre langage n'est pas interdit mais doit être discuté au préalable dans la mailing list des développeurs.

=Normes Dolibarr et squelettes de code=

==Squelettes de code==
Afin d'uniformiser le code et d'accélérer le développement de nouveaux composants dans Dolibarr, se trouvent dans le répertoire '''dev/skeletons''', 4 squelettes de code tout préparés.

*1 qui sert d'exemple de descripteur de module: '''myModule.class.php'''
*1 qui sert d'exemple de code pour faire une nouvelle classe: '''skeleton_class.class.php'''
*1 qui sert d'exemple de code pour faire une nouvelle page: '''skeleton_page.php'''
*1 qui sert d'exemple de code pour faire un script à exécuter en ligne de commande: '''skeleton_script.php'''

Servez-vous en comme exemple.
Notons que ces squelettes sont aussi utilisés par le générateur de code PHP qui est décrit dans la chapitre de développement de module Dolibarr pour accélérer vos développement.

==Les dates et TimeZone==
Dolibarr se veut une application multi-utilisateur et multi-localisation. Il convient donc de stocker les dates dans le bon format. Pour éviter les problèmes de conversion, les règles suivantes doivent être appliquées:

*Une date en mémoire doit être au format Timestamp GMT.
*Une date stockée en base de données contient le Timestamp issue de la date soumise dans la requête en heure locale du serveur PHP. Cela ne concerne pas les dates mises à jour automatiquement par la base (champ '''tms''' en base).

Ainsi le 1er janvier 1970, 3 heures à Paris (TZ=+1) = 1er janvier 1970, 2 heures à Greenwich (TZ=0) sera stocké en mémoire par 7200 et sera soumis à la base de données avec la chaine '19700101030000' (PHP convertit en heure de son TZ et la base déconvertit avec son TZ qui est le même que celui de PHP).

Les méthodes select doivent donc traduire les champs dates lus qui sont au format chaine TZ de la base ('19700101030000') par appel de la méthode db->jdate afin de récupérer une information en mémoire au format Timestamp GMT. Et les méthodes insert doivent lors de la génération de la requête convertir la date mémoire connue en variable, par la méthode db->idate (Voir exemples générés par le squelette).

*Les dates mises à jour automatiquement par la base (champ '''tms''' en base) contiennent le Timestamp où la modification est faite selon le timezone de la base de donnée. Les méthodes select récupèrent cette donnée en mémoire au format Timestamp GMT en appliquant également le db->jdate. Si le timezone de la base de donnée diffère de celui du PHP (un des 2 est mal réglé), il peut donc y avoir des écarts entre date de création et modification.

*La manipulation de dates en PHP doit être faite en utilisant les fonctions dates de Dolibarr: '''dol_now(), dol_mktime(), dol_stringtotime(), dol_getdate(), dol_time_plus_duree()'''. Vous trouverez également d'autres fonctions prêtes à l'emploi dans le fichier '''date.lib.php'''.

==L'encodage UTF8/ISO==
Dolibarr stocke les informations de manière suivante:

*En base de donnée, les données sont en UTF8 ou ISO. Cela dépend du pagecode de la base, donc des options à la création de cette base. Dans tous les cas le driver d'accès base Dolibarr (dans /lib/database) s'arrange à la lecture et insertion pour convertir vers et depuis de l'UTF8.
*Les données en mémoires sont donc stockées en UTF8 (instances d'objets PHP).
*Les pages web affichées à l'écran sont au format UTF8 (avec les versions < 2.5.1, c'est le vieux paramètre $character_set du fichier conf.php qui définissait le format de sortie).

==Les nombres réels, montants et calculs==
En PHP comme dans d'autres langages (Java par exemple), les données non entières (float, real, double) ne sont pas fiables.
Essayer de faire par exemple
<source lang="php">
print 239.2 - 229.3 - 9.9;
</source>
Vous n'obtiendrez pas zéro mais un nombre très petit en puissance de 10 négative. Si vous obtenez zéro, vous pourrez trouvez d'autres exemples qui ne fonctionnent pas.
Le problème des float est général, une variable résultante de calcul de nombre réels doit SYSTEMATIQUEMENT être nettoyée par la fonction '''price2num()''' avec le 2eme paramètre renseigné à: 'MU', 'MT' ou 'MS' selon le besoin (voir doc fonction).
<source lang="php">
print price2num(239.2 - 229.3 - 9.9, 'MT');
</source>
S'il ne s'agit pas d'un prix sur lequel s'adapte les paramètres MU, MT ou MS, il faut utiliser la fonction '''round()'''.

==Création de tables==
Ne pas créer de table à l'utilisation, c'est-à-dire à la '''première utilisation''' du module.
Si vous créez un module qui utilise des tables qui ne sont pas intégrées en standard dans le code de Dolibarr, veillez à suivre le didacticiel [[Développement module]] qui explique comment joindre des tables qui se créent à l'activation du module et non à son utilisation (voir plus haut).

==Comparer la version==

Si votre code a besoin de faire des choses différentes selon la version de Dolibarr, vous pouvez utiliser le truc suivant pour comparer les versions

<source lang="php">
$version=preg_split('/[\.-]/',DOL_VERSION);
if (versioncompare($version,array(5,0,-4)) >= 0) { //mycode for 5.0 only; } // For dolibarr 5.0.* (the -4 means we include also alpha, beta, rc and rcX)
</source>

Mais cette solution requiert de faire un include avoir la fonction versioncompare. Une alternative est d'utiliser le test suivant:
<source lang="php">
if ((float) DOL_VERSION >= 5.0) { //mycode for 5.0 only; } // For dolibarr 5.0.*
</source>

==Logs==
Ajouter des traces dans votre code avec la fonction
<source lang="php">
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
</source>

==Répertoires de travail==
Si vous avez besoin de créer un répertoire de travail, dans votre code, faites référence à ce répertoire par
'''DOL_DATA_ROOT.'/monmodule''''

Le répertoire peut être créé dans votre code à l'exécution par le code suivant:
<source lang="php">
$mymoduledir=DOL_DATA_ROOT.'/monmodule';
dol_mkdir($mymoduledir);
</source>

Si vous avez besoin d'un répertoire qui contiendra des données temporaires, ce répertoire doit être''' DOL_DATA_ROOT.'/monmodule/temp''''

=Design patterns et programmation objet=

==Design patterns de Création (GoF)==
Design patterns définis par le Gang Of Four (voir la wikipédia sur les [[wikipedia:Patron de conception|Design patterns]]).
Dans Dolibarr, pas de mise en oeuvre de design patterns de comportement particulier.
On trouve des objets proches des Singletons et Fabriques conforme à 100% dans l'esprit mais pas dans la syntaxe, ceci afin d’être compatible avec la plus large plage possible de versions de PHP.

==Design patterns d'entreprises (Martin Fowler)==

===Mode d'organisation du code===
[[wikipedia:Martin_Fowler|Martin Fowler]] a identifié 3 méthodes d'organisation du code appelées '''patterns''' ('''motifs'''):

*Le '''Transaction Script''' (Le code est linéaire en fonction d'une action utilisateur).

C'est le motif à l'ancienne utilisé dans les langages procéduraux.
Inconvénient: Redondance du code. Nécessité de connaitre le modèle physique pour développer les parties métiers.

*Le '''Domain Model'''

C'est un concept possible depuis les langages objets. Ce sont les procédures métiers (qui doivent être identifiés avant) qui servent de bases pour les classes objets.
Inconvénient: Motif complexe à maintenir.

*Le '''Table Module'''

Un intermédiaire entre les 2 précédents où l'on a une instance unique de classe par table de la base de données.

-> Comme le montre les squelettes de code (voir point précédent), Dolibarr se base sur le principe du '''Table Module'''.

===Communication Logique métier - Données (ORM)===
Il existe 3 modes de liaisons:

*Le '''Table And Row Data Gateway'''

C'est le plus simple. On crée une classe par table et chaque classe est un pont avec la table correspondante et propose les méthodes CRUD sur cette table (Create, Read, Update, Delete). Une instance de classe étant alors un enregistrement de la table. La classe ne contient que du code d'accès aux lignes ou colonnes de tables. Le code métier doit alors être ajouté dans d'autres classes. Les liens entre ces classes tables et les classes métiers devant être connues ou déduite de la connaissance du développeur.

Exemple: C'est le mode mis en oeuvre quand on utilise certains Frameworks d'ORM comme '''iBatis''' (http://ibatis.apache.org/).

*Le '''Active Record'''

Identique au précédent, mais on se permet d'ajouter quelques fonctions métiers sur la classe, à conditions que ces fonctions soient bien propres à la table ou à la notion métier porté par l'enregistrement. C'est le pattern qui offre le meilleur rapport fonctionnalité/complexité.

Exemple: C'est le mode choisi pour les développements Dolibarr et de nombreuses autres applications PHP qui ont leur propre framework et pratiques de développements.

*Le '''Data Mapper'''

Les classes représentent les entités du problème et non les données. Il faut donc doubler, tripler... ces classes avec des classes Mapper pour accéder aux données.
Plus "puriste" sur le papier car plus proche du métier, ce mode a aussi l'inconvénient d'être très complexe et difficile à maintenir dans la réalité (l'expérience pratique constaté ne rejoignant pas les promesses de la théorie).

Exemple: C'est le choix si on utilise le Framework d'ORM '''Propel''' (http://propel.phpdb.org/trac/). On le trouve donc sur des applications plus lourdes basées sur cet ORM entre autres.

-> Pour les développements Dolibarr, il est recommandé d'utiliser le mode de liaison '''Active Record''' qui offre les avantages d'un modèle proche du métier sans en avoir la complexité et sans trop masquer non plus la technique. C'est dans ce mode que le développement, la compréhension du code et la maintenance technique et/ou fonctionnelle semble la plus productive (ceci est toutefois un éternel débat entre les puristes et les pragmatiques, débat dans lequel personne ne peut vraiment avoir raison, car tout dépend des objectifs à atteindre).

==Design Pattern d'Interface Graphique==
Il existe plusieurs design pattern pour les interfaces utilisateurs (MVC, MVP, MVVM).
Beaucoup confonde ce design pattern avec celui consistant à utiliser un framework de templates. C'est sans rapport. Un framework de template (voir point précédent) n'est en lien qu'avec la partie "V" de ces modèles.

-> Dolibarr utilise le Design Pattern MVC. La partie M est matérialisée par une classe DAO contenant les méthode CRUD (Create-Read-Update-Delete) d'accès à la table.
Beaucoup de frameworks ont fait le choix de mettre la partie de code C (Controller) et la partie de code du V (vue) dans des fichiers, voir même répertoires séparés. La maintenance semble plus aisé sur la papier, en pratique, il faut sans arrêt jonglé entre n fichiers, le C étant fortement lié au V. Aussi dans Dolibarr, la séparation est faite par une simple section de commentaire. La partie de code C (Controller) est donc le code qui se trouve sont la balise
<pre>
/*
* Actions
*/
</pre>
Elle est suivi par la partie de code V (Vue), bien séparé du C par la balise
<pre>
/*
* View
*/
</pre>

Ce mode de séparation a eu un effet neutre sur les nouveaux développement mais a permis de réduire de manière si importante le temps requis pour la maintenance et correction de bugs qu'il n'est pas envisagé de basculer vers un autre type de séparation (oui les constats fait dans la vraie vie ne sont pas toujours ceux attendus par la théorie scolaire). L'important reste qu'il y ait toujours séparation entre le C et le V, peut importe comment est matérialisé cette séparation, du moment qu'elle l'est (Rappel: Ne pas confondre la notion de séparation du C et du V avec la notion de séparation du code pour alimenter la données d'une Vue et du code pour formater la Vue, ceci un principe de séparation relevant du Design Pattern de Vue, voir point suivant).

==Design Pattern de Vue - Présentation==
Il existe des frameworks spécialisés dans le Design Pattern de Vue, la partie qui consiste à formater l'écran vue par l'utilisateur.
Les vieilles versions de Dolibarr utilisaient Smarty. Ce framework est une surcouche à un Framework, déjà très puissant de formatage d'écran nommé PHP. Les bénéfices étant très inférieurs aux inconvénients, il a été abandonné au profit du PHP qui reste le plus simple, le plus universel des frameworks de présentation. Son seul défaut est qu'il ne peut garantir à 100% les écarts d'un développeur qui irait intégrer dans la Vue, une logique sans rapport avec la présentation (donc autre que du code à vocation de génération, de formatage, de sortie HTML, de logique de test ou de boucle). Ce point est toutefois contrôlé par le mécanisme de validation du code des chefs de projets.
La encore, c'est l'experience et le constat d'un meilleur rendement de productivité qui a motivé l'abandon des frameworks de Présentation externes au profit du framework PHP.

Fonctions utiles dolibarr

2019-08-19T10:09:56Z

Unareil: Unareil moved page Fonctions utiles dolibarr to Fonctions utiles Dolibarr

#REDIRECT [[Fonctions utiles Dolibarr]]

Fonctions utiles Développeur Dolibarr

2019-08-19T10:09:56Z

Unareil: Unareil moved page Fonctions utiles dolibarr to Fonctions utiles Dolibarr

Lorsque j'ai commencé le développement sous Dolibarr, je me suis retrouvé confronter face à tout un tas de fonctions importantes utilisées par dolibarr que je ne connaissais pas.

N'ayant trouvé que le fichier code source en documentation, j'ai décidé de récapituler ces fonctions dans cette page.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

* 'none' pour pas de vérification du type de paramètre,
* 'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
* 'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
* 'alpha'=vérifie que c'est du texte et des signes
* 'aZ'=vérifie que c'est a-z seulement
* 'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
* 'array'=vérifie que c'est un tableau
* 'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
* 'nohtml'=verifie qu'il n'y a pas de code html
* 'alphanohtml'=verifie qu'il n'y a pas de code html
* 'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir commentaires lignes 252 à 269 du fichier htdocs/core/lib/functions.lib.php

Fonctions utiles Développeur Dolibarr

2019-08-19T10:08:41Z

Unareil: mise en forme

Fonctions utiles Développeur Dolibarr

2019-08-19T10:07:46Z

Unareil: /* GETPOST */

Lorsque j'ai commencé le développement sous Dolibarr, je me suis retrouvé confronter face à tout un tas de fonctions importantes utilisées par dolibarr que je ne connaissais pas.

N'ayant trouvé que le fichier code source en documentation, j'ai décidé de récapituler ces fonctions dans cette page.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

'none' pour pas de vérification du type de paramètre,

'int'= vérifie que c'est un numérique(entier ou nombre à virgule)

'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')

'alpha'=vérifie que c'est du texte et des signes

'aZ'=vérifie que c'est a-z seulement

'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres

'array'=vérifie que c'est un tableau

'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)

'nohtml'=verifie qu'il n'y a pas de code html

'alphanohtml'=verifie qu'il n'y a pas de code html

'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir commentaires lignes 252 à 269 du fichier htdocs/core/lib/functions.lib.php

Fonctions utiles Développeur Dolibarr

2019-08-19T10:07:16Z

Unareil: Précision des paramètres

Lorsque j'ai commencé le développement sous Dolibarr, je me suis retrouvé confronter face à tout un tas de fonctions importantes utilisées par dolibarr que je ne connaissais pas.

N'ayant trouvé que le fichier code source en documentation, j'ai décidé de récapituler ces fonctions dans cette page.

==GETPOST==
GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé.

Utilisation possible :

Exemple en php : <syntaxhighlight lang="PHP">
$monChamp= $_POST["monChamp"];
</syntaxhighlight>devient si l'élément passé en paramètre est un entier :<syntaxhighlight lang="PHP">
$monChamp= GETPOST("monChamp",'int');
</syntaxhighlight>

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

'none' pour pas de vérification du type de paramètre,

'int'= vérifie que c'est un numérique(entier ou nombre à virgule)

'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')

'alpha'=vérifie que c'est du texte et des signes

'aZ'=vérifie que c'est a-z seulement

'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres

'array'=vérifie que c'est un tableau

'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)

'nohtml'=verifie qu'il n'y a pas de code html

'alphanohtml'=verifie qu'il n'y a pas de code html

'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir commentaires lignes 252 à 269 du fichier htdocs/core/lib/functions.lib.php

Fonctions utiles Développeur Dolibarr

2019-08-19T09:36:09Z

Unareil: Mise en forme

Fonctions utiles Développeur Dolibarr

2019-08-19T09:33:34Z

Unareil: Mise en forme

Fonctions utiles Développeur Dolibarr

2019-08-19T09:23:27Z

Unareil: Ajout de fonctions utiles essentielles pour débuter la programmation sous Dolibarr

List of modules id

2019-08-06T17:14:16Z

Unareil: Ajout de la plage 230000 - 230049 pour l'activité Unareil de l'entreprise la Fortune de la Nature

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}}
This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here.

{{Flag fr}}
Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici.

{{Flag sp}}
Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

=ID 0 - 99999=
{{Flag en}}
Reserved for Dolibarr's internal modules.

{{Flag fr}}
Réservé aux modules internes de Dolibarr.

{{Flag sp}}
Reservado a los módulos internos de Dolibarr.

=ID 100000 - 499999=
{{Flag en}}
Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 50 numbers only the first time)

{{Flag fr}}
Zone réservé aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limité à 50 valeurs la première fois)

{{Flag sp}}
Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 50 valores por editor)

[File:Warning]: If you reserve more than 50, we may automatically change your reservation range without information and you may experience conflicts with other modules in a future, so please follow the rules !

*ID 100000 - 100999: OpenThink (http://www.openthink.be)
*ID 101000 - 101999: NLTechno (https://www.nltechno.com)
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
*ID 105000 - 105999: GPC.solutions
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Aplose (http://www.aplose.fr)
*ID 110000 - 110999: Librethic (https://librethic.io)
*ID 111000 - 111999: Asset IT (www.assetit.ch)
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
*ID 113000 - 113999: Asilib - Alexandre Spangaro
*ID 114000 - 114999: Iceleaf OÜ
*ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
*ID 116000 - 116999: Wolftec GmbH
*ID 117000 - 117999: Oscim (http://www.oscim.fr)
*ID 118000 - 118999: Oarces Web (dev.oarces.com)
*ID 119000 - 119999: Manuel Berrocal - Absolacom
*ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
*ID 121000 - 121999: Oscss - Shop
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: backbone internet service (www.backbone.co.at)
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br)
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
*ID 131000 - 131999: Joan Louis (itaca.fr)
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr)
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 135000 - 135999: Net-Logic (http://netlogic.fr)
*ID 140000 - 140999: Altairis
*ID 150000 - 150999: Jeffinfo
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 162000 - 162999: Jacques Rébiscoul
*ID 163000 - 163999: Open-DSI (https://www.open-dsi.fr)
*ID 170000 - 170999: TRIDENT CONSULTING LTD (www.tridentdxb.com)
*ID 171000 - 171999: LVSInformatique (www.lvsinformatique.com)
*ID 180000 - 180999: Triangle Ingénierie
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 199000 - 199999: RFMS
*ID 200000 - 200999: Noxiome
*ID 201000 - 201999: Sasa Ostrouska (saxa)
*ID 202000 - 202999: Z-Application
*ID 203000 - 203099: Elidee - elidee.com
*ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
*ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
*ID 205000 - 205999: Kreiz IT
*ID 206000 - 206999: GBINFO (www.gbinfo.fr)
*ID 230000 - 230049: Unareil - La Fortune de la Nature (https://www.unareil.eu)
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 300000 - 300999: AtooNet (http://www.atoo-net.com)
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 Free...
*ID 400000 - 400999: 2byte.es (http://www.2byte.es)
*ID 401000 - 401999: B&D Informática
*ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
*ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 409000 - 409999: LliureTIC (www.lliuretic.cat)
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423050: cyberesprit
*ID 423051 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 424000 - 424499: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
*ID 426000 - 426099: Arkesis-Solution
*ID 426100 - 426149: GetLandy (www.getlandy.com)
*ID 426150 - 426649: OOB Software
*ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
*ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
*ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 429000 - 429999: induslab
*ID 430000 - 430099: Mixity sprl (www.mixity.be)
*ID 430100 - 430199: sgiraud
*ID 430200 - 430299: Merlion TI (www.merlion-si.com.br)
*ID 430300 - 431299: Libre Expert (www.libre-expert.com)
*ID 431300 - 431399: ptibogxiv (www.ptibogxiv.net)
*ID 431400 - 431499: Befox (www.befox.fr)
*ID 431500 - 431599: rue Béjo (www.ruebejo.fr)
*ID 431600 - 431699: Avizzeo (www.avizzeo.com)
*ID 431700 - 432199: Multisistemas (www.multisistemas.com.sv)
*ID 432200 - 432399: Burbuja - Chile (www.burbuja.cl)
*ID 432400 - 433399: INOVEA CONSEIL (https://www.inovea-conseil.com)
*ID 433400 - 434399: Rachid HRICH - Maroc (HricH ServiceS.)
*ID 434400 - 435399: Lance Bleakley - LanceIT (www.lanceit.net)
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 Free (take ranges of 50 only please)
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 Free (take ranges of 50 only please)
*ID 438400 - 439399: Tetras Libre - France - Développement logiciels libres (www.tetras-libre.fr)
*ID 439400 - 440399: Dolibarr-pro - France - Développement Dolibarr (www.dolibarr-pro.com)
*ID 440400 - 441399: Quidlab Co., Ltd - Thailand - ( www.quidlab.com )
*ID 441400 - 442399: Ide@log - France - (https://www.idealog-info.net) - Laurent Leblanc
*ID 442400 - 443399: Valerio Bianchi (www.valeriobianchi.com)
*ID 443400 - 444399: delassalle - France - (www.delassalle.fr) - Joseph Delassalle
*ID 444400 - 445399: Webartis - Maroc - (www.webartis.net) - François Dry
*ID 445400 - 445499: SCOP Au-delà des nuages - France
*ID 446000 - 446999: iouston (http://www.iouston.com) - France - Julien Marchand
*ID 447000 - 447999: rSanjoSEO - Rafael San José Tovar (www.rsanjoseo.com) - Spain
*ID 448000 - 448999: Code 42 (www.code42.fr)
*ID 449000 - 449999: TakePOS (www.takepos.com)
*ID 450000 - 450999: Pierre ARDOIN
*ID 451000 - 451999: Éditeur depordi.fr
*ID 452000 - 452999: Dylan NAKONG
*ID 453000 - 453999: Menahd Ouchenir - France - menahd-ouchenir.com
*ID 454000 - 454999: Withheld - Canada
*ID 455000 - 455999: Gaëtan MAISON - Info Libre @ Dom - France (www.infolibreadom.com)
*ID 456000 - 456999: Laurent LEBLEU - B.L.C. - Blue Line Company - Lille - France (www.bluelinecompany.fr/dolibarr)
*ID 457000 - 457999: Sébastien BOUCHER
*ID 458000 - 458999: Lester HERNÁNDEZ - Argentina - (freelancerlrhd@gmail.com)
*ID 459000 - 459999: Infopen - France
*ID 460000 - 460050: torvista - Spain
*ID 461000 - 461999: MEGALOGI - Maroc (www.erpcloud.ma)
*ID 462000 - 462999: Making Digital (www.making-digital.fr) - France
*ID 463000 - 463999: linx s.r.l.s.
*ID 464000 - 464999: NimbleCubed Inc. (www.nimblecubed.com)
*ID 465000 - 465999: Artefacts - CourantAlternatif
*ID 466000 - 466999: CDM Consultores - (www.cdm.guru)
*ID 467000 - 467999: M71 Service GmbH - (www.m71-service.de)
*ID 468000 - 468049: Clément Segonzac - France (clement.segonzac@gmail.com)
*ID 468050 - 468099: Flavien Belli - France (https://github.com/Marshlyin || belliflaviencontactpro@gmail.com)
*ID 468100 - 468119: Chl (https://code.bugness.org/Dolibarr)
*ID 468120 - 468140 Free (take ranges of 20 only please)
*ID 468150 - 468199 Free (take ranges of 50 only please)
*ID 468200 - 468250: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468251 - 468270: CD-Systems - France (https://www.cd-systems.fr)

...

=ID > 500000=

{{Flag en}}
If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (1000 ids maximum per partner).

{{Flag fr}}
Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (pas plus de 1000 numéros par partenaire).

{{Flag sp}}
Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

Configuration module facture

2018-09-11T08:24:49Z

Unareil: /* Module de numérotation */

[[Category:Facture]]
{{TemplateDocUtil}}

Cette page décrit les options de configuration du [[Module Factures Clients]] (Menu '''Accueil - Configuration - Modules - Factures''')

=Module de numérotation=
Chaque entreprise numérotant ses factures selon ses règles, Dolibarr propose plusieurs modèle de génération de numéro. Un seul modèle à la fois peut être utilisé à ce jour. Le modèle par défaut ne nécessite aucune configuration particulière et conviendra si vous n'avez aucune exigence particulière sur la manière de fabrication ces références.

Il existe aussi un modèle qui vous permet de spécifier la règle de fabrication du numéro par un masque. Placer la souris sur le picto d'aide afin de voir apparaitre la syntaxe pour définir un tel masque.

Note: Si aucun modèle préexistant ne vous convient (y compris le modèle avancé par configuration du masque), vous avez tout loisir de vous adresser à un développeur pour créer un modèle spécifique à votre besoin.

=Modèles de document=
De même que pour la numérotation, vous pouvez utiliser différents modèles de génération de document (PDF ou ODT). Il vous faut activer les modèles que vous voulez pouvoir utiliser (Vous pourrez alors les utiliser sur la fiche facture, dans le tableau "Documents" en sélectionnant le modèle et en cliquant sur "Générer" pour régénérer la facture avec un modèle de document particulier).

Le modèle fournit par défaut est le modèle "crabe", qui est un modèle PDF remplissant les obligations légales de la plupart des pays du monde.

=Mode de paiement suggéré par défaut=
Vous pouvez définir dans cette zone, le ou les modes de paiement avec les coordonnées que vous voulez voir apparaitre sur les documents générés.

=Mentions complémentaires=
Si vous voulez ajouter une mention légale complémentaire en pied de page sur les factures, saisissez cette mention dans la rubirque "Mention complémentaire" puis enregistrez. Chaque nouvelle facture aura alors la mention apparente dans le pied de page des factures.

Remarque: Si vous modifiez cette information, pensez à cliquer sur "Regénérer" la facture sur la fiche facture pour refabriquer le document afin de prendre en compte la modification.

=Autres options=
==Date des factures==
Si cette option est activée la date des factures est définie automatiquement lors de la validation, sans cette option vous êtes libre de définir la date de la facture.

= Notes =
Note: Les règles de calculs de la TVA ne sont pas une option du module Facture. Vous trouverez des informations sur cette page: [[Règles de calcul et arrondi de TVA]]

Module Projets

2018-09-10T12:29:12Z

Unareil: /* Permissions traduction en français du png et de l'odg*/

[[Category:Projet]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Projet|
num=400|
devdoc=[[Module Projets (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Les projets permettent de définir des listes de taches. Ils regroupent aussi des éléments de dolibarr ensemble comme des [[Module Propositions commerciales|propositions commerciales]], des [[Module Commandes Clients|commandes]] ou des [[Module Factures Clients|factures]].

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

= Définitions =
Avant d'aller plus loin sur l'utilisation du module Projet, il est important de se familiariser avec les termes de
Evènements / Taches / Journaux.
Ces notions souvent confondues ont des vocations différentes, aussi il est important de se familiariser avec ces termes admis dans la plupart des ERP. Pour cela, une définition est donnée sur la page [[EvenementTacheJournal]]

= Workflow =

== Permissions ==
Voir le fichier [[File:Project.odg]] qui décrit les conditions pour pouvoir réaliser les différentes actions du module ou sa traduction [[File:ProjetPermissions.odg]].

[[File:ProjetPermissions.png|200px]]

== Créer un projet ==
La création d'un nouveau projet se fait depuis le menu "Nouveau projet" visible dans le menu principal "Projet".

Un projet peut être privé ou public. Les projets publics (et leurs taches) peuvent être lu/éditer par toute personne qui a les permissions Projet. Les projets privés (et leurs taches) peuvent être lus/édités uniquement par les utilisateurs qui ont les permissions Projet et qui en plus sont définis comme contact du projet, ainsi que par le créateur du projet (Si tous les contacts du projet sont retirés, il faut conserver au moins un utilisateur apte à éditer le projet, ne serait-ce que pour ajouter des contacts. C'est le créateur).

== Créer une tache ==
La création d'une tache se fait via le bouton "Créer Tache" depuis l'onglet "Taches" d'un projet
ou bien depuis le menu Projets -> Nouvelle tache.
* On ne peut créer une tache que sur un projet partagé (sans responsable attitré) ou sur un projet dont on est le responsable.
* Une tache peut être crée sous le projet ou sous une autre tâche du projet.

== Supprimer un projet ==
{{ToComplete}}

== Supprimer une tache ==
{{ToComplete}}

== Saisir une activité ==
Les activités sont le temps passé à travailler sur une tâche.

= Exemples de cas d'utilisation =
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCMP01:
|situation=
|actions=
}} 

File:ProjetPermissions.odg

2018-09-10T12:24:08Z

Unareil: Même fichier que celui produit par Eldy mais traduit en français

Même fichier que celui produit par Eldy mais traduit en français

File:ProjetPermissions.png

2018-09-10T12:22:43Z

Unareil: Même support que celui fait par eldy mais traduit en français

Même support que celui fait par eldy mais traduit en français