Dolibarr ERP CRM Wiki - User contributions [en]

List of modules id

2026-05-18T17:38:17Z

Kusco:

{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}
{{TemplateDocDevZh}}

This page list all reserved modules numbers / ID.

If you build or want to build your own modules, you should take an ID range here. Please pick range into existing holes first.

=ID 0 - 94999=
This range is reserved for Dolibarr's internal core modules, so all modules available into the standard distribution at https://github.com/Dolibarr/dolibarr

=ID 95000 - 99999=
This range is reserved for Dolibarr's community modules with sources hosted into the github repository: https://github.com/Dolibarr/dolibarr-community-modules

=ID 100000 - 499999=

Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 20 numbers only the first time, ask us for more)

[[File:Warning.png]] If you reserve more than 20 at once, 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) - Belgium
*ID 101000 - 101999: DoliCloud (https://www.dolicloud.com) - France
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr) - France
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro) - France
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr) - France
*ID 105000 - 105999: GPC.solutions - France
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net) - France
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Aplose ([http://www.aplose.fr https://www.aplose.fr]) - France
*ID 110000 - 110999: Association Dolibarr (https://www.dolibarr.org)
*ID 111000 - 111999: Asset IT (www.assetit.ch) - Suisse
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch) - Suisse
*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) - France
*ID 121000 - 121999: Oscss - Shop - France
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: 7reasons s.r.l. (www.7reasons.eu) - Austria
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br) - Brazil
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu) - Italy
*ID 131000 - 131999: Joan Louis (itaca.fr) - France
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr) - France
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 134000 - 134999: ALSOFT PVT. LTD. (https://www.alsoft.org)
*ID 135000 - 135999: Net-Logic (https://netlogic.fr)
*ID 136000 - 136050: MONA.RE - France
*ID 136051 - 136099: La Vida Marketing
*ID 136100 - 136149: Synergies-Tech France. (https://www.synergies-france.fr/)
*ID 136150 - 136199: Lyta
*ID 136200 - 136219: Maison Théophile Leclerc
*ID 136220 - 136270: SegoFount - Spain
*ID 136271 - 136320: Labor Dispatch (Simon Sheng , China)
*ID 136321 - 136370: MB Informatique (https://www.mb-informatique.fr)
*ID 136371 - 136420: Daxit Solutions (https://www.daxit.be) [https://wiki.dolibarr.org/index.php/DAXIT-SOLUTIONS_List_of_modules_id Liste complète des modules Daxit]
*ID 136421 - 136470: HUSCH GmbH (https://husch-gmbh.de)
*ID 136471 - 138999: NSINFO (https://www.ns-info.fr)
*ID 139000 - 139999: Synergies-Tech France. (https://www.synergies-france.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: Mainlab S.r.l. (https://www.mainlabonline.it) - Italy
*ID 141200 - 141249: Florian DUFOURG - France
*ID 141250 - 141299: SoftAddicts - Canada
*ID 141300 - 141349: Finanboo - (https://www.finanboo.com)
*ID 141350 - 141399: ConstruxZion Soft - Colombia (https://www.construxzionsoft.com.co)
*ID 141400 - 141450: COEXDIS - République Démocratique du Congo (https://www.coexdis.com)
*ID 141451 - 141501: HALFWARE - Algeria (https://www.half-ware.com)
*ID 141502 - 141552: Quantraum (https://quantraum.com)
*ID 141553 - 141603: Nateo Group
*ID 141604 - 141653: digital centric GmbH (https://www.digitalcentric.de/dolibarr)
*ID 141654 - 141699: Decrypting (https://www.decrypting.fr)
*ID 141700 - 141749: Zeise IT Consulting - Germany (https://www.zeise-it.de)
*ID 141750 - 141799: Data Rooster - France (https://datarooster.io)
*ID 141800 - 141849: IP Développement (https://www.ipdeveloppement.fr)
*ID 141850 - 141899: MSICCA | MRVL Soluciones de Ingeniería y Construcción, c.a (https://msicca.com)
*ID 141900 - 141949: THERSANE (https://www.thersane.fr)
*ID 141950 - 141999: MB Informatique (https://www.mb-informatique.fr)
*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 142100 - 142149: Bloxera GmbH (https://www.bloxera.com)
*ID 142150 - 142199: Evangelos Souglakos - Greece
*ID 142200 - 142249: Luc CALARESU - France
*ID 142250 - 142299: OmnIT Services - Belgique (https://www.omnitservices.biz)
*ID 142300 - 142349: Gwadeyes - Guadeloupe (https://www.gwadeyes-informatique.com/)
*ID 142350 - 142399: Solution Libre (https://www.solution-libre.fr/)
*ID 142400 - 142449: Res Digital (https://res.digital)
*ID 142450 - 142499: itopie informatique (https://www.itopie.ch)
*ID 142500 - 142549: Weblinx.IT GbR (https://weblinx.it/) - Germany
*ID 142550 - 142599: ASCI-Automation - Mexico (https://asci-automation.com.mx/)
*ID 142600 - 142649: ZENKO Design - Japan / France / Spain
*ID 142650 - 142699: AWeerWolf
*ID 142700 - 148749: Lysis (https://lysis.net/)
*ID 142750 - 142769: Doliplug (https://www.doliplug.com)
*ID 142770 - 142799: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 142800 - 142849: Bloxera GmbH (https://www.bloxera.com)
*ID 142850 - 148999: Everlats S.L. - España (https://www.everlats.com)
*ID 149000 - 149999: SydTech - America Central (https://www.sydtech.io/)
*ID 150000 - 150999: Jeffinfo
*ID 151000 - 151999: Konverseo (https://konverseo.com)
*ID 152000 - 152049: Tanguy Pénet (http://tanguype.net)
*ID 152050 - 152099: Web Solutions
*ID 152100 - 152149: MagicNet (https://www.magicnet.it)
*ID 152150 - 152199: Benjamin Falière (https://www.faliere.com)
*ID 152200 - 152249: Solauv
*ID 152250 - 156499: TecnoGestión Principado S.L. (https://www.tecnogestion.com) - Asturias - España
*ID 156500 - 156549: ACE Recycling (https://www.acerecycling.net.au/)
*ID 156550 - 156599: Kreativität Works ([http://www.kreativitat.com http://kreativitat.com])
*ID 156600 - 156649: [https://pierre-couy.dev Pierre Couy]
*ID 156650 - 156699: CXI (https://cyrix.co.za)
*ID 156700 - 156749: Mustafa Kemerci - Turkiye
*ID 156750 - 156799: [https://de-grandpre.quebec de Grandpré Technologies] - Québec (Canada)
*ID 156800 - 156849: Draceo
*ID 156850 - 156899: Valleiweb
*ID 156900 - 159949: NEOVIAQ Advisory LU(https://www.neoviaq.com)
*ID 159950 - 159999: Arve et Giffre INFOGESTION (https://www.ag-infogestion.fr)
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (https://01consulting.eu)
*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 165151 - 165199: NUM'X (https://www.numx-sets.eu)
*ID 165200 - 165249: Benjam Préjent (https://www.benjam-prejent.fr)
*ID 165250 - 165299: Dhi Loka Private Limited, India (https://www.dhiloka.com)
*ID 165300 - 169999: Accellier Limited (https://www.accellier.com/)
*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: NSINFO (https://www.ns-info.fr)
*ID 172800 - 172849: E-Concept Applications (https://e-concept-applications.fr)
*ID 172850 - 172899: B&R Stamm UG (https://stamm-ug.de)
*ID 172900 - 172949: Dolipive, support@dolipive.fr, www.dolipive.fr
*ID 172950 - 172999: CKD-Industrie (https://ckd-industrie.com/) - France
*ID 173000 - 173049: Aneosys (https://aneosys.fr) - France
*ID 173050 - 173099: Sebastian Schloßer - Germany
*ID 173100 - 173149: TecnoSoluciones (https://tecnosoluciones.com)
*ID 173150 - 173199: Digitalworks (https://www.digitalworks.fr) - France
*ID 173200 - 173249: UNi.D Consulting (https://www.unid-consulting.fr) - France
*ID 173250 - 173299: NetworkDigital(https://www.networkdigital.fr) - France
*ID 173300 - 173300: Módulo VeriFactu Dolibarr (https://verifactudolibarr.es/) - España
*ID 173301 - 173320: Sibanet (https://sibanet.net) - España
*ID 173321 - 173340: disQutons (https://wiki.dolibarr.org/index.php/Category:DisQutons) - France
*ID 173341 - 173360: Surática Software (https://suratica.es) - Spain
*ID 173361 - 173380: UpInvoice (https://upinvoice.eu) - Spain
*ID 173381 - 179999: Toutatis (https://toutatis.eu)
*ID 180000 - 180999: BM eXpert Labs
*ID 181000 - 181999: TI Sin Problemas (https://www.tisinproblemas.com)
*ID 182000 - 182049: Chipserv Pawel Wlizlo (https://www.testware.it)
*ID 182050 - 182070: Herolapse (https://herolapse.com/)
*ID 182061 - 182999: TMC
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 184000 - 184999: DPS PRINTING & DOCUMENTS SOCIEDAD ANONIMA (https://www.dps-lat.com)
*ID 185000 - 185049: Telioskour (https://github.com/telioskour)
*ID 185050 - 185099: Moko Consulting ([[Moko Consulting]] || https://mokoconsulting.tech)
*ID 185100 - 185149: Sinabe (https://sinabe.ch) - Suisse
*ID 185150 - 185169: Anatole Conseil (https://anatoleconseil.com/)
*ID 185170 - 185189: cferoiu
*ID 185190 - 185209: Guillemonde (https://guillemonde.family)
*ID 185210 - 185229: ITized - Finta Ionut (https://itized.com)
*ID 185230 - 185249: svewa (https://github.com/svewa/)
*ID 185250 - 185269: Clément Jaunay (https://clement-jny.fr/ || contact@clement-jny.fr)
*ID 185270 - 185289: AMB Technologies (https://www.ambts.fr)
*ID 185290 - 185299: VIOLET IT UG (https://violet-it.de)
*ID 185300 - 185319: lorem.site '''('''https://lorem.site/''')'''
*ID 185320 - 185340: Rentageek (https://rentageek.hu) Hungary
*ID 185341 - 185360: Hamzavi Infotech (<nowiki>https://www.hamzaviinfotech.com</nowiki>)
*ID 185361 - 185380: La souris de Gutenberg (<nowiki>https://www.lasourisdegutenberg.fr</nowiki>)
*ID 185381 - 185400: LodinPay (https://www.lodinpay.io)
*ID 185401 - 185420: Avertissance (https://avertissance.fr). France
*ID 185421 - 185849: TH Investissements / Matelas No Stress - France (internal ERP / production / logistics modules)
*ID 185850 - 185899: B&R Stamm UG (<nowiki>https://stamm-ug.de</nowiki>)
*ID 185900 - 185919: OpenLine Solutions - Olaf John (https://openlinesolutions.de) - Germany
*ID 185920 - 189999: Abadia Tecnologica - (https://abadiatecnologica.com) - Spain
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 192000 - 192049: IDFOR Consulting (https://www.idfor-consulting.fr/)
*ID 192050 - 192069: Stogger (<nowiki>https://stogger.com</nowiki>)
*ID 192070 - 192090: Protectora
*ID 192091 - 192110: CoopCircuits - OpenFoodNetwork (https://coopcircuits.fr/)
*ID 192111 - 192130: Saidigit - Belgique
*ID 192131 - 192150: Lia Concept (https://lia-concept.fr)
*ID 192151 - 192999: GHM LABS (https://ghm-labs.ma/)
*ID 193000 - 193020: Forlead (https://forlead.fr/)
*ID 193021 - 193041: Doliway (https://doliway.fr)
*ID 193042 - 193062: ERPkit ( https://erpkit.app )
*ID 193063 - 193083: Eric FALCON
*ID 193084 - 193103: Ienx2
*ID 193104 - 193123: OpenLine Solutions - Olaf John (https://openlinesolutions.de) - Germany
*ID 193124 - 193899 '''Free (take ranges of 20 only please at once, ask us for more)'''
*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: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 207400 - 207449: Arthur LENOBLE
*ID 207450 - 207499: Vaicop SAS de CV (México)
*ID 207500 - 207520: Frankie Wong - UK
*ID 207521 - 207540: Fyssec ([https://fyssec.fr/ fyssec.fr/])
*ID 207541 - 207560: My easy Office SAS ([https://www.myeasyoffice.fr www.myeasyoffice.fr])
*ID 207561 - 207580: All-Lock Védelem Kft.
*ID 207581 - 209199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 210000 - 210100: Lemon (https://hellolemon.fr)
*ID 210101 - 212099: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 212100 - 212149: Audio Vidéo Technologies (https://www.avtek.fr)
*ID 212150 - 212169: AI MYA GROUP ([https://Www.AI-MYA-GROUP.com www.AI-MYA-GROUP.com])
*ID 212170 - 213999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 214000 - 214049: X-Boss
*ID 214050 - 221999: PixelJM
*ID 220000 - 220050: Apex Tech (https://apextechmods.com)
*ID 220051 - 220100: Technology Xchange Solutions (https://www.txscorp.com)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 223000 - 223049: Tráfico Canada
*ID 223050 - 223099: VLTN (https://vltn.sh)
*ID 223100 - 229949: Dazax.io (https://www.dazax.io)
*ID 229950 - 229999: Solucions Informàtiques, Serveis i Innovació SLU (https://6innova.es)
*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 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230499: Chickenforce/code-chicken, IT Services Hahn (https://github.com/code-chicken [http://itservices-hahn.de/ https://itservices-hahn.de])
*ID 230500 - 230549: Hidup Consulting (https://consulting.hidup.io)
*ID 230550 - 230599: CMR Conseil (https://www.weblockup.fr)
*ID 230600 - 230649: aFreeMind Studio
*ID 230650 - 230699: Unideal (https://www.uni-deal.com)
*ID 230700 - 230749: DevLansdes (https://devlandes.com/)
*ID 230750 - 230769 Kristof56 / Serpette & Cie /
*ID 230770 - 262699: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 231200 - 231219: Mugisha || Modules ERP personnalisés (facturation, RH, intégration)
*ID 250000 - 250019: Barnecki Spirits (https://github.com/Barnecki)
*ID 262700 - 262799: Scopen (https://www.scopen.fr)
*ID 262800 - 262849: Christophe BATTAREL EI
*ID 262850 - 262870: Nicolaus Hofer - Autriche
*ID 262871 - 271799: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 271800 - 271849: bee solutions sàrl (Switzerland)
*ID 271850 - 272999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 273000 - 273019: Taler (https://taler.net)
*ID 273020 - 274199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 274200 - 274249: Mathilde MAROCCO (https://mminformatique.fr)
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350 - 274399: Milen karaganski (https://blacktiehost.com)
*ID 274400 - 274449: Vincent MAURY ([https://www.timgroup.fr www.timgroup.fr])
*ID 274450 - 274499: Daraelmin
*ID 274500 - 274549: Emilie LAFORET (http://www.ermvallon.com)
*ID 274550 - 278999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 279000 - 279049: VSDigital Electronics (https://vsdigital.ar) - Argentina
*ID 279050 - 279999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 280000 - 280049: Bingroup (https://www.beinng.com)
*ID 280050 - 280099: Medialta (https://medialta.com)
*ID 280100 - 280149: Cédric Ancelin - Ancode (https://www.dolistore.com/fr/recherche?search_query=ancode)
*ID 280150 - 280169: Rafael CF (https://virtualmachine.digital) - México
*ID 280170 - 289999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 290000 - 290099: BNS - Project doliBRA ([https://www.beinng.com https://www.bns.net.br]) - Brasil
*ID 290100 - 299999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 300000 - 300049: RapidProgress (https://www.rapidprogress.eu) - Bulgaria
*ID 300050 - 300099: M@ Solution (https://www.ma-solution.fr/)
*ID 300100 - 300149: LAVA RUN (https://www.lavarun.re)
*ID 300150 - 300199: PsyCrow Code
*ID 300200 - 300249: Computences (https://www.computences.com/)
*ID 300250 - 300299: LEVEL IT (https://levelit.com.ar)
*ID 300300 - 300349: Progiseize (https://progiseize.fr)
*ID 300350 - 300399: MB Informatique (https://www.mb-informatique.fr)
*ID 300400 - 300449: Anouar Touati
*ID 300450 - 300499: Martin Danger
*ID 300500 - 301499: Whale Blows
*ID 301500 - 301549: Tom Trust - International
*ID 301550 - 301599: MB Informatique (https://www.mb-informatique.fr)
*ID 301600 - 302479: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 302480 - 302499: akyras (https://akyras.fr)
*ID 302500 - 302549: Diamubi (https://diamubi.com)
*ID 302550 - 302599: Datolab (https://www.datolab.com)
*ID 302600 - 302649: DuMaCo (https://www.dumaco.de)
*ID 302650 - 302699: Resilio SA
*ID 302700 - 302749: Aroga
*ID 302750 - 302799: Productivix (https://www.productivix.com)
*ID 302800 - 302849: Slibzz
*ID 302850 - 302899: idea design (https://ideadesign.dz)
*ID 302900 - 302949: AL MISBAH INFORMATIQUE (https://www.almisbah.ma)
*ID 302950 - 302999: Atis Solutions - France
*ID 303000 - 303499: Obixav - Nigeria
*ID 303500 - 303549: buschler plus GmbH, Germany (https://buschler.plus)
*ID 303550 - 303599: Prestalidaire - France (https://prestalidaire.com)
*ID 303600 - 303619: Apertice - France (https://apertice.fr)
*ID 303620 - 309999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 310000 - 310049: Neilson Dufour (<nowiki>https://hypercode.ca</nowiki>)
*ID 310050 - 313999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 314000 - 314049: Ruemmler IT Solutions (https://www.ruemmler.net)
*ID 314050 - 314149: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 314150 - 314199: Benoît PASCAL
*ID 314200 - 319999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 322000 - 322049: Doymer Consultores
*ID 322050 - 329999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 331999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 - 332149: Agence Milkshake (http://agencemilkshake.com)
*ID 332150 - 332199: Daniel Prowald IT – Service (https://prowald-it.de)
*ID 332200 - 332249: UNITICE (https://unitice.com)
*ID 332250 - 332299: Sidonie Moulart
*ID 332300 - 332349: LTDJ (Antonin MARCHAL - Le Temple du Jeu)
*ID 332350 - 333299: '''Free (take ranges of 20 only please at once, ask us for more)'''

*ID 333300 - 333349: Sense Africa (http://sense.africa)

*ID 333350 - 333369: Orion module
*ID 333370 - 339999: '''Free (take ranges of 20 only please at once, ask us for more)'''

*ID 340000 - 340049: M34D (https://m34d.com)
*ID 340050 - 340069: WiwIT
*ID 340070 - 349999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 350000 - 350049: SOUNDOU & MIDAS (https://www.soundou.org/)
*ID 350050 - 350099: Ildefonso González (https://igontek.es)
*ID 350100 - 350149: 7Kas Servicios de Internet, S.L. (https://7kas.com)
*ID 350150 - 350169: Silias (https://silias.ch)
*ID 350170 - 350999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 351000 - 351049: P'tite Tête (https://ptitetete.com) - France
*ID 351050 - 398999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 359000 - 359049: Milen Karaganski0
*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
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 406000 - 406999: Som Núvol (https://somnuvol.coop)
*ID 407000 - 407019: I-Motion SARL
*ID 407020 - 408999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 409000 - 409999: LliureTIC (https://www.lliuretic.cat)
*ID 410000 - 410999: DoliGov
*ID 411000 - 411049: GATTEK SARL (https://www.ga-ttek.com)
*ID 411050 - 419999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 421200 - 422199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423049: cyberesprit
*ID 423050 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 423200 - 423299: Pragma-tech (www.pragma-tech.fr)
*ID 423299 - 423999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 424000 - 424049: Philazerty ([https://www.philazerty.fr www.philazerty.fr])
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 - 424999: Lab51 (https://github.com/lab51org)
*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 - 426999: Bruno Caldas (https://github.com/BCaldas)
*ID 427000 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 428100 - 428199: Arnaud Serrut - Adalon
*ID 428200 - 428249: imschweiler consulting (http://www.imschweiler-consulting.de'''<nowiki/>''')
*ID 428250 - 428299: AL1FO
*ID 428300 - 428349: Federico García-Patiño Barbolani (<federico.garcia.patino@gmail.com>)
*ID 428350 - 428399: INTM Groupe - France (www.intm.com)
*ID 428400 - 428449: Nick Fragoulis - Greece
*ID 428450 - 428499: Kontava - France ([https://kontava.fr kontava.fr)]
*ID 428500 - 428549: hkwhitten - USA
*ID 428550 - 428999: SmartOne
*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 435400 - 435419: Victorien LOS - France
*ID 435420 - 435439: Clément ESTREM - France
*ID 435440 - 435999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 - 436300: TDE-INFORMATIQUE (www.tde-informatique.fr)
*ID 436301 - 436349: Evarisk ([https://www.evarisk.com/id-module-dolibarr/ www.evarisk.com])
*ID 436350 - 436399: Eoxia ([https://www.eoxia.com/dolibarr/modules/ www.eoxia.com])
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 - 437449: Martin Neubauer - Germany
*ID 437450 - 437599: Club1click (www.club1click.es)
*ID 437600 - 437629: Coulon Vincent (https://github.com/HoverEpic)
*ID 437630 - 437649: Aytechnet (https://www.aytechnet.fr/) - François Pons
*ID 437650 - 437699: LibreMaster (https://libremaster.com) - Christophe T.
*ID 437700 - 437749: STELLAR Broadband (https://www.stellarbb.com) - U.S.A. - Philip Laycock
*ID 437750 - 437799: DIGITA.LU Ajous Solutions
*ID 437800 - 437850: iProspective (https://iprospective.fr) - Mathieu Moulin
*ID 437851 - 437900: Theobald Groupe.
*ID 437901 - 437950: Neuronnexion (http://neuronnexion.coop)
*ID 437951 - 437952: jmbc - APIA-ASSO (https://www.apia-asso.fr)
*ID 437953 - 438002: IPCZEN SARL (https://www.ipczeninformatique.fr/)
*ID 438003 - 438052: FESF IT Department (https://fesf.org.pk)
*ID 438053 - 438103: Pilot Engineering team
*ID 438104 - 438153: u2042 (https://u2042.com)
*ID 438154 - 438204: Djair E Pereira (ocultooooo@gmail.com) - Brasil
*ID 438205 - 438255: yoandm (https://yoandm.com)
*ID 438256 - 438299: PTMSoft (<nowiki>https://www.ptmsoft.fr</nowiki>)
*ID 438300 - 438399: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 445500 - 445549: X Net Systems - Egypt - (https://www.xneteg.com)
*ID 445550 - 445569: Schiefer.IT - Austria ([https://schiefer.it schiefer.it])
*ID 445570 - 445999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 - 460049: torvista - Spain
*ID 460050 - 460099: ADVAISION.com (Belgique www.advaision.com)
*ID 460100 - 460999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 (www.artefacts.coop) - Pascal Daugeron
*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 - 468169: Commotron GmbH (https://www.commotron.com/)
*ID 468170 - 468219: Infans Group (franck.lauby@infans.fr)
*ID 468175 - 468199: Gaëlle Rauffet - France (kiwiscan.net)
*ID 468200 - 468249: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468250 - 468269: CD-Systems - France (https://www.cd-systems.fr)
*ID 468270 - 468299: Nicolas Testori
*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 468650 - 468699: J-IT - Belgique (https://www.j-it.be)
*ID 468700 - 468749: Fidesio - France (https://www.fidesio.com/)
*ID 468750 - 468799: Sgestion - Spain (http://www.sgestion.net/)
*ID 468800 - 468849: Denis JULIEN - Brasil (matrinxa@free.fr)
*ID 468850 - 468899: Mmariko - Module GED - Effios
*ID 468900 - 468949: Maazou Amadou Abdoul aziz - Maroc (yaronfada@gmail.com)
*ID 468950 - 468999: Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 469000 - 469049: John Livingston (https://github.com/JohnXLivingston/)
*ID 469050 - 469099: Macrorom ICT-services (https://macrorom.nl/)
*ID 469100 - 469149: HABOT IT - France (https://habot.it)
*ID 469150 - 469159: CaribbeanConsult.Com CCC - France Guadeloupe (https://dolibarr.ccc.gp)
*ID 469160 - 469171: GMBG - Portugal
*ID 469172 - 469199: BGi Lda - Portugal
*ID 469200 - 469219: elsotec GmbH
*ID 469220 - 469949: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 469950 - 469999: Goldoweb (http://goldoweb.com)
*ID 470000 - 470999: Reindeer Digital (https://rdeer.cz)
*ID 471000 - 471099: CAP-REL (www.cap-rel.fr)
*ID 471100 - 471199: M. Morillon
*ID 471200 - 471209: Pablo Nuñez
*ID 471210 - 471249: FANEL A.Ş (https://www.fanel.com.tr)
*ID 471250 - 480999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 481000 - 481999: Alhaidab-ITIS (https://alhaidab.dolibarr.sd)
*ID 482000 - 482999: Basix IT (https://www.basix.de)
*ID 483000 - 483049: SASCO SpA (https://www.sasco.cl)
*ID 483050 - 483099: WIP Engineering (https://www.wip-gmbh.com)
*ID 483100 - 483149: J.Kaiser
*ID 483150 - 483199: CodLines (https://www.codlines.com)
*ID 483200 - 483249: BleepalSoftware (https://bleepal.com)
*ID 485000 - 485049: Gest Info Service Plus (contact@gest-plus.fr)
*ID 485050 - 485069: DJOB' Services
*ID 485070 - 489999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 490000 - 490049: VOLD (https://www.voldgroup.com)
*ID 490050 - 490249: QUANTIVO (http://quantivo.eu/)
*ID 490250 - 490299: VOLD (https://www.voldgroup.com)
*ID 490300 - 490999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 491000 - 491049: NORD ERP CRM (https://www.nord-erp-crm.fr/)
*ID 491050 - 491099: KJR-online (https://kjr-online.fr/)
*ID 491100 - 491149: eNova
*ID 491150 - 491199: App 4 Business
*ID 491200 - 491249: Mil24 (http://www.mil24.com.py)
*ID 491250 - 491299: M2AM
*ID 491300 - 491349: luigifab (https://github.com/luigifab), also reuse id:105009 for Sentry fork
*ID 491350 - 491399: Frédéric France (https://github.com/frederic34)
*ID 491400 - 491449: E-dem (https://www.e-dem.com/)
*ID 491450 - 491499: Burofree (https://burofreeai.es)
*ID 491500 - 491549: EMDELEN (https://emdelen.fr/)
*ID 491550 - 491599: eSoUrCeS Technologie (https://techno.esources.ca/) - Canada
*ID 491600 - 491649: GoSouce Peru - Peru
*ID 491650 - 491669: Kaféin Studio (https://kafein.studio) - France
*ID 491670 - 491699: Neykinfo - France
*ID 491700 - 491999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 492000 - 492020: Anura (https://www.anura.fr/)
*ID 492021 - 492999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 493000 - 493020: Bourez Bastien EI (https://bastien-b.fr/)
*ID 493051 - 493071: benhmida ilyess (bhilyess98@gmail.com)
*ID 493101 - 493120: George TS, George SP (gspanos@makeasite.gr)
*ID 493200 - 493219: Stéphane Mallet (https://framagit.org/Steph501/dolibarr-mod-autoreminder)
*ID 493220 - 493239: TBNETSYS (www.tbnetsys.fr)
*ID 499001 - 499020: IT GENIUSES (https://www.itgeniuses.com)
*ID 499051 - 499071: KREATIV PROJECT MANAGEMENT

DO NOT ADD RECORD HERE, PLEASE FILL HOLES FIRST !!!!
...

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

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 (20 ids at once).

Module Coffre-fort

2026-04-23T12:53:29Z

Kusco: /* Informations */

[[fr:Module_Subventions FR]]


[[Category:Complementary modules]]
[[Category:disQutons]]
[[Category:Nonprofit organization]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
=Informations=
{{TemplateModuleInfo
|modulename=Coffre-fort : Gestionnaire de mot de passe
|editor=[https://www.disqutons.fr disQutons]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=coffre-fort-gestionnaire-de-mot-de-passe}}
|status=stable
|minversion=V22
|note=Module disponible en français, anglais, allemand, italien et espagnol.
}}

=Fonctionnalités=
Module permettant de stocker les identifiants et mots de passe :

* Création de clé (utilisateur, mot de passe, url)
* Mots de passe cryptés en base de données
* Vérification des accès par utilisateur

=Installation=
{{InstallModuleDoliStoreEn|keyword=subvention}}

=Paramétrage=
{{ActivationModuleEn}}

=Développement & Contributions=
Le développement de cette application Open Source n'est pas inclus dans le dépôt GIT standard de Dolibarr, mais dans un dépôt dédié aux modules non pris en charge par l'équipe de développement de Dolibarr :

*Dépôt : https://github.com/disQutons/dolibarr_module_keyvault/

Vos demandes de correction ou d'amélioration sont les bienvenues.

Module Coffre-fort

2026-04-23T12:46:59Z

Kusco: Création de la page liée au module

[[fr:Module_Subventions FR]]


[[Category:Complementary modules]]
[[Category:disQutons]]
[[Category:Nonprofit organization]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
=Informations=
{{TemplateModuleInfo
|modulename=Suivi des subventions
|editor=[https://www.disqutons.fr disQutons]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=subventions}}
|status=stable
|minversion=V21
|note=Module disponible en français, anglais, allemand, italien et espagnol.
}}

=Fonctionnalités=
Module permettant de stocker les identifiants et mots de passe :

* Création de clé (utilisateur, mot de passe, url)
* Mots de passe cryptés en base de données
* Vérification des accès par utilisateur

=Installation=
{{InstallModuleDoliStoreEn|keyword=subvention}}

=Paramétrage=
{{ActivationModuleEn}}

=Développement & Contributions=
Le développement de cette application Open Source n'est pas inclus dans le dépôt GIT standard de Dolibarr, mais dans un dépôt dédié aux modules non pris en charge par l'équipe de développement de Dolibarr :

*Dépôt : https://github.com/disQutons/dolibarr_module_keyvault/

Vos demandes de correction ou d'amélioration sont les bienvenues.

翻译文档

2026-04-17T08:49:24Z

Kusco: /* 使用Web界面（适用于翻译人员） */

[[en:Translator_documentation]]
[[fr:Documentation_traducteur]]
[[es:Documentación_traductores]]
[[de:Dokumentation_Uebersetzung]]

{{#metamaster:keywords|translation, documentation, translator, localize, localization, i18n, internationalization, language}}
{{Template用户手册}}
{{TemplateMainPageZh}}

=[[File:Language.png]] 翻译 Dolibarr 应用程序=

Dolibarr的语言文件已经被翻译成多种语言。
英语是其默认的语言，并且其内容会始终保持完整。其他语言的文档是否完整依赖于自愿者的贡献。本教程帮助您针对未被翻译或者翻译错误的文档完成语言翻译工作。
Dolibarr可以用三种不同的方式翻译：

#手动使用Transifex （官方和推荐的方法）
#手动编辑语言文件
#全自动：自动翻译机

==使用Transifex在线服务进行手动翻译（推荐）==

Transifex 是一个为翻译项目提供在线平台的Web应用程序。它包括团队和讨论工具、翻译记忆库、词汇表、校对和许多其他功能。
它非常容易使用，所有翻译都可以通过Web界面或者使用TX客户端终端上传或下载。
Transifex 是一个开源项目，“社区版”可以免费下载和安装，但我们将使用在线托管服务。

===使用Web界面（适用于翻译人员）===
如果你想帮忙把Dolibarr翻译成自己的语言，请进入该项目的页面 https://app.transifex.com/dolibarr-association/dolibarr/dashboard/

然后，您可以注册一个帐户，并请求加入目标语言的项目团队。管理员会接受您的请求，所以请耐心等待。

一旦被接受，您就可以马上开始翻译了。

欲了解更多信息，请查阅网站 http://docs.transifex.com/introduction/translators/ 上的Transifex Getting Started（入门）介绍规范和网站 http://docs.transifex.com/tutorials/txeditor/ 上的web editor tutorial（编辑器向导）。

===='''关于 en_US 的备注'''====
这个Web界面不能用来翻译源代码的en_US语言。

对en_US语言的任何更改都必须在Dolibarr源代码中完成，并在我们的GitHub存储库上使用Pull Request提交。

===使用TX 命令行客户端 (适用于管理员团队 [[:Category:Yoda]] )===
这部分描述了如何从命令行中使用Transifex。然而，这是保留给Dolibarr管理员用户（Yoda团队）的，用于将Transifex与Dolibarr主源码同步。

更多信息请参考Transifex [http://docs.transifex.com/developer/client/ 官方文档]

====TX 客户端设置====
首先要安装 TX 客户端，操作系统使用 Debian/Ubuntu/Mint:
<source lang="bash">
apt-get install python-pip
pip install transifex-client
</source>
然后你必须初始化你的TX环境。这是通过进入Dolibarr项目根目录运行 tx init ''来完成的。''
<source lang="bash">
cd git/dolibarr
tx init
</source>
接受覆盖配置文件。保留Transifex实例的默认值，然后输入您的Transifex登录名和密码。

在此之后，一个.transifexrc文件已经创建到您的HOME目录，并且一个通用配置文件被创建为项目根目录中的'''.tx/config'''。
目录的内容看起来会是这样的：
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

当前的配置文件可以从 https://github.com/Dolibarr/dolibarr/tree/develop/.tx 下载，将其放入.tx目录，覆盖由 tx init ''创建的配置文件。''

此项目配置文件用于存储项目的详细信息和文件到资源的映射。

这是配置文件包含的内容的示例：

<source lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</source>

下面是配置文件中使用的片段和选项的说明：

<nowiki>[main] section</nowiki>

在本片段中，我们有项目范围的选项，例如：所有项目的默认transifex主机。如果需要的话，这些可以被每个资源覆盖。

<nowiki>[dolibarr.resource]</nowiki>

source_lang: 这是资源的源语言 
source_file: 这直接指向源文件 
file_filter: 在这里，我们保存用于标识特定项目下的翻译文件的表达式。''非强制性'' 
trans.<lang>: 这用于不遵循公共命名模式的翻译文件，并且文件表达式不能用于跟踪它们。''非强制性'' 
host: 如果项目不使用[main]片段中指定的默认Transifex服务器，它可以使用此选项覆盖它。''非强制性'' 

====TX 客户端使用====
一些有用的 '''tx''' 命令。

'''tx status'''

显示翻译状态

'''tx push'''

用于将更改从你的计算机推送到Transifex服务器。

tx push命令的其他选项包括：

<code><pre>
-h - 显示命令行帮助
-l <lang> - 指定要推送哪些翻译（默认为所有）
-r <resource> - 指定要向其推送翻译的资源（默认为所有）
-f - 在不修改修改时间的情况下推送源文件
--skip - 错误时不要停止。当同时推多个文件时很有用。
-s - 将源文件推送到服务器
-t - 将翻译文件推送到服务器
--no-interactive - 强制推送时不需要用户输入。</pre></code>

'''tx pull'''

用于将更改从Transifex服务器拉到您的计算机上。 tx pull命令的其他选项包括：
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''示例：'''

要拉取翻译文档，可以使用:

<source lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</source>

要推送源文件，只需键入:

<source lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</source>

===关于transifex流程的其他问题===
这是一个简短的Q&A，你也可以询问transifex翻译进程：

1) 同步是否按固定的时间间隔完成?

不，只有在提交了足够的译文时才进行翻译。在创建最终发布包之前，它也会在beta分支上完成。

2) 是否所有的翻译都同步到git，还是仅仅同步经过审核的翻译。在同步完成之前我需要进行检查吗?

当同步完成时，transifex文件将覆盖git中的文件，但前提是该文件至少有一条记录被修改。
在同步完成之前，您不必进行复查。最重要的是，要知道哪些行是手动审核的，哪些行是最初使用机器人翻译的。同步始终采用最后翻译的版本，即使新的翻译没有被审核。

3) 在哪些Dolibarr版本中提供翻译？Transifex翻译是否也同步到维护版本？

同步总是在develop和/或beta版本上完成。
因此，transifex更改会出现在其分支在Transifex更改之后创建的所有版本中（在创建新分支之前总是进行同步）。

一旦创建了一个分支，对Transifex的新更改将仅适用于下一个分支。这样做的原因是我们不管理Transifex上的分支/版本（目前还没有）。
==手动翻译（不推荐）==

要将Dolibarr翻译成另一种语言，请转到Langs目录，并创建一个用要翻译的语言代码命名的文件夹/目录（遵循现有格式，例如en_US, en_GB, es_ES, de_DE, 等）。然后将文件从现有的语言目录（例如en_US/main.lang, en_GB/bills.lang）复制到您刚刚创建的新语言目录中。

这些文件在每行中具有键/值对的格式，如下所示：

<source lang="ini">
Code1 = translate phrase 1
Code2 = translate phrase 2
...
Coden = translate phrase n
</source>

如上所述，翻译“=”右侧的短语（键/值对的值部分），“=”左侧的代码（键部分）应保持不变。

可以逐个翻译这些文件，而不必一次就把它们全部翻译出来。

如果文件尚未被翻译成新的语言，Dolibarr将使用英语。

要将本地化（翻译）的字符串放入PHP代码中，您所要做的就是加载语言文件并使用下述方法来获取翻译后的值，如下所示：

<source lang="php">

$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX

print $langs->trans("CodeX")
</source>

条目类型：

<source lang="ini">
CodeX = phrase X
</source>

必须存在或添加到myfile.lang文件中。

==使用autotranslator.php工具自动翻译==

*Translator OS: All
*Tool: '''autotranslator.php''' 随 Dolibarr 提供，位于目录 '''dev/translation''' 下

当刚开始翻译为尚未初始化的语言时，建议使用此方法。如果已经有一个可用的翻译，但您需要添加一个丢失的键或纠正错误，请尝试使用Transifex方法（见下文）。

要创建或更新语言代码的所有文件，只需运行脚本：
<source lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</source>
例如：
<source lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</source>
使用英语（en_US）文件翻译成葡萄牙语（pt_PT）。

此操作将创建所有不存在的文件，并更新所有现有文件。该工具使用Google翻译服务来查找字符串的翻译值，因此需要从运行脚本的站点进行工作的Internet连接。此外，还需要GOOGLEAPIKEY，Google会收取使用此服务的费用（20欧元/1000000翻译字符）。你的PHP还必须有写入'''htdocs/langs'''目录的权限，并且必须有可用的curl函数。

此操作将创建所有不存在的文件，并更新所有现有文件。该工具使用 [http://translate.google.com Google translation] 翻译服务来查找字符串的翻译值，因此运行脚本的工作站点需要有Internet连接。此外，还需要GOOGLEAPIKEY，Google会收取使用此服务的费用（20欧元/1 000 000翻译字符）。你的PHP还必须有写入'''htdocs/langs'''目录的权限，并且必须有可用的curl函数。

=[[File:Language.png]] 将你的翻译分发或纳入到核心源代码中=

一旦你开始翻译，分享它将是一个明智的决定，因为它可以被包含在Dolibarr的官方代码中。如果您保留它，当添加新术语或修改以前的术语时，其他人将无法改进它，并且您仍然必须自己管理翻译。

如果你是通过Transifex系统翻译的，那就没什么可做的了。您的翻译将被包含在Dolibarr的下一个版本中。没有额外的工作！从技术上讲，翻译将从Transifex导出，并由我们的开发人员导入Dolibarr，每月至少一次。

但是，如果您直接在Dolibarr文件中进行翻译，则必须首先将这些翻译传输到Transifex，然后才能将其包含在内。所以，真的，你应该一开始就翻译成Transifex。如果你通过Github上的Pull Request向我们发送你的翻译，很遗憾，它会被Transifex的下一次导入所覆盖，所以它的生命周期将是非常短暂的。

注意事项：

参考语言是en_US，并且其内容始终是完整的。您可以在htdocs/langs/en_US/文件夹中找到它。所有其他语言文件都可能是轻微或高度不完整的，具体取决于语言。

如果你正在开发一个新的模块，你可能需要添加新的语言变量。这完全通过更新en_US语言（htdocs/langs/en_US/文件夹）完成。只需修改这些文件以添加所需的变量，并将生成的文件夹作为Pull Request的一部分发送。请参阅开发人员文档以了解如何贡献代码（您需要在 https://github.com/Dolibarr/dolibarr 上创建一个帐户）。

=[[File:Language.png]] 翻译Wiki上的文档=
wiki是用3种语言写成的：英语、法语和西班牙语。

如果你想增强这些语言中的一种语言的文档，你所要做的就是在wiki上创建一个帐户。

然后，您可以编辑现有的页面来纠正错误的翻译或翻译等待翻译的页面 [[:Category:Page_waiting_for_translation]]。

 

====如何翻译现有页面？====

=====为翻译版本创建一个新页面。=====
首先为翻译后的版本创建一个新页面。为此，您可以访问一个不存在的URL：例如 <code><nowiki>https://wiki.dolibarr.org/index.php/Ma_nouvelle_page_en_français</nowiki></code>

选择的翻译版本的页面标题应该是原始英语页面标题的翻译。

Dokumentation Uebersetzung

2026-04-17T08:49:06Z

Kusco: /* Verwendung der Weboberfläche (für Übersetzer) */

[[en:Translator_documentation]]
[[fr:Documentation_traducteur]]
[[es:Documentación_traductores]]
[[zh:翻译文档]]

{{#metamaster:keywords|translation, documentation, translator, localize, localization, i18n, internationalization, language}}

=[[File:Language.png]] Übersetzen Sie die Dolibarr-Anwendung in Ihre Sprache.=

Die Dolibarr-Sprachdateien sind bereits in viele Sprachen (teilweise) übersetzt. Englisch [en_US] ist die Standardeinstellung und immer vollständig.

Andere Sprachen sind von Beiträgen Freiwilliger abhängig. Dieses Tutorial kann Ihnen helfen, eine Übersetzung für eine Sprache zu erstellen, die noch nicht verfügbar oder unvollständig ist oder in der es Übersetzungsfehler gibt.

Dolibarr kann mit drei verschiedenen Mitteln übersetzt werden:

#manuelle Eingabe über '''Transifex''' (offizielle und empfohlene Methode)
#Sprachdateien (lokal) manuell bearbeiten
#Vollautomatisch: Autotranslator

 
==Manuelle Übersetzung mit Transifex Online-Service (empfohlen)==

Transifex ist eine Webanwendung, die eine Online-Plattform für Übersetzungsprojekte bietet. Es umfasst Teams und Diskussionstools, Translation Memory, Glossar, Korrekturlesen und viele andere Funktionen.
Es ist sehr einfach zu bedienen und alle Übersetzungen können über die Weboberfläche oder mit dem TX-Client von einem Terminal aus hoch- und heruntergeladen werden.
Transifex ist ein Open-Source-Projekt und die "Community Edition" kann kostenlos heruntergeladen und installiert werden, aber wir werden den online gehosteten Dienst nutzen.

===Verwendung der Weboberfläche (für Übersetzer)===
Wenn Sie helfen möchten, Dolibarr in Ihre Muttersprache zu übersetzen, besuchen Sie die Seite des Projekts unter https://app.transifex.com/dolibarr-association/dolibarr/dashboard/

Sie können dann ein Konto registrieren und den Beitritt zum Projektteam für die Sprache(n) beantragen, die Sie anstreben. Ein Manager wird Ihre Anfrage bearbeiten, also haben Sie bitte etwas Geduld.

Nach der Annahme können Sie sofort mit der Übersetzung beginnen.

Weitere Informationen finden Sie unter Transifex "Getting Started" Einführung unter http://docs.transifex.com/introduction/translators/ und das Webeditor-Tutorial unter http://docs.transifex.com/tutorials/txeditor/

'''Hinweis zum en_US Sprachpaket '''

Das Webinterface kann nicht verwendet werden, um das Sprachpaket en_US zu übersetzen, da es die Quelle für Übersetzungen darstellt.

Jede Änderung für das en_US Sprachpaket muss im Dolibarr Sourcecode erfolgen und via Pull-Request über das GitHub repository eingereicht werden.

===Verwendung des TX-Befehlszeilen-Clients (für Dolibarr [[:Category:Yoda]] team)===
Hier wird beschrieben, wie Sie Transifex von der Kommandozeile aus verwenden können. Dies ist jedoch den Dolibarr-Administratoren vorbehalten, um Transifex mit den Hauptquellen von Dolibarr zu synchronisieren.

Weitere Informationen finden Sie auch auf der Seite [http://docs.transifex.com/developer/client/ Transifex Official documentation]

====TX Client Konfiguration====
First install TX Client.
With Debian/Ubuntu/Mint:
<source lang="bash">
apt-get install python-pip
pip install transifex-client
</source>
Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.
<source lang="bash">
cd git/dolibarr
tx init
</source>
Akzeptieren Sie das Überschreiben der Konfigurationsdatei. Behalten Sie den Standardwert für die Transifex-Instanz bei und geben Sie dann Ihren Transifex-Login und Ihr Passwort ein.
Danach, a .transifexrc has been created into your HOME dir and a generic config file has been created as '''.tx/config''' in project's root.
So your directory's contents will look like that:
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

Die aktuelle Konfigurationsdatei kann heruntergeladen werden unter https://github.com/Dolibarr/dolibarr/tree/develop/.tx , hineingelegt in die .tx Verzeichnis, überschreibt diejenige, die von '''tx init''' erzeugt wurden.

This project configuration file is used to store the project’s details and the file-to-resource mappings.

Das ist ein Beispiel für die Inhalte der Konfigurationsdatei:

<source lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</source>

Hier folgt eine Erläuterung der Abschnitte und Optionen, die in der Konfigurationsdatei verwendet werden:

<nowiki>[main] section</nowiki>

In diesem Abschnitt finden wir projektübergreifende Optionen, wie z.B. den Standard Transifex-Host für alle Projekte. Dies kann von jeder Ressource bei Bedarf überschrieben werden.

<nowiki>[dolibarr.resource]</nowiki>

source_lang: this is the source language of the resource. 
source_file: zeigt direkt auf die Quelldatei. 
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory'' 
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory'' 
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory'' 

====TX Client Nutzung====
Nützliche Informationen zu '''tx''' Kommandos.

'''tx status'''

Zeige den Status von Übersetzungen

'''tx push'''

Used to push changes from your computer to Transifex server 
Additional options for the tx push command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to push (defaults to all)
-r <resource> - Specify the resource for which you want to push the translations (defaults to all)
-f - Push source files without checking modification times
--skip - Don't stop on errors. Useful when pushing many files concurrently.
-s - Push the source file to the server
-t - Push the translation files to the server
--no-interactive - Don't require user input when forcing a push</pre></code>

'''tx pull'''

Used to pull changes from Transifex server to your computer 
Additional options for the tx pull command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from the server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''Examples'''

To pull translation files, you can use:

<source lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</source>

To push source files, just type:

<source lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</source>

===Weitere Fragen zum Transifex-Prozess===
Dies sind kurze Fragen und Antworten, die Sie auch zum Übersetzungsprozess von transifex stellen können:

1) Liegt die Synchronisation in einem regelmäßigen Zeitintervall?

Nein. Es wird dort durchgeführt, wo genügend Übersetzungen eingereicht wurden. Es wird auch in einem Beta-Zweig durchgeführt, kurz bevor das endgültige Release-Paket erstellt wird.

2) Werden alle Übersetzungen mit git synchronisiert oder nur die korrigierten Übersetzungen? Muss ich das überprüfen, bevor die Synchronisierung durchgeführt wird?

Wenn eine Synchronisierung durchgeführt wird, überschreiben Transifex-Dateien Dateien in git, aber nur, wenn zumindest ein Datensatz für die Datei geändert wurde.
Sie müssen keine Überprüfung durchführen, bevor die Synchronisierung abgeschlossen ist. Beim Review ist vor allem zu wissen, welche Zeilen manuell überprüft wurden und welche zunächst mit einem Roboter übersetzt wurde.

3) In welchen Dolibarr-Versionen werden Übersetzungen verfügbar sein? Werden Transifex-Übersetzungen auch mit Wartungsreleases synchronisiert?

Die Synchronisation erfolgt immer in der Entwicklungsphase und/oder in der Beta-Phase.
So erscheinen Transifex-Änderungen in allen Versionen, deren Zweig nach der Transifex-Änderung erstellt wird (eine Synchronisierung wird immer durchgeführt, bevor ein neue branch erstellt wird). Sobald eine branch erstellt wurde, sind die neuen Änderungen in transifex nur noch für den nächste branch verfügbar. Der Grund dafür ist, dass transifex nicht in der Lage ist, Zweig/Versionen zu verwalten (noch nicht).

Übersetzt mit www.DeepL.com/Translator (kostenlose Version)

==Manuelle Übersetzung (nicht empfohlen)==

To translate Dolibarr into another language, go to the langs directory and create a folder/directory named with the code language to translate (follow the existing format, for example en_US, en_GB, es_ES, de_DE, etc...). Then copy the files from an existing language directory (for example en_US/main.lang, en_GB/bills.lang), into the new language directory that you have just created.

These files have the format of key/value pairs in each line like the followings:

<source lang="ini">
Code1 = translate phrase 1
Code2 = translate phrase 2
...
Coden = translate phrase n
</source>

Translate the phrases (the value portion of the key/value pairs) on the right side of the "=" as seen above, the code (the key portion) on the left side of "=" should remain unchanged. It is possible to translate the files one by one, without bringing them all at once. If a file has not been translated into the new language, Dolibarr uses English.

To have a localised (translated) string into the PHP code, all you have to do is load the language file and use the method to get the translated value, like this:

<source lang="php">
$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX

print $langs->trans("CodeX")
</source>

An entry type;

<source lang="ini">
CodeX = phrase X
</source>

muß vorhanden sein oder in die Datei myfile.lang hinzugefügt werden.

==Automatische Übersetzung mit dem Tool '''autotranslator.php'''==

*Translator OS: All
*Tool: '''autotranslator.php''' provided with Dolibarr in directory '''dev/translation'''.

Diese Methode wird empfohlen, wenn Sie mit der Übersetzung für eine Sprache beginnen, die noch nicht initialisiert/vorhanden ist.

Wenn bereits eine Übersetzung verfügbar ist, Sie aber einen fehlenden Schlüssel hinzufügen oder einen Fehler korrigieren müssen, sollten Sie Transifex verwenden (siehe oben).

Um alle Dateien eines Sprachcodes zu erstellen oder zu aktualisieren, führen Sie einfach das Skript aus:

<source lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</source>

Zum Beispiel:
<source lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</source>

to translate into Portuguese (pt_PT) using English (en_US) files.

Alle nicht existierenden Dateien werden erstellt, alle bestehenden Dateien werden aktualisiert.
Die Verwendung des Tools [http://translate.google.com Google translation] Service, um den Übersetzungswert einer Zeichenkette zu finden.
service to find the translation value of a string, so a working Internet connection is required from station running the script.

Also, a GOOGLEAPIKEY is required and Google charges a fee for using this service (20 euros / 1 000 000 of translated chars).

Your PHP must also have permissions to write into '''htdocs/langs''' directory and must have curl functions available.

=[[File:Language.png]] Verteilen oder integrieren Sie Ihre Übersetzung in die Kernquelle.=

Once you start translating, it's a smart decision to share it, so it can be included in the official code of Dolibarr.
If you keep it for you, others will not be able to improve it when new terms are added or previous terms are modified, and you will still have to manage the translation on your own.

If you translated through the Transifex system, there's nothing to be done. Your translation will be included in the next version of Dolibarr. No additional work! In technical terms, the translation will be exported from Transifex and imported into Dolibarr by our developers, at least once every month.

If, however, you translated directly in Dolibarr files, then you will first have to transfer those translations to Transifex before they can be included. So, really, you should start translating into Transifex.
If you send us your translation through a Pull Request on Github, sadly, it will be overwritten by the next import from Transifex, so it would be very short-lived.

Hinweis:

The reference language is en_US and is always complete. You can find it in the htdocs/langs/en_US/ folder. All other language files are likely to be slightly or highly incomplete, depending on the language.

If you are developing a new module, you are likely going to need the addition of new language variables. This is done exclusively through the update of the en_US language (htdocs/langs/en_US/ folder). Just modify these files to add the variable you need and send the resulting folder as part of your Pull Request. Refer to the developer documentation to learn how to contribute code (you will need an account on {{TemplateUrlSCM}}.

=[[File:Language.png]] Übersetzungen für dieses Wiki=
Das Wiki ist zumeist in den Sprachen Englisch, Französisch und teilweise Spansich, aber auch Deutsch geschrieben.

Wenn Sie die Dokumentation in einer dieser Sprachen verbessern möchten oder eine neue Übersetzung hinzufügen wollen, müssen Sie lediglich ein Konto in diesem Wiki erstellen.

Danach können Sie die Übersetzung existierender Seiten verbessern und bisher noch nicht übersetzte Seiten neu übersetzen (siehe: [[:Category:Page_waiting_for_translation]]).

 

===Wie man eine bestehende Seite übersetzt ?===

====Erstellen Sie eine neue Seite für die übersetzte Version.====
Erstellen Sie zunächst eine neue Seite für die übersetzte Version. Dazu können Sie auf eine nicht vorhandene URL zugreifen: z.B. [[Translator documentation|<code>https://wiki.dolibarr.org/index.php/Ma_nouvelle_page_en_français</code>]]

Der gewählte Titel für die übersetzte Version der Seite sollte die Übersetzung des Titels der englischen Originalseite sein.

Documentación traductores

2026-04-17T08:48:33Z

Kusco: /* Using the web interface (for translators) */

[[en:Translator_documentation]]
[[fr:Documentation_traducteur]]
[[de:Dokumentation_Uebersetzung]]
[[zh:翻译文档]]


=[[File:Language.png]] Traducir Dolibarr a otro idioma=
Dolibarr se desarrolla por defecto en inglés

Existen 3 métodos para realizar la traducción de Dolibarr:

#Automático mediante autotranslator.php
#Manualmente mediante la modificación de los archivos de idiomas
#Manualmente usando Transifex.com (oficial y recomendado).

Los describimos por orden de preferencia:

==Traducción via transifex (recomendada)==
{{ToTranslate}}

Transifex is a web application that provides an online platform for translation projects. It includes teams and discussion tools, translation memory, glossary, proofreading and a lot of other features.
It is quite easy to use and all translations can be uploaded or downloaded through the web interface or using their TX client in a terminal.
Transifex is an open source project and the "community edition" can be freely downloaded and installed, but we will use the online hosted service.

===Create transifex account and choose language===
If you want to help translating Dolibarr in your own language, please refer to https://app.transifex.com/dolibarr-association/dolibarr/dashboard/ and see if language is already supported. If it exists (many teams are already working for the project), you can ask to join the team and start to translate right away; if there is not a team for your language, you should request a new translation team on Transifex. It can be done directly using transifex.com interface on the website.

===Using the web interface (for translators)===
If language is already available onto page https://app.transifex.com/dolibarr-association/dolibarr/dashboard/, just create an account and follow instruction of transifex web site to translate files.

Note, that this web interface must not be used to translate en_US language that is source. Any change on source language must be done by submiting code change using GitHub Pull Requests.

===Using TX command line client (for Dolibarr [[:Category:Yoda]] team)===
This describe how to use Transifex from command line. However, this is reserved to Dolibarr admin users to synchronize Transifex with Dolibarr main sources.

[http://docs.transifex.com/developer/client/ Official documentation]

====TX Client configuration====
First install TX Client.
With Debian/Ubuntu/Mint:
<source lang="bash">
apt-get install python-pip
pip install transifex-client
</source>
Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.
<source lang="bash">
cd git/dolibarr
tx init
</source>
Accept to overwrite config file. Keep default value for Transifex instance, then enter your Transifex login and password.

After this, a .transifexrc has been created into your HOME dir and a generic config file has been created as '''.tx/config''' in project's root.
So your directory's contents will look like that:
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

The current config file can be downloaded from https://github.com/Dolibarr/dolibarr/tree/develop/.tx , put it into .tx directory, overwriting the one created by '''tx init'''

This project configuration file is used to store the project’s details and the file-to-resource mappings.

That is a sample of what the config file contains:

<source lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</source>

Here is an explanation of the sections and options used in the config file:

<nowiki>[main] section</nowiki>

In this section we have project-wide options, such as the default transifex host for all projects. These can be overriden by each resource, in case it is needed.

<nowiki>[dolibarr.resource]</nowiki>

source_lang: this is the source language of the resource. 
source_file: this points to the source file directly. 
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory'' 
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory'' 
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory'' 

====TX Client use====
Some useful information on '''tx''' commands.

'''tx status'''

Show status of translations

'''tx push'''

Used to push changes from your computer to Transifex server 
Additional options for the tx push command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to push (defaults to all)
-r <resource> - Specify the resource for which you want to push the translations (defaults to all)
-f - Push source files without checking modification times
--skip - Don't stop on errors. Useful when pushing many files concurrently.
-s - Push the source file to the server
-t - Push the translation files to the server
--no-interactive - Don't require user input when forcing a push</pre></code>

'''tx pull'''

Used to pull changes from Transifex server to your computer 
Additional options for the tx pull command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''Examples'''

To pull translation files, you can use:

<source lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</source>

To push source files, just type:

<source lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</source>

===Other questions on transifex process===
This is short questions and answer yuo may also ask about transifex translation process:

1) Is the sync on a regular time interval ?

No. It is done where there is enough translation submited. It is also done on a beta branch just before creating the final release package.

2) Are all the translations synced to git, or only the reviewed translations. Do I need to review before sync is done ?

When a Sync is done, transifex files overwrites files into git, but only if there is at least on record modified for the file.
You don't have to make review before sync is done. Making review is above all to know which lines were manually reviewed and wich one were intially translated using a robot.

3) In which Dolibarr releases will translations be available ? Are transifex translations also synced to maintenance releases ?

Sync is always done on develop and/or beta.
So transifex changes appear in all version whose branch is created after the transifex change (a sync is always done before creating a new branch). Once a branch is created, then new changes into transifex will be available only for next branch. Reason of this is that transifex is not able to manage branch/versions (not yet).

==Traducción totalmente manual (no recomendada)==

Para traducir Dolibarr a otro idioma, vaya a la carpeta langs y cree una carpeta llamada con el código de idioma a traducir (Siguiendo el mismo formato de las ya existentes, por ejemplo en_US, fr_FR, es_ES, de_DE, etc...).
Deberá copiar los archivos de una carpeta lang ya traducida (por ejemplo en_US/main.lang ó fr_FR/bills.lang), y pegarlas en la carpeta del nuevo idioma que acabamos de crear y empezaremos a traducir el contenido de estos archivos.

Estos ficheros están constituidos de la siguiente manera:

<source lang="ini">
Code1=Frase a traducir 1
Code2=Frase a traducir 2
...
Coden=Frase a traducir n
</source>

Solamente las frases a la derecha del = se deben traducir, el código debe permanecer sin cambios.
Es posible traducir los archivos uno por uno, sin tener que traducirlos todos a la vez. Si un archivo no se ha traducido en el nuevo idioma, Dolibarr utilizará el Inglés.

Para tener una variable de cadena para el idioma en el código PHP, todo lo que necesita hacer es cargar el archivo de idioma y utilizar el método para recuperar la variable traducida. Esto se puede hacer de la siguiente manera:

<source lang="php">
$langs->load("nombredelarchivo"); // o $langs->load("nombredelarchivo@mimodulo") si miarchivo.lang se encuentra en el directorio htdocs/mimodulo/langs/xx_XX

print $langs->trans("CodeX")
</source>

Y una entrada del tipo
<source lang="ini">
CodeX=Phrase X
</source>

debe de ser añadida a los ficheros .lang

==Traducción automática mediante la utilidad autotranslator.php (no recomendada)==

*SO del traductor: Cualquiera
*Utilidad: autotranslator.php viene con Dolibarr, se encuentra en la carpeta '''dev/translation'''.

Para traducir o actualizar todos los archivos en un nuevo idioma, símplemente ejecute el script:
<source lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</source>
Por ejemplo:
<source lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</source>
para realizar la traducción al portugés (pt_PT) utilizando el inglés (en_US) como origen.

Todos los ficheros no existentes serán creados, y los existentes se actualizarán con las cadenas inexistentes. Las cadenas ya traducidas anteriormente se conservarán tal cual.
La utilidad utiliza el servicio de [http://translate.google.com traducción de Google] para encontrar el valor traducido de una cadena.
Su PHP debe de tener permisios de escritura en la carpeta '''htdocs/langs''' y disponer de las funciones de la extensión curl disponibles.

=[[File:Language.png]] Difusión o inegras su idioma=

Lo mejor que puede hacer, después de realizar una traducción, es incluirla incluye en la versión oficial de Dolibarr.

Si usted ha completado archivos .lang existentes en Dolibarr de forma incompleta o si ha creado nuevos archivos .lang para un nuevo idioma, puede :

*Incluir sus cambios o archivos en la versión oficial de Dolibarr. Es posible, si sabe usar un sistema GIT. Para ello cree una cuenta en {{TemplateUrlSCM}}, haga un fork del proyecto Dolibarr, haga sus cambios y mande un Pull Request.
*o envíe sus archivos por e-mail en un adjunto a la lista inglesa: '''dolibarr-dev@nongnu.org''' (Inscripción en {{TemplateURLMLDev}}). Un desarrollador lo integrará por usted.

''Nota:'' Hay un idoma principale, que siempre están completos:

*El inglés (ficheros .lang de la carpeta lang/en_US)

Puede utilizar indistintamente tanto uno como el otro (el que prefiera) como referencia ya que los dos están actualizados. Todos los demás archivos de idioma son susceptibles de estar incompletos.

=[[File:Language.png]] Traducción del wiki=
El wiki se mantiene en 3 idiomas: Inglés, Francés y Español.
Si desea mejorar la documentación en uno de estos idiomas, simplemente debe de crear una cuenta en este wiki.
Entonces, podrá modificar una traducción incorrecta o traducir una página a la espera de traducción. La lista de estas páginas se encuentra disponible en la página [[:Category:Page_waiting_for_translation]].

Translator documentation

2026-04-17T08:47:59Z

Kusco: /* Using the web interface (for translators) */

[[fr:Documentation_traducteur]]
[[es:Documentación_traductores]]
[[de:Dokumentation_Uebersetzung]]
[[zh:翻译文档]]

{{#metamaster:keywords|translation, documentation, translator, localize, localization, i18n, l18n, internationalization, language}}

=[[File:Language.png]] Translate Dolibarr Application into your language=

Dolibarr language files are already translated in several languages.
English is the default and always complete. Other languages depend on contributions. This tutorial can help you complete a translation for a language not yet available or somehow incorrect.
Dolibarr can be translated by three different means:

#Manually using Transifex (Official and recommended method).
#Manually editing language files
#Completely automatic: autotranslator

==Manual Translation using Transifex online service (recommended)==

Transifex is a web application that provides an online platform for translation projects. It includes teams and discussion tools, translation memory, glossary, proofreading and a lot of other features.
It is quite easy to use and all translations can be uploaded and downloaded through the web interface or using their TX client from a terminal.
Transifex is an open source project and the "community edition" can be freely downloaded and installed, but we will use the online hosted service.

===Using the web interface (for translators)===
If you want to help to translate Dolibarr in your own language, check the project's page at https://app.transifex.com/dolibarr-association/dolibarr/dashboard/

You can then register an account and request joining the project team for the language(s) you're targeting. A manager will have to accept your request, so please be patient.

Once accepted, you can start translating right away.

For more information, please check Transifex "Getting Started" introduction at http://docs.transifex.com/introduction/translators/ and the web editor tutorial at http://docs.transifex.com/tutorials/txeditor/

''' Note about en_US '''

The web interface can not be used to translate the en_US language which is source.

Any change for en_US language must be done in Dolibarr source code and submitted using a Pull Request on our GitHub repository.

===Using TX command line client (for Dolibarr [[:Category:Yoda]] team)===
This describes how to use Transifex from the command line. However, this is reserved to Dolibarr admin users to synchronize Transifex with Dolibarr main sources.

More information can also be found on the [http://docs.transifex.com/developer/client/ Transifex Official documentation]

====TX Client configuration====
First install TX Client.
With Debian/Ubuntu/Mint:
<syntaxhighlight lang="bash">
apt-get install python-pip
pip install transifex-client
</syntaxhighlight>
Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.
<syntaxhighlight lang="bash">
cd git/dolibarr
tx init
</syntaxhighlight>
Accept to overwrite config file. Keep default value for Transifex instance, then enter your Transifex login and password.

After this, a .transifexrc has been created into your HOME dir and a generic config file has been created as '''.tx/config''' in project's root.
So your directory's contents will look like that:
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

The current config file can be downloaded from https://github.com/Dolibarr/dolibarr/tree/develop/.tx , put it into .tx directory, overwriting the one created by '''tx init'''

This project configuration file is used to store the project’s details and the file-to-resource mappings.

That is a sample of what the config file contains:

<syntaxhighlight lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</syntaxhighlight>

Here is an explanation of the sections and options used in the config file:

<nowiki>[main] section</nowiki>

In this section, we have project-wide options, such as the default transifex host for all projects. These can be overridden by each resource, in case it is needed.

<nowiki>[dolibarr.resource]</nowiki>

source_lang: this is the source language of the resource. 
source_file: this points to the source file directly. 
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory'' 
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory'' 
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory'' 

====TX Client use====
Some useful information on '''tx''' commands.

'''tx status'''

Show status of translations

'''tx push'''

Used to push changes from your computer to Transifex server 
Additional options for the tx push command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to push (defaults to all)
-r <resource> - Specify the resource for which you want to push the translations (defaults to all)
-f - Push source files without checking modification times
--skip - Don't stop on errors. Useful when pushing many files concurrently.
-s - Push the source file to the server
-t - Push the translation files to the server
--no-interactive - Don't require user input when forcing a push</pre></code>

'''tx pull'''

Used to pull changes from Transifex server to your computer 
Additional options for the tx pull command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from the server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''Examples'''

To pull translation files, you can use:

<syntaxhighlight lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</syntaxhighlight>

To push source files, just type:

<syntaxhighlight lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</syntaxhighlight>

===Other questions on transifex process===
This is short questions and answers you may also ask about transifex translation process:

1) Is the sync done on a regular time interval?

No. It is done where there is enough translation submitted. It is also done on a beta branch just before creating the final release package.

2) Are all the translations synced to git or only the reviewed translations ? Do I need to review before sync is done?

When a Sync is done, transifex files overwrites files into git, but only if there is at least on record modified for the file.
You don't have to make a review before sync is done. Making review is above all to know which lines were manually reviewed and which one was initially translated using a robot. The sync always take the last translated version, even if the new translation was not reviewed.

3) In which Dolibarr releases will translations be available? Are Transifex translations also synced to maintenance releases?

Sync is always done on develop and/or beta.
So Transifex changes appear in all versions whose branch is created after the Transifex change (a sync is always done before creating a new branch). Once a branch is created, the new changes into Transifex will be available only for the next branch. The reason for this is that we do not manage branch/versions on Transifex (not yet).

==Manual Translation (not recommended)==

To translate Dolibarr into another language, go to the langs directory and create a folder/directory named with the code language to translate (follow the existing format, for example en_US, en_GB, es_ES, de_DE, etc...). Then copy the files from an existing language directory (for example en_US/main.lang, en_GB/bills.lang), into the new language directory that you have just created.

These files have the format of key/value pairs in each line like the followings:

<syntaxhighlight lang="ini">
Code1 = translate phrase 1
Code2 = translate phrase 2
...
Coden = translate phrase n
</syntaxhighlight>

Translate the phrases (the value portion of the key/value pairs) on the right side of the "=" as seen above, the code (the key portion) on the left side of "=" should remain unchanged. It is possible to translate the files one by one, without bringing them all at once. If a file has not been translated into the new language, Dolibarr uses English.

To have a localised (translated) string into the PHP code, all you have to do is load the language file and use the method to get the translated value, like this:

<syntaxhighlight lang="PHP">
$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX

print $langs->trans("CodeX")
</syntaxhighlight>

An entry type;

<syntaxhighlight lang="ini">
CodeX = phrase X
</syntaxhighlight>

must be present or added to the myfile.lang file.

==Automatic Translation with autotranslator.php tool==

*Translator OS: All
*Tool: '''autotranslator.php''' provided with Dolibarr in directory '''dev/translation'''.

This method is recommended when starting translation for a language not already initialized. If there is already a translation available but you need to add a missing key or correct errors, try to use method using Transifex (see later).

To make or update all files of a language code, just run the script:
<syntaxhighlight lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</syntaxhighlight>
For example :
<syntaxhighlight lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</syntaxhighlight>
to translate into Portuguese (pt_PT) using English (en_US) files.

All nonexisting files will be created, all existing files will be updated.
The tool use [http://translate.google.com Google translation] service to find the translation value of a string, so a working Internet connection is required from station running the script. Also, a GOOGLEAPIKEY is required and Google charges a fee for using this service (20 euros / 1 000 000 of translated chars).
Your PHP must also have permissions to write into '''htdocs/langs''' directory and must have curl functions available.

=[[File:Language.png]] Distribute or include your translation into core source=

Once you start translating, it's a smart decision to share it, so it can be included in the official code of Dolibarr.
If you keep it for you, others will not be able to improve it when new terms are added or previous terms are modified, and you will still have to manage the translation on your own.

If you translated through the Transifex system, there's nothing to be done. Your translation will be included in the next version of Dolibarr. No additional work! In technical terms, the translation will be exported from Transifex and imported into Dolibarr by our developers, at least once every month.

If, however, you translated directly in Dolibarr files, then you will first have to transfer those translations to Transifex before they can be included. So, really, you should start translating into Transifex.
If you send us your translation through a Pull Request on Github, sadly, it will be overwritten by the next import from Transifex, so it would be very short-lived.

Note:

The reference language is en_US and is always complete. You can find it in the htdocs/langs/en_US/ folder. All other language files are likely to be slightly or highly incomplete, depending on the language.

If you are developing a new module, you are likely going to need the addition of new language variables. This is done exclusively through the update of the en_US language (htdocs/langs/en_US/ folder). Just modify these files to add the variable you need and send the resulting folder as part of your Pull Request. Refer to the developer documentation to learn how to contribute code (you will need an account on {{TemplateUrlSCM}}.

=[[File:Language.png]] Translate documentation on wiki=
The wiki is written in 3 languages: English, French, and Spanish.
If you want to enhance documentation on one of these languages, all you have to do is to create an account on this wiki.
Then, you can edit existing pages to correct a bad translation or translate pages waiting for translation [[:Category:Page_waiting_for_translation]].

 

===How to translate an existing page ?===

====Create a new page for the translated version.====
Start by creating a new page for the translated version. To do this, you can access an non existant URL : for example [[Translator documentation|<code>https://wiki.dolibarr.org/index.php/Ma_nouvelle_page_en_français</code>]]

The chosen title for the translated version of the page should be the translation of the title of the original English page.

Documentation traducteur

2026-04-17T08:46:50Z

Kusco: /* Créer un compte transifex et choisissez votre langue */

[[en:Translator_documentation]]
[[es:Documentación_traductores]]
[[de:Dokumentation_Uebersetzung]]
[[zh:翻译文档]]

{{#metamaster:keywords|traduction, documentation, traducteur, localisation, localiser, internationalise, langage}}
=[[File:Language.png]] Traduire l'application Dolibarr dans une autre langue=
Dolibarr est livré avec plusieurs langues. Par défaut, l'Anglais est toujours complet. Les autres langues dépendent des contributions. Cette documentation vous présente comment traduire les fichiers langues pour ajouter une langue non traduite ou traduite de manière incomplète.

Il existe 3 méthodes pour réaliser la traduction de Dolibarr:

#Manuelle en utilisant Transifex.com (officielle et recommandée).
#Manuelle par modification des fichiers langues
#Automatique avec autotranslator.php

Les voici par ordre de préférences:

==Traduction manuelle en utilisation le service en ligne de traduction Transifex (recommandé)==

Transifex est une solution web qui fournit une plateforme pour la traduction des projets. Cela inclut la gestion d'équipes et de discussions, la mémoire de traduction, glossaires, and nombreuses autres fonctionnalités.
C'est assez simple d'utilisation et toute traduction peut être soumise ou récupérer à traver de l'interface web ou en utilisant le client TX dans un terminal.

Transifex fournit un service hébergé en ligne.

{{ToTranslate}}

==Créer un compte transifex et choisissez votre langue==
Si vous souhaitez contribuer à la traduction de Dolibarr dans votre langue, référez-vous s'il vous plaît au lien suivant : https://app.transifex.com/dolibarr-association/dolibarr/dashboard/, puis vérifiez si votre langue est prise en compte.
Si elle existe (plusieurs équipes sont disponibles pour travailler sur le projet), vous pouvez demander à rejoindre l'équipe et commencer à traduire tout de suite. S'il n'existe pas d’équipe pour votre langue, vous pouvez demander une nouvelle équipe sur Transifex. Cela peut être fait directement sur le site Web de http://transifex.com

===Utilisation de l'interface Web (pour les traducteurs)===
Si la langue est déjà disponible sur la page https://app.transifex.com/dolibarr-association/dolibarr/dashboard/, créez un compte et suivez les instructions du site Web de transifex pour traduire les fichiers.

Notez que cette interface Web ne doit pas être utilisée pour traduire le langage en_US source. Toute modification de la langue source doit être effectuée en soumettant une modification de code à l'aide de demandes d'extraction GitHub.

===Utilisation du client en ligne de commande TX (pour Dolibarr [[:Category:Yoda]] team)===
Ceci décrit comment utiliser Transifex à partir de la ligne de commande. Toutefois, cela est réservé aux administrateurs Dolibarr pour synchroniser Transifex avec les sources principales de Dolibarr.

[http://docs.transifex.com/developer/client/ Documentation officielle]

====TX Client configuration====
Installez d'abord TX Client.
Avec Debian/Ubuntu/Mint:
<source lang="bash">
apt-get install python-pip
pip install transifex-client
</source>
Ensuite, vous devez initialiser votre environnement TX. Ceci est fait en exécutant '''tx init''' dans le répertoire racine du projet dolibarr.
<source lang="bash">
cd git/dolibarr
tx init
</source>
Acceptez pour écraser le fichier de configuration. Conservez la valeur par défaut pour l'instance Transifex, puis entrez votre identifiant et votre mot de passe Transifex.

After this, a .transifexrc has been created into your HOME dir and a generic config file has been created as '''.tx/config''' dans la racine du projet.
Ainsi, le contenu de votre répertoire ressemblera à cela:
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

The current config file can be downloaded from https://github.com/Dolibarr/dolibarr/tree/develop/.tx , put it into .tx directory, overwriting the one created by '''tx init'''

This project configuration file is used to store the project’s details and the file-to-resource mappings.

That is a sample of what the config file contains:

<source lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</source>

Here is an explanation of the sections and options used in the config file:

<nowiki>[main] section</nowiki>

In this section we have project-wide options, such as the default transifex host for all projects. These can be overriden by each resource, in case it is needed.

<nowiki>[dolibarr.resource]</nowiki>

source_lang: this is the source language of the resource. 
source_file: this points to the source file directly. 
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory'' 
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory'' 
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory'' 

====TX Client use====
Some useful information on '''tx''' commands.

'''tx status'''

Show status of translations

'''tx push'''

Used to push changes from your computer to Transifex server 
Additional options for the tx push command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to push (defaults to all)
-r <resource> - Specify the resource for which you want to push the translations (defaults to all)
-f - Push source files without checking modification times
--skip - Don't stop on errors. Useful when pushing many files concurrently.
-s - Push the source file to the server
-t - Push the translation files to the server
--no-interactive - Don't require user input when forcing a push</pre></code>

'''tx pull'''

Used to pull changes from Transifex server to your computer 
Additional options for the tx pull command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''Examples'''

To pull translation files, you can use:

<source lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</source>

To push source files, just type:

<source lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</source>

===Other questions on transifex process===
This is short questions and answer yuo may also ask about transifex translation process:

1) Is the sync on a regular time interval ?

No. It is done where there is enough translation submited. It is also done on a beta branch just before creating the final release package.

2) Are all the translations synced to git, or only the reviewed translations. Do I need to review before sync is done ?

When a Sync is done, transifex files overwrites files into git, but only if there is at least on record modified for the file.
You don't have to make review before sync is done. Making review is above all to know which lines were manually reviewed and wich one were intially translated using a robot.

3) In which Dolibarr releases will translations be available ? Are transifex translations also synced to maintenance releases ?

Sync is always done on develop and/or beta.
So transifex changes appear in all version whose branch is created after the transifex change (a sync is always done before creating a new branch). Once a branch is created, then new changes into transifex will be available only for next branch. Reason of this is that transifex is not able to manage branch/versions (not yet).

==Traduction manuelle complètement (non recommandé)==

Pour traduire Dolibarr dans une autre langue, il faut aller dans le répertoire langs et créer un répertoire ayant pour nom le code langue à traduire (En suivant le même format que ceux déjà existant, par exemple en_US, fr_FR, es_ES, de_DE, etc...).
Il faut ensuite recopier les fichiers lang depuis un répertoire déjà traduit (par exemple en_US/main.lang ou fr_FR/bills.lang), les recopier dans le répertoire de la nouvelle langue que l'on vient de créer et traduire le contenu de ces fichiers.

Ces fichiers sont constitués de la manière suivante:

<source lang="ini">
Code1=Phrases à traduire 1
Code2=Phrases à traduire 2
...
Coden=Phrases à traduire n
</source>

Seules les phrases à droite du = sont à traduire, le code doit rester inchangé.
Il est possible de traduire les fichiers un par un, sans tous les traduire d'un coup. Si un fichier n'a pas été traduit dans la nouvelle langue, Dolibarr utilisera l'anglais.

Pour avoir une chaine variable selon la langue dans le code PHP, tout ce que vous avez à faire et de charger le fichier lang et d'utiliser la méthode pour récupérer la variable traduite. Ceci peut se faire de la manière suivante:

<source lang="php">
$langs->load("nomdufichier"); // ou $langs->load("nomdufichier@monmodule") si monfichier.lang est dans le répertoire htdocs/monmodule/langs/xx_XX

print $langs->trans("CodeX")
</source>

Et une entrée du type
<source lang="ini">
CodeX=Phrase X
</source>

doit être ajoutée aux fichiers .lang

==Traduction automatique avec l'outil autotranslator.php (non recommandée)==

*OS du traducteur: Tous
*Outil: autotranslator.php fourni avec Dolibarr dans le répertoire '''dev/translation'''.

Pour traduire ou mettre à jour tous les fichiers dans une nouvelle langue, lancez simplement le script:
<source lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</source>
Par exemple :
<source lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</source>
pour traduire en portugais (pt_PT) en utilisant l'anglais (en_US) comme fichiers sources.

Tous les fichiers non existant seront créés, et ceux existant déjà seront mis à jour pour être complétés avec les chaines manquantes.
Les chaines déjà traduites sont conservées tel quelles.
L'outil utilise le service de [http://translate.google.com traduction Google] pour trouver la valeur traduite d'une chaine, aussi un accès internet depuis le poste où est lancé la commande est requis.
De plus, une clé pour utiliser les API Google Translate sont nécessaire et Google fait payer l'utilisation de cette API (20 $ / 1 000 000 de caractères traduits).
Votre PHP doit de plus avoir les permissions d'écrire dans le répertoire '''htdocs/langs''' directory et doit avoir les fonctions de l'extension curl disponibles.

=[[File:Language.png]] Diffusion ou intégration en standard de votre traduction=

La meilleure chose à faire, après avoir réalisé une traduction, est de les inclure dans la version officielle de Dolibarr.

Si vous avez complété des fichiers .lang existant déjà dans Dolibarr mais incomplets ou si vous avez créé des nouveaux fichiers .lang pour une nouvelle langue, vous pouvez :

*Si la traduction a été faite en utilisant le système Transifex, il n'y a rien de particulier à faire. Votre traduction sera intégré lors des synchros régulières qui ont lieu avec les sources Git officielles (au moins 1 par mois).
*Si la traduction a été faite dans des fichiers directement pour les langues en_US, pt_BR, xx_ES, ..., il est possible de les intégrer si vous connaissez le système GIT. Pour cela, créer un compte sur {{TemplateUrlSCM}}, forker le projet, modifier les fichiers concernés et envoyer une Pull Request. A défaut de savoir utiliser GIT, envoyer vos fichiers sur la mailing-list des développeurs '''dolibarr-dev''' (Inscription sur {{TemplateURLMLDev}}.

''Remarque:'' Il y a une langue maitre toujours complète:

*L'anglais (fichiers .lang du répertoire lang/en_US)

Tous les autres fichiers langues sont susceptibles d'être incomplets.

=[[File:Language.png]] Traduire la documentation du wiki=
Le wiki est maintenu en 3 langues: Anglais, Français et Espagnol.
Si vous voulez améliorer la documentation d'une de ces langues, il vous suffit de créer un compte sur ce wiki.
Ensuite, vous pouvez modifier toute page qui possède une traduction incorrecte ou traduire une page qui attend d'être traduite. La liste de ces pages est disponible sur la page [[:Category:Page_waiting_for_translation]].

List of modules id

2025-11-30T00:03:44Z

Kusco:

{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}
{{TemplateDocDevZh}}

This page list all reserved modules numbers / ID.

If you build or want to build your own modules, you should take an ID range here. Please pick range into existing holes first.

=ID 0 - 94999=
This range is reserved for Dolibarr's internal core modules, so all modules available into the standard distribution at https://github.com/Dolibarr/dolibarr

=ID 95000 - 99999=
This range is reserved for Dolibarr's community modules with sources hosted into the github repository: https://github.com/Dolibarr/dolibarr-community-modules

=ID 100000 - 499999=

Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 20 numbers only the first time, ask us for more)

[[File:Warning.png]] If you reserve more than 20 at once, 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) - Belgium
*ID 101000 - 101999: NLTechno (https://www.nltechno.com) - France
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr) - France
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro) - France
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr) - France
*ID 105000 - 105999: GPC.solutions - France
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net) - France
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Aplose ([http://www.aplose.fr https://www.aplose.fr]) - France
*ID 110000 - 110999: Association Dolibarr (https://www.dolibarr.org)
*ID 111000 - 111999: Asset IT (www.assetit.ch) - Suisse
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch) - Suisse
*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) - France
*ID 121000 - 121999: Oscss - Shop - France
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: 7reasons s.r.l. (www.7reasons.eu) - Austria
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br) - Brazil
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu) - Italy
*ID 131000 - 131999: Joan Louis (itaca.fr) - France
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr) - France
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 134000 - 134999: ALSOFT PVT. LTD. (https://www.alsoft.org)
*ID 135000 - 135999: Net-Logic (https://netlogic.fr)
*ID 136000 - 136050: MONA.RE - France
*ID 136051 - 136099: La Vida Marketing
*ID 136100 - 136149: Synergies-Tech France. (https://www.synergies-france.fr/)
*ID 136150 - 136199: Lyta
*ID 136200 - 136219: Maison Théophile Leclerc
*ID 136220 - 136270: SegoFount - Spain
*ID 136271 - 136320: Labor Dispatch (Simon Sheng , China)
*ID 136321 - 136370: MB Informatique (https://www.mb-informatique.fr)
*ID 136371 - 136420: Daxit Solutions (https://www.daxit.be)
*ID 136421 - 136470: HUSCH GmbH (https://husch-gmbh.de)
*ID 136471 - 138999: NSINFO (https://www.ns-info.fr)
*ID 139000 - 139999: Synergies-Tech France. (https://www.synergies-france.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: Mainlab S.r.l. (https://www.mainlabonline.it) - Italy
*ID 141200 - 141249: Florian DUFOURG - France
*ID 141250 - 141299: SoftAddicts - Canada
*ID 141300 - 141349: Finanboo - (https://www.finanboo.com)
*ID 141350 - 141399: ConstruxZion Soft - Colombia (https://www.construxzionsoft.com.co)
*ID 141400 - 141450: COEXDIS - République Démocratique du Congo (https://www.coexdis.com)
*ID 141451 - 141501: HALFWARE - Algeria (https://www.half-ware.com)
*ID 141502 - 141552: Quantraum (https://quantraum.com)
*ID 141553 - 141603: Nateo Group
*ID 141604 - 141653: digital centric GmbH (https://www.digitalcentric.de/dolibarr)
*ID 141654 - 141699: Decrypting (https://www.decrypting.fr)
*ID 141700 - 141749: Zeise IT Consulting - Germany (https://www.zeise-it.de)
*ID 141750 - 141799: Data Rooster - France (https://datarooster.io)
*ID 141800 - 141849: IP Développement (https://www.ipdeveloppement.fr)
*ID 141850 - 141899: MSICCA | MRVL Soluciones de Ingeniería y Construcción, c.a (https://msicca.com)
*ID 141900 - 141949: THERSANE (https://www.thersane.fr)
*ID 141950 - 141999: MB Informatique (https://www.mb-informatique.fr)
*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 142100 - 142149: Bloxera GmbH (https://www.bloxera.com)
*ID 142150 - 142199: Evangelos Souglakos - Greece
*ID 142200 - 142249: Luc CALARESU - France
*ID 142250 - 142299: OmnIT Services - Belgique (https://www.omnitservices.biz)
*ID 142300 - 142349: Gwadeyes - Guadeloupe (https://www.gwadeyes-informatique.com/)
*ID 142350 - 142399: Solution Libre (https://www.solution-libre.fr/)
*ID 142400 - 142449: Res Digital (https://res.digital)
*ID 142450 - 142499: itopie informatique (https://www.itopie.ch)
*ID 142500 - 142549: Weblinx.IT GbR (https://weblinx.it/) - Germany
*ID 142550 - 142599: ASCI-Automation - Mexico (https://asci-automation.com.mx/)
*ID 142600 - 142649: ZENKO Design - Japan / France / Spain
*ID 142650 - 142699: AWeerWolf
*ID 142700 - 148749: Lysis (https://lysis.net/)
*ID 142750 - 142799: Hadritech (https://www.hadritech.com/)
*ID 142800 - 142849: Bloxera GmbH (https://www.bloxera.com)
*ID 142850 - 148999: Everlats S.L. - España (https://www.everlats.com)
*ID 149000 - 149999: SydTech - America Central (https://www.sydtech.io/)
*ID 150000 - 150999: Jeffinfo
*ID 151000 - 151999: Konverseo (https://konverseo.com)
*ID 152000 - 152049: Tanguy Pénet (http://tanguype.net)
*ID 152050 - 152099: Web Solutions
*ID 152100 - 152149: MagicNet (https://www.magicnet.it)
*ID 152150 - 152199: Benjamin Falière (https://www.faliere.com)
*ID 152200 - 152249: Solauv
*ID 152250 - 156499: TecnoGestión Principado S.L. (https://www.tecnogestion.com) - Asturias - España
*ID 156500 - 156549: ACE Recycling (https://www.acerecycling.net.au/)
*ID 156550 - 156599: Kreativität Works ([http://www.kreativitat.com http://kreativitat.com])
*ID 156600 - 156649: [https://pierre-couy.dev Pierre Couy]
*ID 156650 - 156699: CXI (https://cyrix.co.za)
*ID 156700 - 156749: Mustafa Kemerci - Turkiye
*ID 156750 - 156799: [https://de-grandpre.quebec de Grandpré Technologies] - Québec (Canada)
*ID 156800 - 156849: Draceo
*ID 156850 - 156899: Valleiweb
*ID 156900 - 159949: NEOVIAQ Advisory LU(https://www.neoviaq.com)
*ID 159950 - 159999: Arve et Giffre INFOGESTION (https://www.ag-infogestion.fr)
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (https://01consulting.eu)
*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 165151 - 165199: NUM'X (https://www.numx-sets.eu)
*ID 165200 - 165249: Benjam Préjent (https://www.benjam-prejent.fr)
*ID 165250 - 165299: Dhi Loka Private Limited, India (https://www.dhiloka.com)
*ID 165300 - 169999: Accellier Limited (https://www.accellier.com/)
*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: NSINFO (https://www.ns-info.fr)
*ID 172800 - 172849: E-Concept Applications (https://e-concept-applications.fr)
*ID 172850 - 172899: B&R Stamm UG (https://stamm-ug.de)
*ID 172900 - 172949: Dolipive, support@dolipive.fr, www.dolipive.fr
*ID 172950 - 172999: CKD-Industrie (https://ckd-industrie.com/) - France
*ID 173000 - 173049: Aneosys (https://aneosys.fr) - France
*ID 173050 - 173099: Sebastian Schloßer - Germany
*ID 173100 - 173149: TecnoSoluciones (https://tecnosoluciones.com)
*ID 173150 - 173199: Digitalworks (https://www.digitalworks.fr) - France
*ID 173200 - 173249: UNi.D Consulting (https://www.unid-consulting.fr) - France
*ID 173250 - 173299: NetworkDigital(https://www.networkdigital.fr) - France
*ID 173300 - 173300: Módulo VeriFactu Dolibarr (https://verifactudolibarr.es/) - España
*ID 173301 - 173320: Sibanet (https://sibanet.net) - España
*ID 173321 - 173340: disQutons (https://wiki.dolibarr.org/index.php/Category:DisQutons)
*ID 173341 - 173360: Surática Software (https://suratica.es) - Spain
*ID 173361 - 173380: UpInvoice (https://upinvoice.eu) - Spain
*ID 173381 - 179999: Toutatis (https://toutatis.eu)
*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 182050 - 182070: Herolapse (https://herolapse.com/)
*ID 182061 - 182999: TMC
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 184000 - 184999: DPS PRINTING & DOCUMENTS SOCIEDAD ANONIMA (https://www.dps-lat.com)
*ID 185000 - 185049: Telioskour (https://github.com/telioskour)
*ID 185050 - 185099: Moko Consulting ([[Moko Consulting]] || https://mokoconsulting.tech)
*ID 185100 - 185149: Sinabe (https://sinabe.ch) - Suisse
*ID 185150 - 185169: Anatole Conseil (https://anatoleconseil.com/)
*ID 185170 - 185189: cferoiu
*ID 185190 - 185209: Guillemonde (https://guillemonde.family)
*ID 185210 - 189999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 192000 - 192049: IDFOR Consulting (https://www.idfor-consulting.fr/)
*ID 192050 - 192069: Stogger (<nowiki>https://stogger.com</nowiki>)
*ID 192070 - 192090: Protectora
*ID 192091 - 198999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 207400 - 207449: Arthur LENOBLE
*ID 207450 - 207499: Vaicop SAS de CV (México)
*ID 207500 - 207520: Frankie Wong - UK
*ID 207521 - 212099: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 212100 - 212149: Audio Vidéo Technologies (https://www.avtek.fr)
*ID 212150 - 213999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 214000 - 214049: X-Boss
*ID 214050 - 221999: PixelJM
*ID 220000 - 220050: Apex Tech (https://apextechmods.com)
*ID 220051 - 220100: Technology Xchange Solutions (https://www.txscorp.com)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 223000 - 223049: Tráfico Canada
*ID 223050 - 223099 : VLTN (https://vltn.sh)
*ID 223100 - 229949: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 229950 - 229999: Solucions Informàtiques, Serveis i Innovació SLU (https://6innova.es)
*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 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230499: Chickenforce/code-chicken, IT Services Hahn (https://github.com/code-chicken [http://itservices-hahn.de/ https://itservices-hahn.de])
*ID 230500 - 230549: Hidup Consulting (https://consulting.hidup.io)
*ID 230550 - 230599 : CMR Conseil (https://www.weblockup.fr)
*ID 230600 - 230649 : aFreeMind Studio
*ID 230650 - 230699 : Unideal (https://www.uni-deal.com)
*ID 230700 - 230749 : DevLansdes (https://devlandes.com/)
*ID 230750 - 262699: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 262700 - 262799: Scopen (https://www.scopen.fr)
*ID 262800 - 262849: Christophe BATTAREL EI
*ID 262850 - 271799: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 271800 - 271849: bee solutions sàrl (Switzerland)
*ID 271850 - 272999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 273000 - 273019: Taler (https://taler.net)
*ID 273020 - 274199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 274200 - 274249: Mathilde MAROCCO (https://mminformatique.fr)
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350 - 274399: Milen karaganski (https://blacktiehost.com)
*ID 274400 - 274449: Vincent MAURY ([https://www.timgroup.fr www.timgroup.fr])
*ID 274450 - 274499: Daraelmin
*ID 274500 - 274549: Emilie LAFORET (http://www.ermvallon.com)
*ID 274550 - 278999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 279000 - 279049: VSDigital Electronics (https://vsdigital.ar) - Argentina
*ID 279050 - 279999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 280000 - 280049: Bingroup (https://www.beinng.com)
*ID 280050 - 280099: Medialta (https://medialta.com)
*ID 280100 - 280149: Cédric Ancelin - Ancode (https://www.dolistore.com/fr/recherche?search_query=ancode)
*ID 280150 - 289999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 290000 - 290099: BNS - Project doliBRA ([https://www.beinng.com https://www.bns.net.br]) - Brasil
*ID 290100 - 299999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 300000 - 300049: RapidProgress (https://www.rapidprogress.eu) - Bulgaria
*ID 300050 : 300099: M@ Solution (https://www.ma-solution.fr/)
*ID 300100 : 300149: LAVA RUN (https://www.lavarun.re)
*ID 300150 - 300199: PsyCrow Code
*ID 300200 : 300249 : Computences (https://www.computences.com/)
*ID 300250 : 300299 : LEVEL IT (https://levelit.com.ar)
*ID 300300 : 300349 : Progiseize (https://progiseize.fr)
*ID 300350 - 300399: MB Informatique (https://www.mb-informatique.fr)
*ID 300400 - 300449: Anouar Touati
*ID 300450 - 300499: Martin Danger
*ID 300500 - 301499: Whale Blows
*ID 301500 - 301549: Tom Trust - International
*ID 301550 - 301599: MB Informatique (https://www.mb-informatique.fr)
*ID 301600 - 302479: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 302480 - 302499: akyras (https://akyras.fr)
*ID 302500 - 302549: Diamubi (https://diamubi.com)
*ID 302550 - 302599: Datolab (https://www.datolab.com)
*ID 302600 - 302649: DuMaCo (https://www.dumaco.de)
*ID 302650 - 302699: Resilio SA
*ID 302700 - 302749: Aroga
*ID 302750 - 302799: Productivix (https://www.productivix.com)
*ID 302800 - 302849: Slibzz
*ID 302850 - 302899: idea design (https://ideadesign.dz)
*ID 302900 - 302949: AL MISBAH INFORMATIQUE (https://www.almisbah.ma)
*ID 302950 - 302999: Atis Solutions - France
*ID 303000 - 303499: Obixav - Nigeria
*ID 303500 - 303549: buschler plus GmbH, Germany (https://buschler.plus)
*ID 303550 - 303599: Prestalidaire - France (https://prestalidaire.com)
*ID 303600 - 309999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 310000 - 310049: Neilson Dufour (<nowiki>https://hypercode.ca</nowiki>)
*ID 310050 - 313999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 314000 - 314049: Ruemmler IT Solutions (https://www.ruemmler.net)
*ID 314050 - 314149: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 314150 - 314199: Benoît PASCAL
*ID 314200 - 319999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 322000 - 322049: Doymer Consultores
*ID 322050 - 329999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 331999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 - 332149: Agence Milkshake (http://agencemilkshake.com)
*ID 332150 - 332199: Daniel Prowald IT – Service (https://prowald-it.de)
*ID 332200 - 332249: UNITICE (https://unitice.com)
*ID 332250 - 332299: Sidonie Moulart
*ID 332300 - 332349: LTDJ (Antonin MARCHAL - Le Temple du Jeu)
*ID 332350 - 333299: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 333300 - 333349: Sense Africa (http://sense.africa)
*ID 333350 - 339999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 340000 - 340049: M34D (https://m34d.com)
*ID 340050 - 340069: WiwIT
*ID 340070 - 349999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 350000 - 350049: SOUNDOU & MIDAS (https://www.soundou.org/)
*ID 350050 - 350099: Ildefonso González (https://igontek.es)
*ID 350100 - 350149: 7Kas Servicios de Internet, S.L. (https://7kas.com)
*ID 350150 - 350999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 351000 - 351049: P'tite Tête (https://ptitetete.com) - France
*ID 351050 - 398999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 359000 - 359049: Milen Karaganski0
*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
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 406000 - 406999: Som Núvol (https://somnuvol.coop)
*ID 407000 - 407019: I-Motion SARL
*ID 407020 - 408999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 409000 - 409999: LliureTIC (https://www.lliuretic.cat)
*ID 410000 - 410999: DoliGov
*ID 411000 - 411049: GATTEK SARL (https://www.ga-ttek.com)
*ID 411050 - 419999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 421200 - 422199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423049: cyberesprit
*ID 423050 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 423200 - 423299: Pragma-tech (www.pragma-tech.fr)
*ID 423299 - 423999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 424000 - 424049: Philazerty ([https://www.philazerty.fr www.philazerty.fr])
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 - 424999: Lab51 (https://github.com/lab51org)
*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 - 426999: Bruno Caldas (https://github.com/BCaldas)
*ID 427000 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 428100 - 428199: Arnaud Serrut - Adalon
*ID 428200 - 428249: imschweiler consulting (http://www.imschweiler-consulting.de'''<nowiki/>''')
*ID 428250 - 428299: AL1FO
*ID 428300 - 428349: Federico García-Patiño Barbolani (<federico.garcia.patino@gmail.com>)
*ID 428350 - 428399: INTM Groupe - France (www.intm.com)
*ID 428400 - 428449: Nick Fragoulis - Greece
*ID 428450 - 428499: Kontava - France ([https://www.kontava.fr www.kontava.fr)]
*ID 428500 - 428549: hkwhitten - USA
*ID 428550 - 428999: SmartOne
*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 435400 - 435999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 - 436300: TDE-INFORMATIQUE (www.tde-informatique.fr)
*ID 436301 - 436349: Evarisk ([https://www.evarisk.com/id-module-dolibarr/ www.evarisk.com])
*ID 436350 - 436399: Eoxia ([https://www.eoxia.com/dolibarr/modules/ www.eoxia.com])
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 - 437449: Martin Neubauer - Germany
*ID 437450 - 437599: Club1click (www.club1click.es)
*ID 437600 - 437629: Coulon Vincent (https://github.com/HoverEpic)
*ID 437630 - 437649: Aytechnet (https://www.aytechnet.fr/) - François Pons
*ID 437650 - 437699: LibreMaster (https://libremaster.com) - Christophe T.
*ID 437700 - 437749: STELLAR Broadband (https://www.stellarbb.com) - U.S.A. - Philip Laycock
*ID 437750 - 437799: DIGITA.LU Ajous Solutions
*ID 437800 - 437850: iProspective (https://iprospective.fr) - Mathieu Moulin
*ID 437851 - 437900: Theobald Groupe.
*ID 437901 - 437950: Neuronnexion (http://neuronnexion.coop)
*ID 437951 - 437952: jmbc - APIA-ASSO (https://www.apia-asso.fr)
*ID 437953 - 438002: IPCZEN SARL (https://www.ipczeninformatique.fr/)
*ID 438003 - 438052: FESF IT Department (https://fesf.org.pk)
*ID 438053 - 438103: Pilot Engineering team
*ID 438104 - 438153: u2042 (https://u2042.com)
*ID 438154 - 438204: Djair E Pereira (ocultooooo@gmail.com) - Brasil
*ID 438205 - 438255: yoandm (https://yoandm.com)
*ID 438256 - 438299: PTMSoft (<nowiki>https://www.ptmsoft.fr</nowiki>)
*ID 438300 - 438399: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 445500 - 445549: X Net Systems - Egypt - (https://www.xneteg.com)
*ID 445550 - 445569: Schiefer.IT - Austria ([https://schiefer.it schiefer.it])
*ID 445570 - 445999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 - 460049: torvista - Spain
*ID 460050 - 460099:ADVAISION.com (Belgique www.advaision.com)
*ID460100 - 460999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 - 468169: Commotron GmbH (https://www.commotron.com/)
*ID 468170 - '''468219''': Infans Group (franck.lauby@infans.fr)
*ID '''468175''' - '''468199''': Gaëlle Rauffet - France (kiwiscan.net)
*ID '''468200''' - 468249: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468250 - 468269: CD-Systems - France (https://www.cd-systems.fr)
*ID 468270 - 468299: Nicolas Testori
*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 468650 - 468699: J-IT - Belgique (https://www.j-it.be)
*ID 468700 - 468749: Fidesio - France (https://www.fidesio.com/)
*ID 468750 - 468799: Sgestion - Spain (http://www.sgestion.net/)
*ID 468800 - 468849: Denis JULIEN - Brasil (matrinxa@free.fr)
*ID 468850 - 468899: Mmariko - Module GED - Effios
*ID 468900 - 468949: Maazou Amadou Abdoul aziz - Maroc (yaronfada@gmail.com)
*ID 468950 - 468999: Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 469000 - 469049: John Livingston (https://github.com/JohnXLivingston/)
*ID 469050 - 469099: Macrorom ICT-services (https://macrorom.nl/)
*ID 469100 - 469149: HABOT IT - France (https://habot.it)
*ID 469150 - 469159: CaribbeanConsult.Com CCC - France Guadeloupe (https://dolibarr.ccc.gp)
*ID 469160 - 469171: GMBG - Portugal
*ID 469172 - 469199: BGi Lda - Portugal
*ID 469200 - 469949: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 469950 - 469999: Goldoweb (http://goldoweb.com)
*ID 470000 - 470999: Reindeer Digital (https://rdeer.cz)
*ID 471000 - 471099: CAP-REL (www.cap-rel.fr)
*ID 471100 - 471199: M. Morillon
*ID 471200 - 471209: Pablo Nuñez
*ID 471210 - 471249: FANEL A.Ş (https://www.fanel.com.tr)
*ID 471250 - 480999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 481000 - 481999: Alhaidab-ITIS (https://alhaidab.dolibarr.sd)
*ID 482000 - 482999: Basix IT (https://www.basix.de)
*ID 483000 - 483049: SASCO SpA (https://www.sasco.cl)
*ID 483050 - 483099: WIP Engineering (https://www.wip-gmbh.com)
*ID 483100 - 483149: J.Kaiser
*ID 483150 - 483199: CodLines (https://www.codlines.com)
*ID 483200 - 483249: BleepalSoftware (https://bleepal.com)
*ID 485000 - 485049: Gest Info Service Plus (contact@gest-plus.fr)
*ID 485050 - 489999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 490000 - 490049: VOLD (https://vold.lu)
*ID 490050 - 490999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 491000 - 491049: NORD ERP CRM (https://www.nord-erp-crm.fr/)
*ID 491050 - 491099: KJR-online (https://kjr-online.fr/)
*ID 491100 - 491149: eNova
*ID 491150 - 491199: App 4 Business
*ID 491200 - 491249: Mil24 (http://www.mil24.com.py)
*ID 491250 - 491299: M2AM
*ID 491300 - 491349: luigifab (https://github.com/luigifab), also reuse id:105009 for Sentry fork
*ID 491350 - 491399: Frédéric France (https://github.com/frederic34)
*ID 491400 - 491449: E-dem (https://www.e-dem.com/)
*ID 491450 - 491499: Burofree (https://burofreeai.es)
*ID 491500 - 491549: EMDELEN (https://emdelen.fr/)
*ID 491550 - 491599: eSoUrCeS Technologie (https://techno.esources.ca/) - Canada
*ID 491600 - 491649: GoSouce Peru - Peru
*ID 491650 - 491669: Kaféin Studio (https://kafein.studio) - France
*ID 491670 - 491999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 492000 - 492999: Anura (https://www.anura.fr/)
*ID 493000 - 493050: Bourez Bastien EI (https://bastien-b.fr/)
*ID 493051 - 493100: benhmida ilyess (bhilyess98@gmail.com)
*ID 493101 - 493150 George TS, George SP (gspanos@makeasite.gr)
**
*ID 499001 - 499050: IT GENIUSES (https://www.itgeniuses.com)

DO NOT ADD RECORD HERE, PLEASE FILL HOLES FIRST !!!!
...

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

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 (20 ids at once).

Category:DisQutons

2025-11-30T00:02:45Z

Kusco: Création page

{{Flag fr}} Liste des modules développés par l'association disQutons (https://www.disQutons.fr)

Module Subventions

2025-11-29T23:59:17Z

Kusco:

[[fr:Module_Subventions FR]]


[[Category:Complementary modules]]
[[Category:disQutons]]
[[Category:Nonprofit organization]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
=Informations=
{{TemplateModuleInfo
|modulename=Suivi des subventions
|editor=[https://www.disqutons.fr disQutons]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=subventions}}
|status=stable
|minversion=V21
|note=Module disponible en français, anglais, allemand, italien et espagnol.
}}

=Fonctionnalités=
Module permettant de suivre les demandes de subventions :

*Suivi des subventions, demandes de financements, financeurs et paiements
*Possibilité d'ajouter des documents : demande, notification, convention, bilan, etc.
*Suivi des différents statuts : non déposé, déposé, accepté, refusé, financé, bilan déposé
*Statistiques par année, financeurs et groupe de financeurs
*[Module Projets] Possibilité d'ajouter les subventions à la vue d'ensemble
*[Module Tiers] Ajout d'un onglet au sein de la fiche tiers des projets

=Installation=
{{InstallModuleDoliStoreEn|keyword=subvention}}

=Paramétrage=
{{ActivationModuleEn}}

=Développement & Contributions=
Le développement de cette application Open Source n'est pas inclus dans le dépôt GIT standard de Dolibarr, mais dans un dépôt dédié aux modules non pris en charge par l'équipe de développement de Dolibarr :

*Dépôt : https://github.com/disQutons/dolibarr_module_subventions

Vos demandes de correction ou d'amélioration sont les bienvenues.

Module Subventions

2025-11-29T23:59:02Z

Kusco:

[[fr:Module_Subventions FR]]


[[Category:Complementary modules]]
[[Category:disQutons]]
[[Category:Nonprofit organization]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
=Informations=
{{TemplateModuleInfo
|modulename=Suivi des subventions
|editor=[https://www.disqutons.fr disQutons]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=subventions}}
|status=stable
|minversion=V21
|languages=Module disponible en français, anglais, allemand, italien et espagnol.
}}

=Fonctionnalités=
Module permettant de suivre les demandes de subventions :

*Suivi des subventions, demandes de financements, financeurs et paiements
*Possibilité d'ajouter des documents : demande, notification, convention, bilan, etc.
*Suivi des différents statuts : non déposé, déposé, accepté, refusé, financé, bilan déposé
*Statistiques par année, financeurs et groupe de financeurs
*[Module Projets] Possibilité d'ajouter les subventions à la vue d'ensemble
*[Module Tiers] Ajout d'un onglet au sein de la fiche tiers des projets

=Installation=
{{InstallModuleDoliStoreEn|keyword=subvention}}

=Paramétrage=
{{ActivationModuleEn}}

=Développement & Contributions=
Le développement de cette application Open Source n'est pas inclus dans le dépôt GIT standard de Dolibarr, mais dans un dépôt dédié aux modules non pris en charge par l'équipe de développement de Dolibarr :

*Dépôt : https://github.com/disQutons/dolibarr_module_subventions

Vos demandes de correction ou d'amélioration sont les bienvenues.

Module Subventions

2025-11-29T23:58:28Z

Kusco:

[[fr:Module_Subventions FR]]


[[Category:Complementary modules]]
[[Category:disQutons]]
[[Category:Nonprofit organization]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
=Informations=
{{TemplateModuleInfo
|modulename=Suivi des subventions
|editor=[https://www.disqutons.fr disQutons]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=subventions}}
|status=stable
|minversion=V21
|note=Module disponible en français, anglais, allemand, italien et espagnol.
}}

=Fonctionnalités=
Module permettant de suivre les demandes de subventions :

*Suivi des subventions, demandes de financements, financeurs et paiements
*Possibilité d'ajouter des documents : demande, notification, convention, bilan, etc.
*Suivi des différents statuts : non déposé, déposé, accepté, refusé, financé, bilan déposé
*Statistiques par année, financeurs et groupe de financeurs
*[Module Projets] Possibilité d'ajouter les subventions à la vue d'ensemble
*[Module Tiers] Ajout d'un onglet au sein de la fiche tiers des projets

=Installation=
{{InstallModuleDoliStoreEn|keyword=subvention}}

=Paramétrage=
{{ActivationModuleEn}}

=Développement & Contributions=
Le développement de cette application Open Source n'est pas inclus dans le dépôt GIT standard de Dolibarr, mais dans un dépôt dédié aux modules non pris en charge par l'équipe de développement de Dolibarr :

*Dépôt : https://github.com/disQutons/dolibarr_module_subventions

Vos demandes de correction ou d'amélioration sont les bienvenues.

Module Subventions

2025-11-29T23:56:35Z

Kusco: Création de la page du module

[[fr:Module_Subventions FR]]
[[en:Subsidies module]]


[[Category:Complementary modules]]
[[Category:disQutons]]
[[Category:Nonprofit organization]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
=Informations=
{{TemplateModuleInfo
|modulename=Suivi des subventions
|editor=[https://www.disqutons.fr disQutons]
|web={{URLNLTechno}}
|webbuy={{LinkToPluginDownloadDoliStore|keyword=subventions}}
|status=stable
|minversion=Le module a été développé en V22, il est possible qu'il fonctionne sur des versions antérieures.
|note=
}}

=Fonctionnalités=
Module permettant de suivre les demandes de subventions :

*Suivi des subventions, demandes de financements, financeurs et paiements
*Possibilité d'ajouter des documents : demande, notification, convention, bilan, etc.
*Suivi des différents statuts : non déposé, déposé, accepté, refusé, financé, bilan déposé
*Statistiques par année, financeurs et groupe de financeurs
*[Module Projets] Possibilité d'ajouter les subventions à la vue d'ensemble
*[Module Tiers] Ajout d'un onglet au sein de la fiche tiers des projets

Module disponible en français, anglais, allemand, italien et espagnol.

=Installation=
{{InstallModuleDoliStoreEn|keyword=bittorent}}

=Paramétrage=
{{ActivationModuleEn}}

=Développement & Contributions=
Le développement de cette application Open Source n'est pas inclus dans le dépôt GIT standard de Dolibarr, mais dans un dépôt dédié aux modules non pris en charge par l'équipe de développement de Dolibarr :

*Dépôt : https://github.com/disQutons/dolibarr_module_subventions

Vos demandes de correction ou d'amélioration sont les bienvenues.

Template:TagsOdtMyCompany

2025-11-23T12:22:21Z

Kusco: Ajout {mycompany_managers}

<pre>
{mycompany_logo} : Your company logo
{mycompany_name} : Your company name
{mycompany_address} : Your company address
{mycompany_zip} : Your company zip
{mycompany_town} : Your company town
{mycompany_country} : Your company country (label)
{mycompany_country_code} : Your company country (code: FR, US, IT...)
{mycompany_state} : Your company state (label)
{mycompany_state_code} : Your company state (code)
{mycompany_managers} : Your managers/director/president
{mycompany_phone}
{mycompany_fax}
{mycompany_email}
{mycompany_web}
{mycompany_barcode}
{mycompany_capital}
{mycompany_juridicalstatus}
{mycompany_managers}
{mycompany_idprof1}
{mycompany_idprof2}
{mycompany_idprof3}
{mycompany_idprof4}
{mycompany_idprof5}
{mycompany_idprof6}
{mycompany_vatnumber} : Your company VAT number
{mycompany_object}
{mycompany_note_private} : Your company private note
</pre>

Exemple de cas pratique de Module Builder

2025-11-05T14:18:35Z

Kusco: Lowercase

=Guide début pour Module-Builder=

L’idée générale de ce cas pratique est d’utiliser l’ossature de fichiers du MODULE BUILDER et de les modifier le moins possible pour ne pas faire d’erreurs ou de bêtises.

Le module que nous allons créer :

Son rôle est d’afficher dans un calendrier les délais de livraison des commandes fournisseur sur une plage donnée à partir de la date du jour.

Il faut donc que vos commandes fournisseurs aient une Date prévue de livraison :[[File:Screen date prévue de livraison.jpg|thumb|alt=|left]] 

Cliquer sur une des commandes du calendrier vous renverra directement vers la fiche Dolibarr de la commande fournisseur concernée. Il sera disponible dans un nouvel onglet du menu principal.

On utilisera "fullcalendar" pour le calendrier https://fullcalendar.io/
[[File:Screen Calendrier.png|alt=|left|883x883px]]

 

 
==Étape 1 : Actier le module-builder dans Dolibarr==
Accueil → Configuration → Configuration - Modules/Applications → MODULE BUILDER
[[File:Screen ModuleBuilder.jpg|left|thumb]]

 

 
==Étape 2 : Créer les fichiers de base du module==
Lancer le MODULE BUILDER via l’icone en haut à droite de Dolibarr

Remplissez les champs puis cliquez sur CREER

A partir de maintenant vous devriez avoir dans le dossier « custom » un nouveau dossier au nom de votre module que je vais appeler CalendrierFournisseurs dans mon cas

[[File:Champs MB.png|left|thumb]]

 
 
 
==Étape 3 : Upload des fichiers FullCalendar==
Notre code aura besoin des bibliothèques Fullcalendar.

A l’heure de ce tuto j’utilise la dernière version 6.1.15 que vous trouverez ici https://github.com/fullcalendar/fullcalendar/releases/tag/v6.1.15

Décompressez le Zip pour avoir le dossier fullcalendar-6.1.15 comme suit : /custom/calendrierfournisseurs/fullcalendar-6.1.15
 

==Étape 4 : Création du module==
Editez le fichier « /custom/calendrierfournisseurs/calendrierfournisseursindex.php » avec le notepad ou visual studio code.

Ce fichier contiendra le contenu de notre page à afficher. Effacez le contenu et mettez-y le code suivant :<syntaxhighlight lang="php" line="1" start="1">
<?php

require '../../main.inc.php'; // Inclusion du fichier principal Dolibarr

llxHeader('', 'Calendrier Fournisseur', ''); // En-tête de Dolibarr

// Connexion à la base de données Dolibarr (utilisation des connexions intégrées à Dolibarr)
global $db;

// Récupération des configurations de plage de dates
$weeksBefore = getDolGlobalInt('CALENDRIERFOURNISSEURS_WEEKS_BEFORE', 1);
$weeksAfter = getDolGlobalInt('CALENDRIERFOURNISSEURS_WEEKS_AFTER', 4);

// Calcul de la plage de dates
$date_start = date('Y-m-d', strtotime("-$weeksBefore week"));
$date_end = date('Y-m-d', strtotime("+$weeksAfter week"));

// Afficher un titre
print "<h1>Calendrier livraisons Commandes Fournisseurs du " . date("d/m/Y", strtotime($date_start)) . " au " . date("d/m/Y", strtotime($date_end)) . "</h1>";

// Récupération des données de la base de données
$requete = "SELECT t.rowid as rowid, t.ref_supplier as ref, DATE_FORMAT(t.date_livraison, '%Y-%m-%d') as date_livraison,
t.fk_statut as statut, s.nom as nom_fournisseur
FROM llx_commande_fournisseur as t
INNER JOIN llx_societe as s ON t.fk_soc = s.rowid
WHERE t.date_livraison BETWEEN '$date_start' AND '$date_end'
AND t.fk_statut IN (1, 2, 3, 4, 5, 9)
ORDER BY t.date_livraison ASC";
$resultat = $db->query($requete);

// Préparation des données pour FullCalendar
$events = array();
while ($ligne = $resultat->fetch_assoc()) {
$backgroundColor = '';''
switch ($ligne['statut']) {
case 2: // Validée
$backgroundColor = '#bc9526'; // Marron orangé
break;
case 3: // Transmise au fournisseur
$backgroundColor = '#25a580'; // Vert
break;
case 4: // Livrée partiellement ou refusée
$backgroundColor = '#ffa07a'; // Rouge clair
break;
case 5: // Totalement livrée
$backgroundColor = '#cad2d2'; // Gris clair
break;
}

$events[] = array(
'title' => mb_convert_encoding($ligne['nom_fournisseur'], 'UTF-8') . ' - ' . mb_convert_encoding($ligne['ref'], 'UTF-8'),
'start' => mb_convert_encoding($ligne['date_livraison'], 'UTF-8'),
'id' => mb_convert_encoding($ligne['rowid'], 'UTF-8'),
'status' => mb_convert_encoding($ligne['statut'], 'UTF-8'),
'url' => '../../fourn/commande/card.php?id=' . mb_convert_encoding($ligne['rowid'], 'UTF-8'),
'backgroundColor' => $backgroundColor
);
}

// Conversion en JSON
$json_events = json_encode($events);
?>

<!DOCTYPE html>
<html lang="fr">
<head>
<meta charset="UTF-8">
<title>Calendrier Fournisseur</title>
<script src='../../custom/calendrierfournisseurs/fullcalendar-6.1.15/dist/index.global.js'></script>
<script src='../../custom/calendrierfournisseurs/fullcalendar-6.1.15/packages/core/locales/fr.global.js'></script>
<script>
document.addEventListener('DOMContentLoaded', function() {
var calendarEl = document.getElementById('calendar');
var calendar = new FullCalendar.Calendar(calendarEl, {
initialView: 'dayGridMonth',
locale: 'fr',
weekNumbers: true,
height: 'auto',
headerToolbar: {
left: 'prev,next today',
center: 'title',
right: 'dayGridMonth,timeGridWeek,timeGridDay,listWeek'
},
events: <?php echo $json_events; ?>,
eventContent: function(arg) {
return {
html: arg.event.title.split(' - ')[0] + ' ' + arg.event.title.split(' - ')[1]
};
}
});
calendar.render();
});
</script>
<style>
html, body {
overflow: hidden;
font-family: Arial, Helvetica Neue, Helvetica, sans-serif;
font-size: 14px;
}
#calendar-container {
position: fixed;
top: 0;
left: 0;
right: 0;
bottom: 0;
}
.fc-header-toolbar {
padding-top: 1em;
padding-left: 1em;
padding-right: 1em;
}
</style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" style="width:800px">
<tr>
<td style="background-color:#bc9526; width:50px"> </td>
<td>Commande Approuvée</td>
<td style="background-color:#25a580; width:50px"> </td>
<td>Commande Transmise au fournisseur</td>
<td style="background-color:#ffa07a; width:50px"> </td>
<td>Commande livrée partiellement ou refusée</td>
<td style="background-color:#cad2d2; width:50px"> </td>
<td>Commande totalement livrée</td>
</tr>
</table>

<div id="calendar"></div>
</body>
</html>

<?php
llxFooter(); // Pied de page Dolibarr
?>
</syntaxhighlight>

==Étape 5 : Page de configuration du module==
Editez le fichier « /custom/calendrierfournisseurs/admin/setup.php» avec le notepad ou visual studio code ou directement depuis le module builder.

Ce fichier contiendra le contenu de notre page de configuration du module à afficher.

Supprimez (ou mettez en commentaire avec /* et */) les données d’exemple soient les lignes 102 à 166 de la zone commençant par le commentaire :<syntaxhighlight lang="PHP">
// Enter here all parameters in your setup page
</syntaxhighlight>Ajouter le code suivant :<syntaxhighlight lang="PHP">
// Setup conf for selection of weeks before current date to display in calendar
$item = $formSetup->newItem('CALENDRIERFOURNISSEURS_WEEKS_BEFORE');
$item->defaultFieldValue = '1'; // Valeur par défaut de 1 semaine avant
$item->fieldAttr['placeholder'] = 'Nombre de semaines avant';
$item->nameText = $langs->trans('Nombre de semaines avant'); // Langue pour l'étiquette

// Setup conf for selection of weeks after current date to display in calendar
$item = $formSetup->newItem('CALENDRIERFOURNISSEURS_WEEKS_AFTER');
$item->defaultFieldValue = '4'; // Valeur par défaut de 4 semaines après
$item->fieldAttr['placeholder'] = 'Nombre de semaines après';
$item->nameText = $langs->trans('Nombre de semaines après'); // Langue pour l'étiquette
</syntaxhighlight>

==Étape 6 : Activer le module==
Directement dans le MODULE BUILDER, activez le module et allez sur la roue crantée pour configurer la plage de dates que calendrier doit afficher :

*Nombre de semaines avant : nombre de semaines avant la date du jour
*Nombre de semaines après : nombre de semaines après la date du jour

Normalement, après cette étape le calendrier devrait s’afficher quand on clique sur le bouton de l’onglet principal

Hook completeListOfReferent

2025-10-22T10:50:19Z

Kusco:

[[Category:Hooks]]
Le Hook completeListOfReferent permet d'afficher les informations dans l'onglet vue d'ensemble d'un projet.

Voici un exemple de création d'un module qu'on appelerait "Subventions".

Dans votre de déclaration de Hook (class/actions_nomModule.class.php) :<syntaxhighlight lang="php" line="1">

require_once DOL_DOCUMENT_ROOT.'/custom/subventions/class/subvention.class.php';

/*
* Hook pour afficher des informations dans l'onglet vue d'ensemble d'un projet
*/
public function completeListOfReferent($parameters, &$object, &$action) {
global $conf, $user, $langs;

if ($object->element == 'project'){
$this->results = array(
'subvention' => array(
'name' => "Subventions",
'title' => "ListSubventionsAssociatedProject",
'class' => 'Subvention',
'table' => 'subventions_subvention',
'datefieldname' => 'date_creation',
'margin' => 'add', // add si c'est en plus, minus si c'est en moins, rien si ça ne rentre pas dans le calcul de bénéfice
'project_field' => 'fk_project', // facultatif si le nom de ta colonne est fk_project
'url' => DOL_URL_ROOT.'/custom/subventions/subvention_list.php?fk_project='.$object->id, // URL pour lister les subventions
'urlnew' => DOL_URL_ROOT.'/custom/subventions/subvention_card.php?action=create&origin=project&originid='.$id.'&backtopage='.urlencode($_SERVER['PHP_SELF'].'?id='.$id),
'lang' => 'subventions',
'buttonnew' => 'AddSubvention',
'testnew' => $user->hasRight('subventions', 'subvention', 'write'),
'test' => isModEnabled('subventions') && $user->hasRight('subventions', 'subvention', 'read'),
),
);
return 0;
}
}
</syntaxhighlight>

Comme vous devez le remarquer, à aucun moment, nous n'indiquons le montant.

Tout ceci est précisé directement dans le fichier '''element.php''' dans la gestion des projets.

Pour éviter de modifier ce fichier, on peut gérer les montants autrement en créant ces champs dans ta table :

*'''total_ttc'''

*'''total_ht'''

Hook completeListOfReferent

2025-10-22T10:49:55Z

Kusco:

[[Category:Hooks]]
Le Hook completeListOfReferent permet d'afficher les informations dans l'onglet vue d'ensemble d'un projet.

Voici un exemple de création d'un module qu'on appelerait "Subventions".

Dans votre de déclaration de Hook (class/actions_nomModule.class.php) :<syntaxhighlight lang="php" line="1">

require_once DOL_DOCUMENT_ROOT.'/custom/subventions/class/subvention.class.php';

/*
* Hook pour afficher des informations dans l'onglet vue d'ensemble d'un projet
*/
public function completeListOfReferent($parameters, &$object, &$action) {
global $conf, $user, $langs;
if ($object->element == 'project'){
$this->results = array(
'subvention' => array(
'name' => "Subventions",
'title' => "ListSubventionsAssociatedProject",
'class' => 'Subvention',
'table' => 'subventions_subvention',
'datefieldname' => 'date_creation',
'margin' => 'add', // add si c'est en plus, minus si c'est en moins, rien si ça ne rentre pas dans le calcul de bénéfice
'project_field' => 'fk_project', // facultatif si le nom de ta colonne est fk_project
'url' => DOL_URL_ROOT.'/custom/subventions/subvention_list.php?fk_project='.$object->id, // URL pour lister les subventions
'urlnew' => DOL_URL_ROOT.'/custom/subventions/subvention_card.php?action=create&origin=project&originid='.$id.'&backtopage='.urlencode($_SERVER['PHP_SELF'].'?id='.$id),
'lang' => 'subventions',
'buttonnew' => 'AddSubvention',
'testnew' => $user->hasRight('subventions', 'subvention', 'write'),
'test' => isModEnabled('subventions') && $user->hasRight('subventions', 'subvention', 'read'),
),
);
return 0;
}
}
</syntaxhighlight>

Comme vous devez le remarquer, à aucun moment, nous n'indiquons le montant.

Tout ceci est précisé directement dans le fichier '''element.php''' dans la gestion des projets.

Pour éviter de modifier ce fichier, on peut gérer les montants autrement en créant ces champs dans ta table :

*'''total_ttc'''

*'''total_ht'''

Hook completeListOfReferent

2025-10-22T10:49:34Z

Kusco: Création complète de la page

[[Category:Hooks]]
Le Hook completeListOfReferent permet d'afficher les informations dans l'onglet vue d'ensemble d'un projet.

Voici un exemple de création d'un module qu'on appelerait "Subventions".

Dans votre de déclaration de Hook (class/actions_nomModule.class.php) :<syntaxhighlight lang="php" line="1">

require_once DOL_DOCUMENT_ROOT.'/custom/subventions/class/subvention.class.php';
/*
* Hook pour afficher des informations dans l'onglet vue d'ensemble d'un projet
*/
public function completeListOfReferent($parameters, &$object, &$action) {
global $conf, $user, $langs;
if ($object->element == 'project'){
$this->results = array(
'subvention' => array(
'name' => "Subventions",
'title' => "ListSubventionsAssociatedProject",
'class' => 'Subvention',
'table' => 'subventions_subvention',
'datefieldname' => 'date_creation',
'margin' => 'add', // add si c'est en plus, minus si c'est en moins, rien si ça ne rentre pas dans le calcul de bénéfice
'project_field' => 'fk_project', // facultatif si le nom de ta colonne est fk_project
'url' => DOL_URL_ROOT.'/custom/subventions/subvention_list.php?fk_project='.$object->id, // URL pour lister les subventions
'urlnew' => DOL_URL_ROOT.'/custom/subventions/subvention_card.php?action=create&origin=project&originid='.$id.'&backtopage='.urlencode($_SERVER['PHP_SELF'].'?id='.$id),
'lang' => 'subventions',
'buttonnew' => 'AddSubvention',
'testnew' => $user->hasRight('subventions', 'subvention', 'write'),
'test' => isModEnabled('subventions') && $user->hasRight('subventions', 'subvention', 'read'),
),
);
return 0;
}
}
</syntaxhighlight>

Comme vous devez le remarquer, à aucun moment, nous n'indiquons le montant.

Tout ceci est précisé directement dans le fichier '''element.php''' dans la gestion des projets.

Pour éviter de modifier ce fichier, on peut gérer les montants autrement en créant ces champs dans ta table :

* '''total_ttc'''

* '''total_ht'''

Système de Hooks

2025-08-25T08:42:26Z

Kusco: Correction de la syntaxe déclarative.

[[en:Hooks_system]]
[[es:El_sistema_Hooks]]
[[de:System_von_Hooks]] ]]
[[zh:钩子系统]]


{{TemplateDocDevFr}}

=Introduction=
Les Hooks (crochet en anglais, dans le sens de détour) sont une fonctionnalité destinée aux développeurs, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier le ''core'' de Dolibarr. Contrairement au [[Système de Triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe où et à n'importe quel moment dès lors qu'ils ont été prévus dans le ''core'' de Dolibarr. Ce sont des points d'insertion dans le programme.

*Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
*Les Hooks sont des fonctions qui s'insèrent dans ou remplacent le code standard. Pour rechercher le code qu'il est possible de surcharger faites une recherche pour "'''executeHooks('''".

=Ajouter un hook pour permettre l'insertion de code=
Pour implémenter un hook dans Dolibarr ou dans votre propre module (afin que votre module puisse être "crocheté", "détourné" par d'autres), vous devrez procéder en 2 étapes.

Ces étapes doivent êtres reproduites pour chaque script php dans lequel vous voulez implémenter des hooks.

1- Initialiser l'object HookManager

Pour une page, placez ce bout de code au début de votre script php (après le ''include'' du ''main''):

<syntaxhighlight lang="PHP">
// Initialize technical object to manage hooks of thirdparties. Note that conf->hooks_modules contains array array
include_once(DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php');
$hookmanager=new HookManager($db);
$hookmanager->initHooks(array('context'));
</syntaxhighlight>

$hookmanager->initHooks() accepte 1 paramètre (un array de contextes) et active la prise en charge des hooks pour ce script. '<nowiki/>'''context'''' est la chaine qui contient le contexte d'exécution. C'est un simple indicateur qui peut être utilisé par les fonctions de hook pour détecter dans quel cas elles sont appelées (plusieurs pages/modules peuvent appeler le même hook à différent endroit, et une fonction de hook peut ne vouloir s'exécuter que pour un contexte donné et pas les autres).

Note: Vous pouvez positionner plusieurs contextes en même temps (par exemple si vous avez besoin d'avoir un contexte commun à plusieurs pages mais que vous voulez aussi un contexte propre à une page donnée).

Pour une méthode ou fonction, il est possible de récupérer le gestionnaire de Hook par:

<syntaxhighlight lang="PHP">
global $hookmanager;
</syntaxhighlight>

2- Placer ensuite l'appel des hooks là où la possibilité d'insertion de code est désirée :

<syntaxhighlight lang="PHP">
$parameters=array();
$reshook=$hookmanager->executeHooks('hookname',$parameters,$object,$action); // See description below
// Note that $action and $object may have been modified by hook
if (empty($reshook))
{
... // standard code that can be disabled/replaced by hook if return code > 0.
}
</syntaxhighlight>

'''$hookmanager->executeHooks()''' accepte 4 paramètres et ajoute un hook (qui est un point d'entrée dans votre script pour des fonctions externes à votre script et module):

- '<nowiki/>'''hookname'''' est le nom de la méthode qui sera appelée. Par exemple: 'formObjectOptions'

- '''$parameters''' est un tableau personnalisé pour transmettre plus de données personnalisées au hook (la fonction dans le hook peut traiter ces données). Placez ici ce que vous voulez, ce peut être un fichier, un tableau de chaînes de caractères, n'importe quoi... Par exemple :
<syntaxhighlight lang="PHP">
$parameters=array('file'=>'my/path/to/a/file', 'customnames'=>array('henry','david','john'));
</syntaxhighlight>

- '''$object''' est l'objet que vous voulez passer à la fonction du hook, certainement les données du module courant (ex: l'objet facture si on est dans un module de facture, etc..). Ce peut être ce que vous voulez, mais souvenez vous qu'il sera le principal composant utilisé par les fonctions du hook.

- '''$action''' est une chaîne indiquant l'action courante (peut être ''null'' ou quelque chose qui ressemble à 'create' ou 'edit').

Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.

Maintenant votre module devrait pouvoir exécuté des hooks d'autres origines. Vous pouvez à présent suivre la procédure ci-dessous ( '''Implémenter un hook''' ) pour construire une fonction qui se raccrochera au hook (permet aussi de tester que cela fonctionne).

=Implémenter un Hook=
Pour utiliser un Hook (donc insérer ou surcharger une partie de code), vous devez d'abord avoir défini un descripteur de module (voir [[Développement_module#Créer_un_descripteur_de_Module_(obligatoire)]] pour cela). Ensuite vous devez suivre les étapes suivantes :

1. Ajouter votre module au contexte où le hook doit s'exécuter.
Ce qui veut dire que lorsqu'on se trouve dans le contexte donné, votre code sera appelé.
Pour cela, éditer le descripteur de votre module ('''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''') et renseignez la variable '''$this->module_parts''' comme sur l'exemple :
<syntaxhighlight lang="PHP">
$this->module_parts = array(
'hooks' => array(
'data' => array(
'hookcontext1',
'hookcontext2',
),
'entity' => '0',
),
);
</syntaxhighlight>

Note: il est possible de trouver tous les contextes dans lequel vous êtes au sein d'une portion de code PHP en faisant
<syntaxhighlight lang="PHP">
print('Module context: '.join(',', $object->contextarray));
</syntaxhighlight>
(rajoutez ce bout de code dans le fichier PHP où réside l'appel des hooks, et supprimez le, une fois la valeur des contextes relevée).

Notez que le contexte '''all''' signifie que vous souhaitez que votre hook soit exécuté quel que soit le contexte. Le '''main''' signifie que vous voulez que votre hook soit exécuté pour n'importe quelle page Web, et '''cli''' signifie dans chaque script de ligne de commande (même si vous ne pouvez pas voir ces clés de contexte dans $object->contextarray).

[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules (ou directement dans le "constructeur de module") afin que la modification soit prise en compte, car l'enregistrement qui relie les éléments du couple "module-hook" est géré en base de donnée; celle-ci n'étant mise à jour qu'au moment de la (ré)activation du module.

2. Pour remplacer une fonction existante par la votre (surcharge)

Créez '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' dans votre module avec un code qui contient la méthode appelée par le hook (le nom de cette méthode se voit au moment de l'appel executeHooks). Voici un exemple:

<syntaxhighlight lang="PHP">
class ActionsYourModuleName
{
/**
* Overloading the doActions function : replacing the parent's function with the one below
*
* @param array() $parameters Hook metadatas (context, etc...)
* @param CommonObject &$object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
* @param string &$action Current action (if set). Generally create or edit or null
* @param HookManager $hookmanager Hook manager propagated to allow calling another hook
* @return int < 0 on error, 0 on success, 1 to replace standard code
*/
function doActions($parameters, &$object, &$action, $hookmanager)
{
$error = 0; // Error counter
$myvalue = 'test'; // A result value

print_r($parameters);
echo "action: " . $action;
print_r($object);

if (in_array('somecontext', explode(':', $parameters['context'])))
{
// do something only for the context 'somecontext'
}

if (! $error)
{
$this->results = array('myreturn' => $myvalue);
$this->resprints = 'A text to show';
return 0; // or return 1 to replace standard code
}
else
{
$this->errors[] = 'Error message';
return -1;
}
}
}
</syntaxhighlight>

La méthode sera alors automatiquement appelée au moment de l'appel du code qui contient le executeHooks fournissant à votre code les éléments $parameters, $object et $action.

'''Avec''' :

*'''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas)
*'''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard)
*'''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view").
*'''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks. 

'''Retours de fonction''' :

*Le code retour d'un hook doit être 0 ou 1 en cas de succès, négatif en cas d'erreur. En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. Si le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur'
*Si la méthode positionne la propriété $this->results avec un tableau, alors le tableau $hookmanager->resArray sera automatiquement enrichi avec le contenu de ce tableau, lequel pourra être réutilisé plus tard.
*Si la méthode positionne la propriété $this->resprints avec une chaîne, alors cette chaîne sera affiché par le gestionnaire de hook (executeHook), tout de suite à la sortie de votre méthode.
*Votre hook peut de plus modifier les valeurs de $object et $action.

=Liste des Hooks disponibles dans Dolibarr=
Trouver les hooks disponibles dans Dolibarr ?
Faites une recherche sur "'''executeHooks('''" dans le code source et vous trouverez facilement toutes les fonctions déjà implémentées.

En voici une liste (non complète) : [[:Category:Hooks]]
...

Note: veuillez noter que cette liste s'enrichit à chaque version, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.

=Liste des Contextes disponibles dans Dolibarr=
Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.
Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.

{{ListOfContexts}}

Note: veuillez noter que cette liste s'enrichie à chaque version, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.

=Voir aussi=

*[[Triggers]]
*[[Interfaces Dolibarr toward foreign systems]]
*[[Interfaces from foreign systems toward Dolibarr]]

List of modules id

2025-08-11T10:03:25Z

Kusco: /* ID 100000 - 499999 */ Ajout Kusco 173321

{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}
{{TemplateDocDevZh}}

This page list all reserved modules numbers / ID.

If you build or want to build your own modules, you should take an ID range here. Please pick range into existing holes first.

=ID 0 - 94999=
This range is reserved for Dolibarr's internal core modules, so all modules available into the standard distribution at https://github.com/Dolibarr/dolibarr

=ID 95000 - 99999=
This range is reserved for Dolibarr's community modules availble on the github repository: https://github.com/Dolibarr/dolibarr-community-modules

=ID 100000 - 499999=

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, ask us for more)

[[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) - Belgium
*ID 101000 - 101999: NLTechno (https://www.nltechno.com) - France
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr) - France
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro) - France
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr) - France
*ID 105000 - 105999: GPC.solutions - France
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net) - France
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Aplose ([http://www.aplose.fr https://www.aplose.fr]) - France
*ID 110000 - 110999: Association Dolibarr (https://www.dolibarr.org)
*ID 111000 - 111999: Asset IT (www.assetit.ch) - Suisse
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch) - Suisse
*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) - France
*ID 121000 - 121999: Oscss - Shop - France
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: 7reasons s.r.l. (www.7reasons.eu) - Austria
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br) - Brazil
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu) - Italy
*ID 131000 - 131999: Joan Louis (itaca.fr) - France
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr) - France
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 134000 - 134999: ALSOFT PVT. LTD. (https://www.alsoft.org)
*ID 135000 - 135999: Net-Logic (https://netlogic.fr)
*ID 136000 - 136050: MONA.RE - France
*ID 136051 - 136099: La Vida Marketing
*ID 136100 - 136149: Synergies-Tech France. (https://www.synergies-france.fr/)
*ID 136150 - 136199: Lyta
*ID 136200 - 136219: Maison Théophile Leclerc
*ID 136220 - 136270: SegoFount - Spain
*ID 136271 - 136320: Labor Dispatch (Simon Sheng , China)
*ID 136321 - 136370: MB Informatique (https://www.mb-informatique.fr)
*ID 136371 - 136420: Daxit Solutions (https://www.daxit.be)
*ID 136421 - 136470: HUSCH GmbH (https://husch-gmbh.de)
*ID 136471 - 138999: NSINFO (https://www.ns-info.fr)
*ID 139000 - 139999: Synergies-Tech France. (https://www.synergies-france.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: Mainlab S.r.l. (https://www.mainlabonline.it) - Italy
*ID 141200 - 141249: Florian DUFOURG - France
*ID 141250 - 141299: SoftAddicts - Canada
*ID 141300 - 141349: Finanboo - (https://www.finanboo.com)
*ID 141350 - 141399: ConstruxZion Soft - Colombia (https://www.construxzionsoft.com.co)
*ID 141400 - 141450: COEXDIS - République Démocratique du Congo (https://www.coexdis.com)
*ID 141451 - 141501: HALFWARE - Algeria (https://www.half-ware.com)
*ID 141502 - 141552: Quantraum (https://quantraum.com)
*ID 141553 - 141603: Nateo Group
*ID 141604 - 141653: digital centric GmbH (https://www.digitalcentric.de/dolibarr)
*ID 141654 - 141699: Decrypting (https://www.decrypting.fr)
*ID 141700 - 141749: Zeise IT Consulting - Germany (https://www.zeise-it.de)
*ID 141750 - 141799: Data Rooster - France (https://datarooster.io)
*ID 141800 - 141849: IP Développement (https://www.ipdeveloppement.fr)
*ID 141850 - 141899: MSICCA | MRVL Soluciones de Ingeniería y Construcción, c.a (https://msicca.com)
*ID 141900 - 141949: THERSANE (https://www.thersane.fr)
*ID 141950 - 141999: MB Informatique (https://www.mb-informatique.fr)
*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 142100 - 142149: Bloxera GmbH (https://www.bloxera.com)
*ID 142150 - 142199: Evangelos Souglakos - Greece
*ID 142200 - 142249: Luc CALARESU - France
*ID 142250 - 142299: OmnIT Services - Belgique (https://www.omnitservices.biz)
*ID 142300 - 142349: Gwadeyes - Guadeloupe (https://www.gwadeyes-informatique.com/)
*ID 142350 - 142399: Solution Libre (https://www.solution-libre.fr/)
*ID 142400 - 142449: Res Digital (https://res.digital)
*ID 142450 - 142499: itopie informatique (https://www.itopie.ch)
*ID 142500 - 142549: Weblinx.IT GbR (https://weblinx.it/) - Germany
*ID 142550 - 142599: ASCI-Automation - Mexico (https://asci-automation.com.mx/)
*ID 142600 - 142649: ZENKO Design - Japan / France / Spain
*ID 142650 - 142699: AWeerWolf
*ID 142700 - 148749: Lysis (https://lysis.net/)
*ID 142750 - 142799: Hadritech (https://www.hadritech.com/)
*ID 142800 - 142849: Bloxera GmbH (https://www.bloxera.com)
*ID 142850 - 148999: Everlats S.L. - España (https://www.everlats.com)
*ID 149000 - 149999: SydTech - America Central (https://www.sydtech.io/)
*ID 150000 - 150999: Jeffinfo
*ID 151000 - 151999: Konverseo (https://konverseo.com)
*ID 152000 - 152049: Tanguy Pénet (http://tanguype.net)
*ID 152050 - 152099: Web Solutions
*ID 152100 - 152149: MagicNet (https://www.magicnet.it)
*ID 152150 - 152199: Benjamin Falière (https://www.faliere.com)
*ID 152200 - 152249: Solauv
*ID 152250 - 156499: TecnoGestión Principado S.L. (https://www.tecnogestion.com) - Asturias - España
*ID 156500 - 156549: ACE Recycling (https://www.acerecycling.net.au/)
*ID 156550 - 156599: Kreativität Works ([http://www.kreativitat.com http://kreativitat.com])
*ID 156600 - 156649: [https://pierre-couy.dev Pierre Couy]
*ID 156650 - 156699: CXI (https://cyrix.co.za)
*ID 156700 - 156749: Mustafa Kemerci - Turkiye
*ID 156750 - 156799: [https://de-grandpre.quebec de Grandpré Technologies] - Québec (Canada)
*ID 156800 - 156849: Draceo
*ID 156850 - 156899: Valleiweb
*ID 156900 - 159949: NEOVIAQ Advisory LU(https://www.neoviaq.com)
*ID 159950 - 159999: Arve et Giffre INFOGESTION (https://www.ag-infogestion.fr)
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (https://01consulting.eu)
*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 165151 - 165199: NUM'X (https://www.numx-sets.eu)
*ID 165200 - 165249: Benjam Préjent (https://www.benjam-prejent.fr)
*ID 165250 - 165299: Dhi Loka Private Limited, India (https://www.dhiloka.com)
*ID 165300 - 169999: Accellier Limited (https://www.accellier.com/)
*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 172800 - 172849: E-Concept Applications (https://e-concept-applications.fr)
*ID 172850 - 172899: B&R Stamm UG (https://stamm-ug.de)
*ID 172900 - 172949: Dolipive, support@dolipive.fr, www.dolipive.fr
*ID 172950 - 172999: CKD-Industrie (https://ckd-industrie.com/) - France
*ID 173000 - 173049: Aneosys (https://aneosys.fr) - France
*ID 173050 - 173099: Sebastian Schloßer - Germany
*ID 173100 - 173149: TecnoSoluciones (https://tecnosoluciones.com)
*ID 173150 - 173199: Digitalworks (https://www.digitalworks.fr) - France
*ID 173200 - 173249: UNi.D Consulting (https://www.unid-consulting.fr) - France
*ID 173250 - 173299: NetworkDigital(https://www.networkdigital.fr) - France
*ID 173300 - 173300: Módulo VeriFactu Dolibarr (https://verifactudolibarr.es/) - España
*ID 173301 - 173320: Sibanet (https://sibanet.net) - España
*ID 173321 - 173340: [https://www.dolibarr.fr/forum/u/kusco/summary Kusco]
*ID 173341 - 179999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 182050 - 182070: Herolapse (https://herolapse.com/)
*ID 182061 - 182999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 184000 - 184999: DPS PRINTING & DOCUMENTS SOCIEDAD ANONIMA (https://www.dps-lat.com)
*ID 185000 - 185049: Telioskour (https://github.com/telioskour)
*ID 185050 - 185099: Moko Consulting ([[Moko Consulting]] || https://mokoconsulting.tech)
*ID 185100 - 185149: Sinabe (https://sinabe.ch) - Suisse
*ID 185150 - 189999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 192000 - 192049: IDFOR Consulting (https://www.idfor-consulting.fr/)
*ID 192050 - 198999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 207400 - 207449: Arthur LENOBLE
*ID 207450 - 207499: Vaicop SAS de CV (México)
*ID 207500 - 212099: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 212100 - 212149: Audio Vidéo Technologies (https://www.avtek.fr)
*ID 212150 - 213999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 214000 - 214049: X-Boss
*ID 214050 - 221999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 220000 - 220050: Apex Tech (https://apextechmods.com)
*ID 220051 - 220100: Technology Xchange Solutions (https://www.txscorp.com)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 223000 - 223049: Tráfico Canada
*ID 223050 - 223099 : VLTN (https://vltn.sh)
*ID 223100 - 229949: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 229950 - 229999: Solucions Informàtiques, Serveis i Innovació SLU (https://6innova.es)
*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 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230499: Chickenforce/code-chicken, IT Services Hahn (https://github.com/code-chicken [http://itservices-hahn.de/ https://itservices-hahn.de])
*ID 230500 - 230549: Hidup Consulting (https://consulting.hidup.io)
*ID 230550 - 230599 : CMR Conseil (https://www.weblockup.fr)
*ID 230600 - 230649 : aFreeMind Studio
*ID 230650 - 230699 : Unideal (https://www.uni-deal.com)
*ID 230700 - 230749 : DevLansdes (https://devlandes.com/)
*ID 230750 - 262699: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 262700 - 262799: Scopen (https://www.scopen.fr)
*ID 262800 - 262849: Christophe BATTAREL EI
*ID 262850 - 271799: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 271800 - 271849: bee solutions sàrl (Switzerland)
*ID 271850 - 274199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 274200- 274249: Mathilde MAROCCO (https://mminformatique.fr)
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350 - 274399: Milen karaganski (https://blacktiehost.com)
*ID 274400 - 274449: Vincent MAURY ([https://www.timgroup.fr www.timgroup.fr])
*ID 274450 - 274499: Daraelmin
*ID 274500 - 274549: Emilie LAFORET (http://www.ermvallon.com)
*ID 274550 - 278999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 279000 - 279049: VSDigital Electronics (https://vsdigital.ar) - Argentina
*ID 279050 - 279999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 280000 - 280049: Bingroup (https://www.beinng.com)
*ID 280050 - 280099: Medialta (https://medialta.com)
*ID 280100 - 280149: Cédric Ancelin - Ancode (https://www.dolistore.com/fr/recherche?search_query=ancode)
*ID 280150 - 289999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 290000 - 290099: BNS - Project doliBRA ([https://www.beinng.com https://www.bns.net.br]) - Brasil
*ID 290100 - 299999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 300000 - 300049: RapidProgress (https://www.rapidprogress.eu) - Bulgaria
*ID 300050 : 300099: M@ Solution (https://www.ma-solution.fr/)
*ID 300100 : 300149: LAVA RUN (https://www.lavarun.re)
*ID 300150 - 300199: PsyCrow Code
*ID 300200 : 300249 : Computences (https://www.computences.com/)
*ID 300250 : 300299 : LEVEL IT (https://levelit.com.ar)
*ID 300300 : 300349 : Progiseize (https://progiseize.fr)
*ID 300350 - 300399: MB Informatique (https://www.mb-informatique.fr)
*ID 300400 - 300449: Anouar Touati
*ID 300450 - 300499: Martin Danger
*ID 300500 - 301499: Whale Blows
*ID 301500 - 301549: Tom Trust - International
*ID 301550 - 301599: MB Informatique (https://www.mb-informatique.fr)
*ID 301600 - 302499: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 302500 - 302549: Diamubi (https://diamubi.com)
*ID 302550 - 302599: Datolab (https://www.datolab.com)
*ID 302600 - 302649: DuMaCo (https://www.dumaco.de)
*ID 302650 - 302699: Resilio SA
*ID 302700 - 302749: Aroga
*ID 302750 - 302799: Productivix (https://www.productivix.com)
*ID 302800 - 302849: Slibzz
*ID 302850 - 302899: idea design (https://ideadesign.dz)
*ID 302900 - 302949: AL MISBAH INFORMATIQUE (https://www.almisbah.ma)
*ID 302950 - 302999: Atis Solutions - France
*ID 303000 - 303499: Obixav - Nigeria
*ID 303500 - 303549: buschler plus GmbH, Germany (https://buschler.plus)
*ID 303550 - 303599: Prestalidaire - France (https://prestalidaire.com)
*ID 303600 - 309999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 310000 - 310049: Neilson Dufour (<nowiki>https://hypercode.ca</nowiki>)
*ID 310050 - 313999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 314000 - 314049: Ruemmler IT Solutions (https://www.ruemmler.net)
*ID 314050 - 314149: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 314150 - 314199: Benoît PASCAL
*ID 314200 - 319999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 322000 - 322049: Doymer Consultores
*ID 322050 - 329999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 331999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 - 332149: Agence Milkshake (http://agencemilkshake.com)
*ID 332150 - 332199: Daniel Prowald IT – Service (https://prowald-it.de)
*ID 332200 - 332249: UNITICE (https://unitice.com)
*ID 332250 - 332299: Sidonie Moulart
*ID 332300 - 332349: LTDJ (Antonin MARCHAL - Le Temple du Jeu)
*ID 332350 - 333299: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 333300 - 333349: Sense Africa (http://sense.africa)
*ID 333350 - 349999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 350000 - 350049: SOUNDOU & MIDAS (https://www.soundou.org/)
*ID 350050 - 350099: Ildefonso González (https://igontek.es)
*ID 350100 - 350149: 7Kas Servicios de Internet, S.L. (https://7kas.com)
*ID 350150 - 350999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 351000 - 351049: P'tite Tête (https://ptitetete.com) - France
*ID 351050 - 398999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 359000 - 359049: Milen Karaganski0
*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
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 406000 - 406999: Som Núvol (https://somnuvol.coop)
*ID 407000 - 408999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 409000 - 409999: LliureTIC (https://www.lliuretic.cat)
*ID 410000 - 410999: DoliGov
*ID 411000 - 411049: GATTEK SARL (https://www.ga-ttek.com)
*ID 411050 - 419999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 421200 - 422199: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423049: cyberesprit
*ID 423050 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 423200 - 423299: Pragma-tech (www.pragma-tech.fr)
*ID 423299 - 423999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 424000 - 424049: Philazerty ([https://www.philazerty.fr www.philazerty.fr])
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 - 424999: Lab51 (https://github.com/lab51org)
*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 - 426999: Bruno Caldas (https://github.com/BCaldas)
*ID 427000 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 428100 - 428199: Arnaud Serrut - Adalon
*ID 428200 - 428249: imschweiler consulting (http://www.imschweiler-consulting.de'''<nowiki/>''')
*ID 428250 - 428299: AL1FO
*ID 428300 - 428349: Federico García-Patiño Barbolani (<federico.garcia.patino@gmail.com>)
*ID 428350 - 428399: INTM Groupe - France (www.intm.com)
*ID 428400 - 428449: Nick Fragoulis - Greece
*ID 428450 - 428499: Kontava - France ([https://www.kontava.fr www.kontava.fr)]
*ID 428500 - 428549: hkwhitten - USA
*ID 428550 - 428999: SmartOne
*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 435400 - 435999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 - 436300: TDE-INFORMATIQUE (www.tde-informatique.fr)
*ID 436301 - 436349: Evarisk ([https://www.evarisk.com/id-module-dolibarr/ www.evarisk.com])
*ID 436350 - 436399: Eoxia ([https://www.eoxia.com/dolibarr/modules/ www.eoxia.com])
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 - 437449: Martin Neubauer - Germany
*ID 437450 - 437599: Club1click (www.club1click.es)
*ID 437600 - 437629: Coulon Vincent (https://github.com/HoverEpic)
*ID 437630 - 437649: Aytechnet (https://www.aytechnet.fr/) - François Pons
*ID 437650 - 437699: LibreMaster (https://libremaster.com) - Christophe T.
*ID 437700 - 437749: STELLAR Broadband (https://www.stellarbb.com) - U.S.A. - Philip Laycock
*ID 437750 - 437799: DIGITA.LU Ajous Solutions
*ID 437800 - 437850: iProspective (https://iprospective.fr) - Mathieu Moulin
*ID 437851 - 437900: Theobald Groupe.
*ID 437901 - 437950: Neuronnexion (http://neuronnexion.coop)
*ID 437951 - 437952: jmbc - APIA-ASSO (https://www.apia-asso.fr)
*ID 437953 - 438002: IPCZEN SARL (https://www.ipczeninformatique.fr/)
*ID 438003 - 438052: FESF IT Department (https://fesf.org.pk)
*ID 438053 - 438103: Pilot Engineering team
*ID 438104 - 438153: u2042 (https://u2042.com)
*ID 438154 - 438204: Djair E Pereira (ocultooooo@gmail.com) - Brasil
*ID 438205 - 438255: yoandm (https://yoandm.com)
*ID 438256 - 438299: PTMSoft (<nowiki>https://www.ptmsoft.fr</nowiki>)
*ID 438300 - 438399: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 445500 - 445549: X Net Systems - Egypt - (https://www.xneteg.com)
*ID 445550 - 445999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 - 460049: torvista - Spain
*ID 460050 - 460999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*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 - 468169: Commotron GmbH (https://www.commotron.com/)
*ID 468170 - '''468219''': Infans Group (franck.lauby@infans.fr)
*ID '''468175''' - '''468199''': Gaëlle Rauffet - France (kiwiscan.net)
*ID '''468200''' - 468249: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468250 - 468269: CD-Systems - France (https://www.cd-systems.fr)
*ID 468270 - 468299: Nicolas Testori
*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 468650 - 468699: J-IT - Belgique (https://www.j-it.be)
*ID 468700 - 468749: Fidesio - France (https://www.fidesio.com/)
*ID 468750 - 468799: Sgestion - Spain (http://www.sgestion.net/)
*ID 468800 - 468849: Denis JULIEN - Brasil (matrinxa@free.fr)
*ID 468850 - 468899: Mmariko - Module GED - Effios
*ID 468900 - 468949: Maazou Amadou Abdoul aziz - Maroc (yaronfada@gmail.com)
*ID 468950 - 468999: Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 469000 - 469049: John Livingston (https://github.com/JohnXLivingston/)
*ID 469050 - 469099: Macrorom ICT-services (https://macrorom.nl/)
*ID 469100 - 469149: HABOT IT - France (https://habot.it)
*ID 469150 - 469159: CaribbeanConsult.Com CCC - France Guadeloupe (https://dolibarr.ccc.gp)
*ID 469160 - 469171: GMBG - Portugal
*ID 469172 - 469199: BGi Lda - Portugal
*ID 469200 - 469949: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 469950 - 469999: Goldoweb (http://goldoweb.com)
*ID 470000 - 470999: Reindeer Digital (https://rdeer.cz)
*ID 471000 - 471099: CAP-REL (www.cap-rel.fr)
*ID 471100 - 471199: M. Morillon
*ID 471200 - 471209: Pablo Nuñez
*ID 471210 - 471249: FANEL A.Ş (https://www.fanel.com.tr) [[mail@fanel.com.tr]]
*ID 471250 - 480999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 481000 - 481999: Alhaidab-ITIS (https://alhaidab.dolibarr.sd)
*ID 482000 - 482999: Basix IT (https://www.basix.de)
*ID 483000 - 483049: SASCO SpA (https://www.sasco.cl)
*ID 483050 - 483099: WIP Engineering (https://www.wip-gmbh.com)
*ID 483100 - 483149: J.Kaiser
*ID 483150 - 483199: CodLines (https://www.codlines.com)
*ID 483200 - 483249: BleepalSoftware (https://bleepal.com)
*ID 485000 - 485049: Gest Info Service Plus (contact@gest-plus.fr)
*ID 485050 - 489999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 490000 - 490049: VOLD (https://vold.lu)
*ID 490050 - 490999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 491000 - 491049: NORD ERP CRM (https://www.nord-erp-crm.fr/)
*ID 491050 - 491099: KJR-online (https://kjr-online.fr/)
*ID 491100 - 491149: eNova
*ID 491150 - 491199: App 4 Business
*ID 491200 - 491249: Mil24 (http://www.mil24.com.py)
*ID 491250 - 491299: M2AM
*ID 491300 - 491349: luigifab (https://github.com/luigifab), also reuse id:105009 for Sentry fork
*ID 491350 - 491399: Frédéric France (https://github.com/frederic34)
*ID 491400 - 491449: E-dem (https://www.e-dem.com/)
*ID 491450 - 491499: Burofree (https://burofreeai.es)
*ID 491500 - 491549: EMDELEN (https://emdelen.fr/)
*ID 491550 - 491599: eSoUrCeS Technologie (https://techno.esources.ca/) - Canada
*ID 491600 - 491649: GoSouce Peru - Peru
*ID 491650 - 491999: '''Free (take ranges of 20 only please at once, ask us for more)'''
*ID 492000 - 492999: Anura (https://www.anura.fr/)
*ID 493000 - 493050: Bourez Bastien EI (https://bastien-b.fr/)
*ID 493051 - 493100: benhmida ilyess (bhilyess98@gmail.com)
*ID 493101 - 493150 George TS, George SP (gspanos@makeasite.gr)
**
*ID 499001 - 499050: IT GENIUSES (https://www.itgeniuses.com)

DO NOT ADD RECORD HERE, PLEASE FILL HOLES FIRST !!!!
...

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

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

Module Zapier FR

2024-05-15T10:15:38Z

Kusco: /* Installation */

[[es:Módulo_Zapier]]
[[fr:Module_Zapier_FR]]
[[de:Modul_Zapier]]


[[Category:Zapier]]
[[Category:No Code Automation]]
{{TemplateDocUser}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Zapier|
num=50330|
devdoc=[[Module Zapier (developer)]]|
userdoc=This page|}}

=Présentation=
Ce module sert à gérer les liens entre Dolibarr et Zapier.

=Installation=
Ce module nécessite de mettre la variable MAIN_FEATURES_LEVEL à 2.
Pour l'ajouter, aller dans Configuration --> Divers et mettez la valeur à 2. Enfin, activez le module dans la gestion des modules classique.

=Configuration=
{{ActivationModuleFr}}

==Créer un compte développeur Zapier==

Dans un premier temps, vous devez avoir un compte développeur Zapier, créez-le ici : [https://developer.zapier.com Zapier Platform]

==Créer et déployer « l'application Zapier » sur la plateforme Zapier==

L'App Zapier est un petit package en javascript que vous devez déployer sur Zapier pour que Zapier puisse communiquer avec votre application Dolibarr.

===Installer Node.js===

Une option simple pour configurer Node.js consiste à visiter [https://nodejs.org/en/download/](https://nodejs.org/en/download/) et à télécharger le programme d'installation officiel de votre système d'exploitation. . Si vous installez avec un gestionnaire de packages, c'est encore plus simple.

Après l'installation, confirmez que Node.js est prêt à être utilisé :
<syntaxhighlight lang="bash">
node --version
</syntaxhighlight>

===Installer la CLI Zapier===

Ensuite, installons les outils CLI '''zapier'''. Cet utilitaire CLI vous permettra de créer votre application, de la déployer sur la plateforme Zapier, d'effectuer des tests locaux, de gérer les utilisateurs et les testeurs, d'afficher les journaux à distance, de collaborer avec votre équipe, et bien plus encore :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install zapier-platform-cli
zapier --version
</syntaxhighlight>

===Exécuter la connexion Zapier===

Configurons l'authentification entre votre environnement de développement et la plateforme Zapier. Vous utiliserez l'adresse e-mail et le mot de passe que vous utilisez pour vous connecter à l'application Zapier.

<syntaxhighlight lang="bash">
zapier login
</syntaxhighlight>

Cette commande créera un fichier '''.zapierrc''' dans votre répertoire personnel.

===Installer le projet===

Dans le répertoire d'exemples Zapier, exécutez :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install
</syntaxhighlight>

===Déploiement de votre application===

Lorsque vous êtes prêt à essayer votre code sur la plateforme Zapier, utilisez la commande push. Vous seul pourrez voir l'application jusqu'à ce que vous invitiez des testeurs.

<syntaxhighlight lang="bash">
zapier register (la première fois, choisir le nom par exemple "Mon Dolibarr")
zapier push
</syntaxhighlight>

Après un push, l'Application, portant le nom que vous avez défini lors de l'étape d'inscription, est disponible en '''Application Privée''' lors de la création d'un Zap.

Vous trouverez un tutoriel ici : [https://zapier.com/developer/start/introduction](https://zapier.com/developer/start/introduction)

=Utilisation=

===Création d'une connexion pour l'application===

Activez l'API REST dans Dolibarr. Ils sont utilisés par Zapier, à commencer par l'API de connexion.

Allez dans le tableau de bord Zapier et créez une connexion : Allez dans « Mes applications – Intégration personnalisée », puis « Ajouter une connexion ».

Si l'App n'apparaît pas dans la liste pour ajouter une connexion, oubliez cette étape et pour créer directement un Zap, la création de connexion pourra être demandée ultérieurement).
Si la Connexion peut être créée, saisissez l'URL de votre page de connexion Dolibarr.

*L'URL ne doit pas se terminer par /. Par exemple : https://mondomaine ou https://mondomaine/mydoli/htdocs

Saisissez le login/pass d'un compte existant.

*Pour l'authentification, vous devez saisir le login/pass d'un compte existant qui sera utilisé par Zapier pour appeler les API. Donnez la permission à cet utilisateur selon l'action que Zapier demandera à votre Dolibarr.
*Si vous rencontrez une erreur de certificat SSL lors de l'accès à votre site Web en raison d'un certificat signé automatiquement, vous pouvez désactiver la vérification du certificat SSL dans Paramètres Zapier - Paramètres avancés.
*Si votre instance Web est protégée par une protection HTTP Basic, vous devez conserver les URL publiques ouvertes pour les outils externes. Ceci est un exemple de directive à utiliser pour exclure certaines pages de la protection HTTP Basic
{{ExcludeDirForBasicHTTP}}

==Créer un Zap==

Créez un ZAP qui utilise l'application que vous avez enregistrée depuis l'interface Zapier https://www.zapier.com

Module Zapier FR

2024-05-15T10:15:17Z

Kusco: /* Installation */

[[es:Módulo_Zapier]]
[[fr:Module_Zapier_FR]]
[[de:Modul_Zapier]]


[[Category:Zapier]]
[[Category:No Code Automation]]
{{TemplateDocUser}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Zapier|
num=50330|
devdoc=[[Module Zapier (developer)]]|
userdoc=This page|}}

=Présentation=
Ce module sert à gérer les liens entre Dolibarr et Zapier.

=Installation=
Ce module nécessite de mettre la variable MAIN_FEATURES_LEVEL à 2.
Pour l'ajouter, aller dans Configuration --> Divers et mettez la valeur à 2.

=Configuration=
{{ActivationModuleFr}}

==Créer un compte développeur Zapier==

Dans un premier temps, vous devez avoir un compte développeur Zapier, créez-le ici : [https://developer.zapier.com Zapier Platform]

==Créer et déployer « l'application Zapier » sur la plateforme Zapier==

L'App Zapier est un petit package en javascript que vous devez déployer sur Zapier pour que Zapier puisse communiquer avec votre application Dolibarr.

===Installer Node.js===

Une option simple pour configurer Node.js consiste à visiter [https://nodejs.org/en/download/](https://nodejs.org/en/download/) et à télécharger le programme d'installation officiel de votre système d'exploitation. . Si vous installez avec un gestionnaire de packages, c'est encore plus simple.

Après l'installation, confirmez que Node.js est prêt à être utilisé :
<syntaxhighlight lang="bash">
node --version
</syntaxhighlight>

===Installer la CLI Zapier===

Ensuite, installons les outils CLI '''zapier'''. Cet utilitaire CLI vous permettra de créer votre application, de la déployer sur la plateforme Zapier, d'effectuer des tests locaux, de gérer les utilisateurs et les testeurs, d'afficher les journaux à distance, de collaborer avec votre équipe, et bien plus encore :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install zapier-platform-cli
zapier --version
</syntaxhighlight>

===Exécuter la connexion Zapier===

Configurons l'authentification entre votre environnement de développement et la plateforme Zapier. Vous utiliserez l'adresse e-mail et le mot de passe que vous utilisez pour vous connecter à l'application Zapier.

<syntaxhighlight lang="bash">
zapier login
</syntaxhighlight>

Cette commande créera un fichier '''.zapierrc''' dans votre répertoire personnel.

===Installer le projet===

Dans le répertoire d'exemples Zapier, exécutez :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install
</syntaxhighlight>

===Déploiement de votre application===

Lorsque vous êtes prêt à essayer votre code sur la plateforme Zapier, utilisez la commande push. Vous seul pourrez voir l'application jusqu'à ce que vous invitiez des testeurs.

<syntaxhighlight lang="bash">
zapier register (la première fois, choisir le nom par exemple "Mon Dolibarr")
zapier push
</syntaxhighlight>

Après un push, l'Application, portant le nom que vous avez défini lors de l'étape d'inscription, est disponible en '''Application Privée''' lors de la création d'un Zap.

Vous trouverez un tutoriel ici : [https://zapier.com/developer/start/introduction](https://zapier.com/developer/start/introduction)

=Utilisation=

===Création d'une connexion pour l'application===

Activez l'API REST dans Dolibarr. Ils sont utilisés par Zapier, à commencer par l'API de connexion.

Allez dans le tableau de bord Zapier et créez une connexion : Allez dans « Mes applications – Intégration personnalisée », puis « Ajouter une connexion ».

Si l'App n'apparaît pas dans la liste pour ajouter une connexion, oubliez cette étape et pour créer directement un Zap, la création de connexion pourra être demandée ultérieurement).
Si la Connexion peut être créée, saisissez l'URL de votre page de connexion Dolibarr.

*L'URL ne doit pas se terminer par /. Par exemple : https://mondomaine ou https://mondomaine/mydoli/htdocs

Saisissez le login/pass d'un compte existant.

*Pour l'authentification, vous devez saisir le login/pass d'un compte existant qui sera utilisé par Zapier pour appeler les API. Donnez la permission à cet utilisateur selon l'action que Zapier demandera à votre Dolibarr.
*Si vous rencontrez une erreur de certificat SSL lors de l'accès à votre site Web en raison d'un certificat signé automatiquement, vous pouvez désactiver la vérification du certificat SSL dans Paramètres Zapier - Paramètres avancés.
*Si votre instance Web est protégée par une protection HTTP Basic, vous devez conserver les URL publiques ouvertes pour les outils externes. Ceci est un exemple de directive à utiliser pour exclure certaines pages de la protection HTTP Basic
{{ExcludeDirForBasicHTTP}}

==Créer un Zap==

Créez un ZAP qui utilise l'application que vous avez enregistrée depuis l'interface Zapier https://www.zapier.com

Module Zapier FR

2024-05-15T10:13:43Z

Kusco: Modification langue

[[es:Módulo_Zapier]]
[[fr:Module_Zapier_FR]]
[[de:Modul_Zapier]]


[[Category:Zapier]]
[[Category:No Code Automation]]
{{TemplateDocUser}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Zapier|
num=50330|
devdoc=[[Module Zapier (developer)]]|
userdoc=This page|}}

=Présentation=
Ce module sert à gérer les liens entre Dolibarr et Zapier.

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

==Créer un compte développeur Zapier==

Dans un premier temps, vous devez avoir un compte développeur Zapier, créez-le ici : [https://developer.zapier.com Zapier Platform]

==Créer et déployer « l'application Zapier » sur la plateforme Zapier==

L'App Zapier est un petit package en javascript que vous devez déployer sur Zapier pour que Zapier puisse communiquer avec votre application Dolibarr.

===Installer Node.js===

Une option simple pour configurer Node.js consiste à visiter [https://nodejs.org/en/download/](https://nodejs.org/en/download/) et à télécharger le programme d'installation officiel de votre système d'exploitation. . Si vous installez avec un gestionnaire de packages, c'est encore plus simple.

Après l'installation, confirmez que Node.js est prêt à être utilisé :
<syntaxhighlight lang="bash">
node --version
</syntaxhighlight>

===Installer la CLI Zapier===

Ensuite, installons les outils CLI '''zapier'''. Cet utilitaire CLI vous permettra de créer votre application, de la déployer sur la plateforme Zapier, d'effectuer des tests locaux, de gérer les utilisateurs et les testeurs, d'afficher les journaux à distance, de collaborer avec votre équipe, et bien plus encore :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install zapier-platform-cli
zapier --version
</syntaxhighlight>

===Exécuter la connexion Zapier===

Configurons l'authentification entre votre environnement de développement et la plateforme Zapier. Vous utiliserez l'adresse e-mail et le mot de passe que vous utilisez pour vous connecter à l'application Zapier.

<syntaxhighlight lang="bash">
zapier login
</syntaxhighlight>

Cette commande créera un fichier '''.zapierrc''' dans votre répertoire personnel.

===Installer le projet===

Dans le répertoire d'exemples Zapier, exécutez :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install
</syntaxhighlight>

===Déploiement de votre application===

Lorsque vous êtes prêt à essayer votre code sur la plateforme Zapier, utilisez la commande push. Vous seul pourrez voir l'application jusqu'à ce que vous invitiez des testeurs.

<syntaxhighlight lang="bash">
zapier register (la première fois, choisir le nom par exemple "Mon Dolibarr")
zapier push
</syntaxhighlight>

Après un push, l'Application, portant le nom que vous avez défini lors de l'étape d'inscription, est disponible en '''Application Privée''' lors de la création d'un Zap.

Vous trouverez un tutoriel ici : [https://zapier.com/developer/start/introduction](https://zapier.com/developer/start/introduction)

=Utilisation=

===Création d'une connexion pour l'application===

Activez l'API REST dans Dolibarr. Ils sont utilisés par Zapier, à commencer par l'API de connexion.

Allez dans le tableau de bord Zapier et créez une connexion : Allez dans « Mes applications – Intégration personnalisée », puis « Ajouter une connexion ».

Si l'App n'apparaît pas dans la liste pour ajouter une connexion, oubliez cette étape et pour créer directement un Zap, la création de connexion pourra être demandée ultérieurement).
Si la Connexion peut être créée, saisissez l'URL de votre page de connexion Dolibarr.

*L'URL ne doit pas se terminer par /. Par exemple : https://mondomaine ou https://mondomaine/mydoli/htdocs

Saisissez le login/pass d'un compte existant.

*Pour l'authentification, vous devez saisir le login/pass d'un compte existant qui sera utilisé par Zapier pour appeler les API. Donnez la permission à cet utilisateur selon l'action que Zapier demandera à votre Dolibarr.
*Si vous rencontrez une erreur de certificat SSL lors de l'accès à votre site Web en raison d'un certificat signé automatiquement, vous pouvez désactiver la vérification du certificat SSL dans Paramètres Zapier - Paramètres avancés.
*Si votre instance Web est protégée par une protection HTTP Basic, vous devez conserver les URL publiques ouvertes pour les outils externes. Ceci est un exemple de directive à utiliser pour exclure certaines pages de la protection HTTP Basic
{{ExcludeDirForBasicHTTP}}

==Créer un Zap==

Créez un ZAP qui utilise l'application que vous avez enregistrée depuis l'interface Zapier https://www.zapier.com

Module Zapier FR

2024-05-15T10:10:38Z

Kusco: Traduction de la page anglaise

{{TemplateDocUser}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Zapier|
num=50330|
devdoc=[[Module Zapier (developer)]]|
userdoc=This page|}}

=Présentation=
Ce module sert à gérer les liens entre Dolibarr et Zapier.

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

==Créer un compte développeur Zapier==

Dans un premier temps, vous devez avoir un compte développeur Zapier, créez-le ici : [https://developer.zapier.com Zapier Platform]

==Créer et déployer « l'application Zapier » sur la plateforme Zapier==

L'App Zapier est un petit package en javascript que vous devez déployer sur Zapier pour que Zapier puisse communiquer avec votre application Dolibarr.

===Installer Node.js===

Une option simple pour configurer Node.js consiste à visiter [https://nodejs.org/en/download/](https://nodejs.org/en/download/) et à télécharger le programme d'installation officiel de votre système d'exploitation. . Si vous installez avec un gestionnaire de packages, c'est encore plus simple.

Après l'installation, confirmez que Node.js est prêt à être utilisé :
<syntaxhighlight lang="bash">
node --version
</syntaxhighlight>

===Installer la CLI Zapier===

Ensuite, installons les outils CLI '''zapier'''. Cet utilitaire CLI vous permettra de créer votre application, de la déployer sur la plateforme Zapier, d'effectuer des tests locaux, de gérer les utilisateurs et les testeurs, d'afficher les journaux à distance, de collaborer avec votre équipe, et bien plus encore :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install zapier-platform-cli
zapier --version
</syntaxhighlight>

===Exécuter la connexion Zapier===

Configurons l'authentification entre votre environnement de développement et la plateforme Zapier. Vous utiliserez l'adresse e-mail et le mot de passe que vous utilisez pour vous connecter à l'application Zapier.

<syntaxhighlight lang="bash">
zapier login
</syntaxhighlight>

Cette commande créera un fichier '''.zapierrc''' dans votre répertoire personnel.

===Installer le projet===

Dans le répertoire d'exemples Zapier, exécutez :

<syntaxhighlight lang="bash">
cd dev/examples/zapier
npm install
</syntaxhighlight>

===Déploiement de votre application===

Lorsque vous êtes prêt à essayer votre code sur la plateforme Zapier, utilisez la commande push. Vous seul pourrez voir l'application jusqu'à ce que vous invitiez des testeurs.

<syntaxhighlight lang="bash">
zapier register (la première fois, choisir le nom par exemple "Mon Dolibarr")
zapier push
</syntaxhighlight>

Après un push, l'Application, portant le nom que vous avez défini lors de l'étape d'inscription, est disponible en '''Application Privée''' lors de la création d'un Zap.

Vous trouverez un tutoriel ici : [https://zapier.com/developer/start/introduction](https://zapier.com/developer/start/introduction)

=Utilisation=

===Création d'une connexion pour l'application===

Activez l'API REST dans Dolibarr. Ils sont utilisés par Zapier, à commencer par l'API de connexion.

Allez dans le tableau de bord Zapier et créez une connexion : Allez dans « Mes applications – Intégration personnalisée », puis « Ajouter une connexion ».

Si l'App n'apparaît pas dans la liste pour ajouter une connexion, oubliez cette étape et pour créer directement un Zap, la création de connexion pourra être demandée ultérieurement).
Si la Connexion peut être créée, saisissez l'URL de votre page de connexion Dolibarr.

*L'URL ne doit pas se terminer par /. Par exemple : https://mondomaine ou https://mondomaine/mydoli/htdocs

Saisissez le login/pass d'un compte existant.

*Pour l'authentification, vous devez saisir le login/pass d'un compte existant qui sera utilisé par Zapier pour appeler les API. Donnez la permission à cet utilisateur selon l'action que Zapier demandera à votre Dolibarr.
*Si vous rencontrez une erreur de certificat SSL lors de l'accès à votre site Web en raison d'un certificat signé automatiquement, vous pouvez désactiver la vérification du certificat SSL dans Paramètres Zapier - Paramètres avancés.
*Si votre instance Web est protégée par une protection HTTP Basic, vous devez conserver les URL publiques ouvertes pour les outils externes. Ceci est un exemple de directive à utiliser pour exclure certaines pages de la protection HTTP Basic
{{ExcludeDirForBasicHTTP}}

==Créer un Zap==

Créez un ZAP qui utilise l'application que vous avez enregistrée depuis l'interface Zapier https://www.zapier.com

Développement module

2024-02-28T15:37:03Z

Kusco: /* Définissez vos box */ Mini corrections

[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" (ou "Module builder") dans la section "Outils multi-modules" de Configuration > Modules/Applications

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut d'ores et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''' : Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existent déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

À défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouvent des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Éditer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondant à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<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>

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

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par 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>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

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

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<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'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box/widgets (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/maboxn.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Widgets'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

==Ajouter un bouton (optionnel)==
Si vous souhaitez ajouter des boutons à vos enregistrements.

Voir la page [[Création de boutons]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

FAQ Améliorer les performances

2024-01-10T10:04:27Z

Kusco: /* Désactivation de xdebug */ Mise à jour du chemin d'accès

[[en:FAQ_Increase_Performance]]
[[es:FAQ_Mejorar_el_rendimiento]]


[[Category:FAQ FR]]
{{TemplateDocDev}}
{{TemplateDocUtil}}
Dolibarr est une application Web qui a fait l'objet d'une conception poussée pour obtenir un temps de réponse le plus optimisé possible.
De nombreuses technologies sont mises en oeuvre mais certaines ne sont pas actives par défaut car nécessite des compétences ou habilitations particulières pour les mettre en oeuvre. Voici toutes les choses que vous pouvez mettre en oeuvre pour améliorer encore plus la réactivité de l'application.

=Solutions recommandées=
A partir de la v14, vous trouverez dans le menu '''Accueil - Outils d'administration - Performances''', une page avec des conseils sur votre configuration pour obtenir les meilleures performances de votre application. Commencez par cela si votre version est v14+.

Vous pouvez ensuite compléter avec les recommandations suivantes...

==Utilisez la dernière version de PHP==
Efficacité: ***

Principe : Chaque nouvelle version de PHP rend l'application plus rapide que la précédente. Donc, si vous le pouvez, effectuez simplement une mise à niveau.

==Activer HTTP/2==
Efficacité: *

Principe : Le protocole HTTP/2 est connu pour être plus rapide que HTTP/1.1. Donc, si votre système d'exploitation et votre serveur Web sont compatibles, activez-le simplement.

==Désactivation de xdebug==
Efficacité: *****

Principe: Si le module php xdebug est actif, il vous faut le désactiver. Ce module est une fonctionnalité de PHP qui sert aux développeurs mais ralentit fortement le fonctionnement de toute application PHP.
Pour savoir si ce module est actif, aller dans la pages '''Accueil-Outils d'administrations-Infos PHP''' et faites une recherche sur '''xdebug'''. Si vous ne trouvez rien, le module n'est pas actif. Si vous trouvez une occurrence, il est actif et peut être désactivé.
Son activation/désactivation dépend de votre système PHP et OS mais le plus souvent on le désactive en commentant une ligne dans le fichier php.ini

==Cache applicatif via MemCached==
Efficacité: *****

Principe: Installer un serveur de cache Memcached et le [[Module MemCached]].

==Cache PHP OPCODE==
Efficacité: ****

Principe: Installer un module apache/php qui met en cache la compilation de vos pages PHP. A chaque accès, une page auquel on a déjà accédé sera plus rapide d'accès.
Pour cela vous pouvez installer n'importe quel [http://en.wikipedia.org/wiki/List_of_PHP_accelerators accélérateur PHP]. xcache fait partie des solutions recommandées.
Notons que ce cache joue ici sur un niveau différent que le [[Module MemCached]], les gains sont donc cumulatifs !

==Cache HTTP des pages statiques==
Efficacité: ***

Principe: Vous pouvez configurer apache pour activer le cache explicite des ressources statiques en ajoutant les directives:
<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>
La encore les gains sont cumulatifs avec les caches précédents.

[[File:warning.png]] Après avoir ajouté cela, vous devez recharger la configuration du serveur web mais également vider le cache local du navigateur afin de forcer ce dernier à redemander la ressource et récupérer le nouvel entête.

==Compression des ressources par Apache==
Efficacité: ***

Principe: Vous pouvez configurer Apache pour activer la compression des ressources renvoyées par le serveur grâce aux directives suivantes:
<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>

[[File:warning.png]] Après avoir ajouté cela, vous devez recharger la configuration du serveur web mais également vider le cache local du navigateur afin de forcer ce dernier à redemander la ressource et récupérer le nouvel entête.

==Utilisation du driver mysqli plutôt que mysql==
Efficacité: ***

Principe: Si vous utilisez une base de données Mysql, vérifiez dans votre fichier de configuration Dolibarr htdocs/conf/conf.php que vous avez bien la ligne
<source lang="php">
$dolibarr_main_db_type='mysqli';
</source>
Si la valeur vaut '''mysql''', changez la en '''mysqli''' qui donne de meilleures performances (gain de 30ms à chaque page).

==Recherche sur début de champ==
Efficacité: ***

Principe: Si vous avez activé dans le module Produit la recherche par "autocomplete" et si la liste met du temps à apparaitre à chaque saisie de caractère, c'est que vous avez un nombre important de produit. La recherche se faisant n'importe ou dans le texte, l'index de base de donnée ne peut être utilisé. En ajoutant la constante PRODUCT_DONOTSEARCH_ANYWHERE à 1 dans '''Accueil-Configuration-Divers''', vous limitez la recherche au début de la chaine rendant possible l'utilisation de l'index et obtiendrez une réponse immédiate.

==Désactivation des ajax combo==
Efficacité: ***

Si vous avez un large nombre de tiers, contacts ou produits (> 5000), vous pouvez désactiver la fonctionnalité de préchargements de produits pour ne charger la liste qu'après avoir cliquer sur 1, 2 ou 3 caractères.
Ceci se fait depuis la page de configuration du module Tiers ou Produit.

==Utilisation d'un navigateur récent==
Efficacité: ***

Principe: De plus en plus de fonctionnalités sont basés sur les technologies Ajax ou javascript afin d'offrir une ergonomie moderne. Ces technologies, ont une part non négligeable dans le temps d'affichage de certaines pages et sont beaucoup mieux exploités avec un navigateur Web récent. Les écarts en performance d'une version à l'autre sont parfois très importante, aussi pensez à utiliser un navigateur web optimisé et en version la plus récente possible (Firefox, Chrome, Safari ou Opera). Eviter IE ou autre navigateurs exotiques.

==Mise à jour de statistiques de base==
Efficacité: **

Principe: Si vous avez une base de donnée volumineuse (plus de 100 000 enregistrements), vérifiez que les statistiques de vos données sont à jour. Ceci requiert un accès administrateur à la base de donnée et des connaissances en administration de base. Consulter le manuel de la base de donnée sur le sujet "mise à jour des statistiques" pour cela.

=Autres solutions=
Toutes les solutions ici sont catégorisées à part dans ce chapitre "Autres solutions" car elles ne sont pas recommandées. Toutes les solutions suivantes peuvent nécessiter des connaissances techniques avancées, peuvent être instables, non supportées ou peuvent rendre certaines fonctionnalités inopérationnelles... mais elles existent, aussi ne les employez que si vous savez ce que vous faites !

==Cache applicatif via la Shared memory==
Efficacité: ****

Prérequis: Utilisation du serveur web Apache

Principe: Ajouter dans '''Accueil-Configuration-Divers''' la constante MAIN_OPTIMIZE_SPEED. Si la valeur de cette constante a le bit 1 défini (Exemple: MAIN_OPTIMIZE_SPEED=2), la shared memory de votre OS est utilisée pour mettre en cache les fichiers lang, mais cela implique aussi que tout l'interface ne sera visible que dans une seule langue, celle du premier qui se connecte après un redémarrage du serveur web (qui charge les fichiers langues en cache). De plus, la shared memory peut s'avérer instable sur certains OS (Windows). Utiliser plutôt le [[Module MemCached]] pour une optimisation par un cache applicatif qui n'a aucune de ces contraintes et est encore plus performant, cette action sera alors inutile.

==Désactiver le génération des PDF "à la volée"==
Efficacité: **

Vous pouvez ajouter la constante MAIN_DISABLE_PDF_AUTOUPDATE dans Accueil - Configuration - Autre.

Ceci désactivera la régénération du PDF à chaque fous que vous modifier un élément (facture, commande, ...). La génération du PDF aura lieu uniquement sur click du bouton "Générer".

==Compression des ressources par Dolibarr==
Efficacité: **

Principe: Ajouter dans '''Accueil-Configuration-Divers''' la constante MAIN_OPTIMIZE_SPEED. Si la valeur de cette constante a le bit 2 défini (Exemple: MAIN_OPTIMIZE_SPEED=4), Dolibarr renverra les pages compressés en GZ (et si le navigateur le supporte). Cela consomme plus de CPU sur le serveur mais réduit le temps de transfert. Préferrez toutefois la compression configuré par Apache (voir plus haut). Ne pas activez les 2 méthodes en même temps.

==Désactiver la fonction Canvas==
Efficacité: *

Principe: Ajouter dans '''Accueil-Configuration-Divers''' la constante MAIN_DISABLE_CANVAS à la valeur 1. Ceci désactivera les fonctions de gestion de canvas qui peut être utilisé par certains modules externes et économisera une requête sur la base à chaque fois que vous accédez à la fiche d'un objet.
Cependant, si un module externe utilise cette fonction de canvas, ceci rendra le module défectueux. Si vous n'avez installé aucun module complémentaire externe, il n'y a pas de risques.

Développement module

2023-11-21T11:57:04Z

Kusco: /* Ajouter un bouton (optionnel) */

[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" (ou "Module builder") dans la section "Outils multi-modules" de Configuration > Modules/Applications

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut d'ores et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''' : Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existent déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

À défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouvent des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Éditer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondant à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<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>

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

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par 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>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

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

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<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'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box/widgets (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/mabox1.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Boite'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

==Ajouter un bouton (optionnel)==
Si vous souhaitez ajouter des boutons à vos enregistrements.

Voir la page [[Création de boutons]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

Développement module

2023-11-21T11:56:51Z

Kusco: Ajout des boutons

[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" (ou "Module builder") dans la section "Outils multi-modules" de Configuration > Modules/Applications

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut d'ores et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''' : Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existent déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

À défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouvent des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Éditer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondant à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<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>

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

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par 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>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

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

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<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'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box/widgets (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/mabox1.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Boite'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

==Ajouter un bouton (optionnel)==
Si vous souhaitez ajouter des boutons à vos enregistrements.

Voir la page [[Création_de_boutons]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

Création de boutons

2023-11-21T11:54:37Z

Kusco: Création complète de la page

Pour chaque enregistrement, il est possible de créer des boutons et d'y associer des actions. On retrouvera par exemple des actions comme valider, désactiver, mettre en brouillon, etc.

Nous utiliserons, dans nos exemples, la possibilité d'activer ou désactiver un enregistrement.

== Fichier class.php ==

=== Constantes ===
Au début du fichier, nous allons vérifier les différentes constantes et les valeurs attribuées.<syntaxhighlight lang="php" line="1">
const STATUS_DRAFT = -1;
const STATUS_DISABLED = 0;
const STATUS_VALIDATED = 1;
const STATUS_CANCELED = 9;
</syntaxhighlight> 

=== Création fonctions ===
On vient ensuite ajouter les fonctions<syntaxhighlight lang="php" line="1">
public function enable($user, $notrigger = 0)
{
// Protection pour véfifier le statut de départ
if ($this->status != self::STATUS_DISABLED) {
return 0;
}
return $this->setStatusCommon($user, self::STATUS_VALIDATED, $notrigger, '');
}
</syntaxhighlight>

=== Choisir le statut ===
La fonction viendra modifier l'apparence des status :<syntaxhighlight lang="PHP">
public function LibStatut($status, $mode = 0)
</syntaxhighlight>Pour chaque statut, on peut y venir apposer un numéro de statut et donc une mise en forme particulière :<syntaxhighlight lang="PHP">
if ($status == self::STATUS_DRAFT) {
$statusType = 'status1';
}
</syntaxhighlight>

Voici une liste des statuts et de leur apparence (peut varier en fonction des thèmes et versions utilisées) :<gallery mode="packed-overlay">
File:Status0.png|Status 0
File:Status1.png|Status 1
File:Status2.png|Status 2
File:Status3.png|Status 3
File:Status4.png|Status 4
File:Status5.png|Status 5
File:Status6.png|Status 6
File:Status7.png|Status 7
File:Status8.png|Status 8
File:Status9.png|Status 9
File:Status10.png|Status 10
File:Status11.png|Status 11
</gallery> 

== Fichier _card.php ==

=== Création du bouton ===
Avec le module builder, un fichier _card.php est créé où on y retrouvera le commentaire suivant, en dessous duquel on pourra nos créations :

<nowiki><source lang="php">// Buttons for actions</source></nowiki>

Le code pour ajouter un bouton est le suivant :<syntaxhighlight lang="php" line="1">
if ($permissiontoadd) { // Vérification au niveau des permissions
if ($object->status == $object::STATUS_VALIDATED) { // Si notre statut est déjà validé, on affiche un bouton pour désactiver
print dolGetButtonAction('',$langs->trans('Disable'), 'default', $_SERVER['PHP_SELF'].'?id='.$object->id.'&action=disable&token='.newToken(), '', $permissiontoadd);
} else { // Si notre statut est désactivé on afficher un bouton pour le réactiver
print dolGetButtonAction('',$langs->trans('Enable'), 'default', $_SERVER['PHP_SELF'].'?id='.$object->id.'&action=enable&token='.newToken(), '', $permissiontoadd);
}
}
</syntaxhighlight>

=== Appel de l'action ===
Dans le haut du fichier _card.php, on retrouvera le commentaire suivant :<syntaxhighlight lang="PHP">
/*
* Actions
*/
</syntaxhighlight>

C'est à ce niveau que l'on va venir ajouter les appels de fonction, que nous avons mis dans la création de nos bouttons<syntaxhighlight lang="php" line="1">
if ($action == 'enable' && $permissiontoadd) { // Si on choisit l'action enable et que nous en avons la permission
$object->enable($object->fk_user_modif,0); // Nous appelons la fonction enable, qui se trouve dans notreobjet/class.php
setEventMessages("", "Bénéficiaire activé", 'mesgs');
}

if ($action == 'disable' && $permissiontoadd) {
if ($object->action_fin == null) { // On peut ajouter une condition et un message d'erreur pour bloquer la désactivation
setEventMessages("", "Il faut ajouter une date de fin de l'action pour pouvoir désactiver un bénéficiaire", 'errors');
}
else {
$object->disable($object->fk_user_modif,0);
setEventMessages("", "Bénéficiaire désactivé", 'mesgs'); // Ou bien ajouter un message pour indiquer la bonne marche des choses
}
</syntaxhighlight>

File:Status11.png

2023-11-21T11:51:11Z

Kusco:

Status11

File:Status10.png

2023-11-21T11:51:04Z

Kusco:

Status10

File:Status9.png

2023-11-21T11:50:53Z

Kusco:

Status9

File:Status8.png

2023-11-21T11:50:45Z

Kusco:

Status8

File:Status7.png

2023-11-21T11:50:39Z

Kusco:

Status7

File:Status6.png

2023-11-21T11:50:30Z

Kusco:

Status6

File:Status5.png

2023-11-21T11:50:21Z

Kusco:

Status5

File:Status4.png

2023-11-21T11:50:14Z

Kusco:

Status4

File:Status3.png

2023-11-21T11:50:05Z

Kusco:

Status3

File:Status2.png

2023-11-21T11:49:57Z

Kusco:

Status2

File:Status1.png

2023-11-21T11:49:49Z

Kusco:

Status1

File:Status0.png

2023-11-21T11:49:18Z

Kusco:

Status0

Gestion d'erreur

2023-11-21T11:10:31Z

Kusco: /* Les fonctions */

[[en:Error_reporting]]
[[es:Gestión_de_errores]]
[[zh:错误处理]]


[[Category:Noyau]]
{{TemplateDocDev}}

=Les fonctions=
La fonction suivante permet de tracer des informations dans le fichier log de Dolibarr :
<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>

La fonction suivante provoque l'affichage d'un message d'erreur :
<source lang="php">dol_print_error($db,texte);</source>

Les fonctions suivantes permettent d'émettre des messages d'erreurs ou d'information pour les utilisateurs.

<source lang="php">setEventMessages("", "Message d'erreur à transmettre", 'errors');</source>

Message bloquant qui empêche l'action

<source lang="php">setEventMessages("", "Message d'information à transmettre", 'mesgs');</source>

Message non bloquant pour indiquer une validation par exemple

=Module Syslog=
Le module de traçage est inclus parmi les autres modules administrables de Dolibarr et vous permet de activer/modifier le niveau d'erreur que vous désirez observer.

Pour atteindre la page de configuration de ce module, aller sur la page Accueil->Configuration->Modules et cliquez sur l'icone en fin de ligne sur la ligne du module ''Syslog''.

Bien sûr, ce module ('''Syslog''') doit être activé pour que les traces fonctionnent.

La notion de '''facility''' de syslog est une notion de configuration pré-définie pour loguer les messages. C'est une fonctionnalité système pour dire à l'opérateur système d'où vient une erreur (ici Dolibarr) et indiquer sa priorité. Vous trouverez plus d'informations dans la documentation PHP pour la fonction ''openlog()'' function qui est utilisé dans la fonction ''dol_syslog()'': http://www.php.ne/openlog
En général, il vous faut laisser cette valeur à '''LOG_USER''', sauf si vous savez ce que vous faites.

L'option suivante, '''fichier''', permet de choisir dans quel fichier vous allez sauver les logs. Le chemin indiqué doit etre relatif à la racine (/). Si vous le laisser tel quel (option par défaut DOL_DATA_ROOT/dolibarr.log), il sera créé dans le répertoire documents de Dolibarr. Bien sûr, pour cela, votre serveur web doit avoir les droits en écriture sur ce répertoire.

En général, la facility '''fichier''' fonctionnera plus souvent car elle ne dépend pas de la configuration système de votre serveur, ni d'un éventuel démon syslog requis (le seul problème qui peut arriver est que le répertoire n'ait pas la permission d'écriture pour le seveur web).

Enfin, le niveau de rapport représente le nombre de types de messages que vous désirez voir. LOG_DEBUG(7) est l'option la plus verbeuse, affichant tout message qui passe par la fonction dol_syslog(). LOG_EMERG(0) est son contraire, ne traçant que les messages qui sont des erreurs graves.

Plus d'information sur la page [[Module Syslog (développeur)]].

=Autres logs systèmes rares=
Notez, qu'indépendamment du module syslog, vous pouvez aussi trouvez des erreurs techniques PHP/Apache dans les logs d'apache (quelquesoit l'état/configuration du module syslog). Mais cela n'arrive qu'en cas de probleme technique d'installation ou d'environnement. Une application Dolibarr qui fonctionne n'affichera jamais rien dans ces fichiers. Sur un système Linux standard, de telle traces sont visibles dans les fichiers '''/var/log/apache[2]/[dolibarr]-error.log'''. Vous pouvez les voir en ''live'' depuis un terminal avec la commande:
<source lang="bash">tail -f /var/log/apache2/dolibarr-error.log</source>

Gestion d'erreur

2023-11-21T11:10:16Z

Kusco: /* Les fonctions */

[[en:Error_reporting]]
[[es:Gestión_de_errores]]
[[zh:错误处理]]


[[Category:Noyau]]
{{TemplateDocDev}}

=Les fonctions=
La fonction suivante permet de tracer des informations dans le fichier log de Dolibarr :
<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>

La fonction suivante provoque l'affichage d'un message d'erreur :
<source lang="php">dol_print_error($db,texte);</source>

Les fonctions suivantes permettent d'émettre des messages d'erreurs ou d'information pour les utilisateurs.

<source lang="php">setEventMessages("", "Message d'erreur à transmettre", 'errors');</source>

Message bloquant qui empêche l'action

<source lang="php">setEventMessages("", "Message d'erreur à transmettre", 'mesgs');</source>

Message non bloquant pour indiquer une validation par exemple

=Module Syslog=
Le module de traçage est inclus parmi les autres modules administrables de Dolibarr et vous permet de activer/modifier le niveau d'erreur que vous désirez observer.

Pour atteindre la page de configuration de ce module, aller sur la page Accueil->Configuration->Modules et cliquez sur l'icone en fin de ligne sur la ligne du module ''Syslog''.

Bien sûr, ce module ('''Syslog''') doit être activé pour que les traces fonctionnent.

La notion de '''facility''' de syslog est une notion de configuration pré-définie pour loguer les messages. C'est une fonctionnalité système pour dire à l'opérateur système d'où vient une erreur (ici Dolibarr) et indiquer sa priorité. Vous trouverez plus d'informations dans la documentation PHP pour la fonction ''openlog()'' function qui est utilisé dans la fonction ''dol_syslog()'': http://www.php.ne/openlog
En général, il vous faut laisser cette valeur à '''LOG_USER''', sauf si vous savez ce que vous faites.

L'option suivante, '''fichier''', permet de choisir dans quel fichier vous allez sauver les logs. Le chemin indiqué doit etre relatif à la racine (/). Si vous le laisser tel quel (option par défaut DOL_DATA_ROOT/dolibarr.log), il sera créé dans le répertoire documents de Dolibarr. Bien sûr, pour cela, votre serveur web doit avoir les droits en écriture sur ce répertoire.

En général, la facility '''fichier''' fonctionnera plus souvent car elle ne dépend pas de la configuration système de votre serveur, ni d'un éventuel démon syslog requis (le seul problème qui peut arriver est que le répertoire n'ait pas la permission d'écriture pour le seveur web).

Enfin, le niveau de rapport représente le nombre de types de messages que vous désirez voir. LOG_DEBUG(7) est l'option la plus verbeuse, affichant tout message qui passe par la fonction dol_syslog(). LOG_EMERG(0) est son contraire, ne traçant que les messages qui sont des erreurs graves.

Plus d'information sur la page [[Module Syslog (développeur)]].

=Autres logs systèmes rares=
Notez, qu'indépendamment du module syslog, vous pouvez aussi trouvez des erreurs techniques PHP/Apache dans les logs d'apache (quelquesoit l'état/configuration du module syslog). Mais cela n'arrive qu'en cas de probleme technique d'installation ou d'environnement. Une application Dolibarr qui fonctionne n'affichera jamais rien dans ces fichiers. Sur un système Linux standard, de telle traces sont visibles dans les fichiers '''/var/log/apache[2]/[dolibarr]-error.log'''. Vous pouvez les voir en ''live'' depuis un terminal avec la commande:
<source lang="bash">tail -f /var/log/apache2/dolibarr-error.log</source>

Gestion d'erreur

2023-11-21T11:09:49Z

Kusco: /* Les fonctions */

[[en:Error_reporting]]
[[es:Gestión_de_errores]]
[[zh:错误处理]]


[[Category:Noyau]]
{{TemplateDocDev}}

=Les fonctions=
La fonction suivante permet de tracer des informations dans le fichier log de Dolibarr :
<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>

La fonction suivante provoque l'affichage d'un message d'erreur :
<source lang="php">dol_print_error($db,texte);</source>

Les fonctions suivantes permettent d'émettre des messages d'erreurs ou d'information pour les utilisateurs.

<source lang="php">setEventMessages("", "Message d'erreur à transmettre", 'errors');<nowiki></source></nowiki>

Message bloquant qui empêche l'action

<source lang="php">setEventMessages("", "Message d'erreur à transmettre", 'mesgs');<nowiki></source></nowiki>

Message non bloquant pour indiquer une validation par exemple

=Module Syslog=
Le module de traçage est inclus parmi les autres modules administrables de Dolibarr et vous permet de activer/modifier le niveau d'erreur que vous désirez observer.

Pour atteindre la page de configuration de ce module, aller sur la page Accueil->Configuration->Modules et cliquez sur l'icone en fin de ligne sur la ligne du module ''Syslog''.

Bien sûr, ce module ('''Syslog''') doit être activé pour que les traces fonctionnent.

La notion de '''facility''' de syslog est une notion de configuration pré-définie pour loguer les messages. C'est une fonctionnalité système pour dire à l'opérateur système d'où vient une erreur (ici Dolibarr) et indiquer sa priorité. Vous trouverez plus d'informations dans la documentation PHP pour la fonction ''openlog()'' function qui est utilisé dans la fonction ''dol_syslog()'': http://www.php.ne/openlog
En général, il vous faut laisser cette valeur à '''LOG_USER''', sauf si vous savez ce que vous faites.

L'option suivante, '''fichier''', permet de choisir dans quel fichier vous allez sauver les logs. Le chemin indiqué doit etre relatif à la racine (/). Si vous le laisser tel quel (option par défaut DOL_DATA_ROOT/dolibarr.log), il sera créé dans le répertoire documents de Dolibarr. Bien sûr, pour cela, votre serveur web doit avoir les droits en écriture sur ce répertoire.

En général, la facility '''fichier''' fonctionnera plus souvent car elle ne dépend pas de la configuration système de votre serveur, ni d'un éventuel démon syslog requis (le seul problème qui peut arriver est que le répertoire n'ait pas la permission d'écriture pour le seveur web).

Enfin, le niveau de rapport représente le nombre de types de messages que vous désirez voir. LOG_DEBUG(7) est l'option la plus verbeuse, affichant tout message qui passe par la fonction dol_syslog(). LOG_EMERG(0) est son contraire, ne traçant que les messages qui sont des erreurs graves.

Plus d'information sur la page [[Module Syslog (développeur)]].

=Autres logs systèmes rares=
Notez, qu'indépendamment du module syslog, vous pouvez aussi trouvez des erreurs techniques PHP/Apache dans les logs d'apache (quelquesoit l'état/configuration du module syslog). Mais cela n'arrive qu'en cas de probleme technique d'installation ou d'environnement. Une application Dolibarr qui fonctionne n'affichera jamais rien dans ces fichiers. Sur un système Linux standard, de telle traces sont visibles dans les fichiers '''/var/log/apache[2]/[dolibarr]-error.log'''. Vous pouvez les voir en ''live'' depuis un terminal avec la commande:
<source lang="bash">tail -f /var/log/apache2/dolibarr-error.log</source>

Gestion d'erreur

2023-11-21T11:09:32Z

Kusco: /* Les fonctions */

[[en:Error_reporting]]
[[es:Gestión_de_errores]]
[[zh:错误处理]]


[[Category:Noyau]]
{{TemplateDocDev}}

=Les fonctions=
La fonction suivante permet de tracer des informations dans le fichier log de Dolibarr :
<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>

La fonction suivante provoque l'affichage d'un message d'erreur :
<source lang="php">dol_print_error($db,texte);</source>

Les fonctions suivantes permettent d'émettre des messages d'erreurs ou d'information pour les utilisateurs.

<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>setEventMessages("", "Message d'erreur à transmettre", 'errors');<nowiki></source></nowiki>

Message bloquant qui empêche l'action

<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>setEventMessages("", "Message d'erreur à transmettre", 'mesgs');<nowiki></source></nowiki>

Message non bloquant pour indiquer une validation par exemple

=Module Syslog=
Le module de traçage est inclus parmi les autres modules administrables de Dolibarr et vous permet de activer/modifier le niveau d'erreur que vous désirez observer.

Pour atteindre la page de configuration de ce module, aller sur la page Accueil->Configuration->Modules et cliquez sur l'icone en fin de ligne sur la ligne du module ''Syslog''.

Bien sûr, ce module ('''Syslog''') doit être activé pour que les traces fonctionnent.

La notion de '''facility''' de syslog est une notion de configuration pré-définie pour loguer les messages. C'est une fonctionnalité système pour dire à l'opérateur système d'où vient une erreur (ici Dolibarr) et indiquer sa priorité. Vous trouverez plus d'informations dans la documentation PHP pour la fonction ''openlog()'' function qui est utilisé dans la fonction ''dol_syslog()'': http://www.php.ne/openlog
En général, il vous faut laisser cette valeur à '''LOG_USER''', sauf si vous savez ce que vous faites.

L'option suivante, '''fichier''', permet de choisir dans quel fichier vous allez sauver les logs. Le chemin indiqué doit etre relatif à la racine (/). Si vous le laisser tel quel (option par défaut DOL_DATA_ROOT/dolibarr.log), il sera créé dans le répertoire documents de Dolibarr. Bien sûr, pour cela, votre serveur web doit avoir les droits en écriture sur ce répertoire.

En général, la facility '''fichier''' fonctionnera plus souvent car elle ne dépend pas de la configuration système de votre serveur, ni d'un éventuel démon syslog requis (le seul problème qui peut arriver est que le répertoire n'ait pas la permission d'écriture pour le seveur web).

Enfin, le niveau de rapport représente le nombre de types de messages que vous désirez voir. LOG_DEBUG(7) est l'option la plus verbeuse, affichant tout message qui passe par la fonction dol_syslog(). LOG_EMERG(0) est son contraire, ne traçant que les messages qui sont des erreurs graves.

Plus d'information sur la page [[Module Syslog (développeur)]].

=Autres logs systèmes rares=
Notez, qu'indépendamment du module syslog, vous pouvez aussi trouvez des erreurs techniques PHP/Apache dans les logs d'apache (quelquesoit l'état/configuration du module syslog). Mais cela n'arrive qu'en cas de probleme technique d'installation ou d'environnement. Une application Dolibarr qui fonctionne n'affichera jamais rien dans ces fichiers. Sur un système Linux standard, de telle traces sont visibles dans les fichiers '''/var/log/apache[2]/[dolibarr]-error.log'''. Vous pouvez les voir en ''live'' depuis un terminal avec la commande:
<source lang="bash">tail -f /var/log/apache2/dolibarr-error.log</source>

Gestion d'erreur

2023-11-21T11:08:10Z

Kusco: Ajouts des messages d'erreurs et d'informations pour les utilisateurs

[[en:Error_reporting]]
[[es:Gestión_de_errores]]
[[zh:错误处理]]


[[Category:Noyau]]
{{TemplateDocDev}}

=Les fonctions=
La fonction suivante permet de tracer des informations dans le fichier log de Dolibarr :
<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>

La fonction suivante provoque l'affichage d'un message d'erreur :
<source lang="php">dol_print_error($db,texte);</source>

Les fonctions suivantes permettent d'émettre des messages d'erreurs ou d'information pour les utilisateurs.

<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>setEventMessages("", "Message d'erreur à transmettre", 'errors');<nowiki></source></nowiki> Message bloquant qui empêche l'action

<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARN|LOG_ERR);</source>setEventMessages("", "Message d'erreur à transmettre", 'mesgs');<nowiki></source></nowiki> Message non bloquant pour indiquer une validation par exemple

=Module Syslog=
Le module de traçage est inclus parmi les autres modules administrables de Dolibarr et vous permet de activer/modifier le niveau d'erreur que vous désirez observer.

Pour atteindre la page de configuration de ce module, aller sur la page Accueil->Configuration->Modules et cliquez sur l'icone en fin de ligne sur la ligne du module ''Syslog''.

Bien sûr, ce module ('''Syslog''') doit être activé pour que les traces fonctionnent.

La notion de '''facility''' de syslog est une notion de configuration pré-définie pour loguer les messages. C'est une fonctionnalité système pour dire à l'opérateur système d'où vient une erreur (ici Dolibarr) et indiquer sa priorité. Vous trouverez plus d'informations dans la documentation PHP pour la fonction ''openlog()'' function qui est utilisé dans la fonction ''dol_syslog()'': http://www.php.ne/openlog
En général, il vous faut laisser cette valeur à '''LOG_USER''', sauf si vous savez ce que vous faites.

L'option suivante, '''fichier''', permet de choisir dans quel fichier vous allez sauver les logs. Le chemin indiqué doit etre relatif à la racine (/). Si vous le laisser tel quel (option par défaut DOL_DATA_ROOT/dolibarr.log), il sera créé dans le répertoire documents de Dolibarr. Bien sûr, pour cela, votre serveur web doit avoir les droits en écriture sur ce répertoire.

En général, la facility '''fichier''' fonctionnera plus souvent car elle ne dépend pas de la configuration système de votre serveur, ni d'un éventuel démon syslog requis (le seul problème qui peut arriver est que le répertoire n'ait pas la permission d'écriture pour le seveur web).

Enfin, le niveau de rapport représente le nombre de types de messages que vous désirez voir. LOG_DEBUG(7) est l'option la plus verbeuse, affichant tout message qui passe par la fonction dol_syslog(). LOG_EMERG(0) est son contraire, ne traçant que les messages qui sont des erreurs graves.

Plus d'information sur la page [[Module Syslog (développeur)]].

=Autres logs systèmes rares=
Notez, qu'indépendamment du module syslog, vous pouvez aussi trouvez des erreurs techniques PHP/Apache dans les logs d'apache (quelquesoit l'état/configuration du module syslog). Mais cela n'arrive qu'en cas de probleme technique d'installation ou d'environnement. Une application Dolibarr qui fonctionne n'affichera jamais rien dans ces fichiers. Sur un système Linux standard, de telle traces sont visibles dans les fichiers '''/var/log/apache[2]/[dolibarr]-error.log'''. Vous pouvez les voir en ''live'' depuis un terminal avec la commande:
<source lang="bash">tail -f /var/log/apache2/dolibarr-error.log</source>

Développement module

2023-11-10T15:08:48Z

Kusco: /* Définir vos propres box (optionnel) */

[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" (ou "Module builder") dans la section "Outils multi-modules" de Configuration > Modules/Applications

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut d'ores et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''' : Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existent déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

À défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouvent des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Éditer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondant à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<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>

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

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par 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>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

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

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<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'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box/widgets (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/mabox1.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Boite'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

Module Adhérents

2023-10-16T14:55:37Z

Kusco: Correction orthographe et ponctuation

[[en:Module_Membership_management]]
[[es:Módulo_Miembros]]
[[de:Modul_Mitglieder]]
[[zh:会员管理模块]]


[[Category:Adhérent]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Adhérents|
num=310|
devdoc=[[Module Adhérents (développeur)]]|
userdoc=Cette page|}}

=Introduction=
Le module adhérent permet de gérer les adhérents d'une association.

*Définition de plusieurs types d'adhérent.
*Création/Validation/Modification/Résiliation/Suppression d'une fiche adhérent (caractéristiques, photos, ...)
*Notions d'adhérents soumis à cotisation ou non.
*Saisie/Modifications/Suppression des adhésions.
*En association avec le module [[Module Mailing|EMailing]], envoi de mailings aux adhérents ou à une certaine catégorie d'adhérents.
*En association avec le module [[Module LDAP|LDAP]], synchronisation des adhérents vers un annuaire LDAP.
*En association avec le module [[Module Banques et Caisses]], interaction avec les adhésions et la trésorerie de l'association.
*Reporting.
*Fonction générique d'exports avec le [[Module Exports]].

Les fonctions du module Adhérent sont centralisées dans le menu du haut "Adhérents".

Dolibarr fait de la gestion de la trésorerie, mais ne fait pas de comptabilité analytique. Cette lacune suffit pour dire que Dolibarr n'est pas adapté à une association de grosse taille (plus de 5000 adhérents).
Il n'y a pas non plus de module de gestion de la paie, ce qui limite là aussi son utilisation aux associations qui n'ont pas de salariés.
Le module de gestion d'association appelé "module Adhérents" est en fait orienté sur les petites associations. Un budget de 10 000 euros annuel me semble la cible type.

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

=Utilisation=

==Création d'un type d'adhérent==
Avant de commencer, il est nécessaire de définir les profils d'adhérents.
Pour cela, il faut créer un type d'adhérent via le menu ''Type d'adhérents'' puis ''Nouveau type''.

==Création des attributs personnalisés d'adhérent==
Si vous avez besoin de gérer des attributs particuliers sur les fiches adhérents qui ne seraient pas prévus (âge du capitaine, tour de poitrine), vous pouvez définir par le menu ''Attributs d'adhérents'' puis ''Nouvel attribut''.
Choisissez le libellé de l'attribut qui sera visible, son code (qui sera utilisé comme nom de champ dans la base de données), son type et la taille maximale.

==Création d'un adhérent==
Un adhérent passe par le cycle de vie suivant:

[[Image:Diagramme_etats_adherents.png|center|Diagramme d'états d'un adhérent]]

Pour créer un adhérent, on va dans le menu '''Adhérents - Nouvel adhérent''. Un formulaire de création est alors proposé.
Renseignez tous les champs et cliquez '''Créer'''.
Ensuite, on passe l'adhérent à l'état '''Validé''' en cliquant sur le bouton '''Valider''' sur la fiche adhérent.

Si on veut offrir un accès Dolibarr à ce membre, cliquer sur '''Créer un compte''' depuis sa fiche membre.
Si on veut manipuler un tiers propre à ce membre (pour facturation, devis), cliquer sur '''Créer un compte''' depuis sa fiche membre.

==Nouvelle adhésion ou renouvellement==

Une adhésion peut être vue comme une cotisation (un paiement). Toutefois, on emploie le terme d'adhésion pour certains types d'adhérents non soumis à cotisation et dans ce cas la cotisation est gratuite. Cela n'exclut pas que leur présence en tant que membre est limitée dans le temps au même titre que celui qui paie une cotisation. Le terme "adhésion" caractérise donc un renouvèlement à l'association à partir d'une date et pour une durée fixe, que ce renouvellement soit payant ou pas.

Pour saisir une adhésion, aller dans le menu ''Adhésion'' puis ''Nouvelle adhésion'' et saisir l'adhérent recherché.
Ou bien, aller sur la ''fiche adhérent'' puis ''onglet adhésion'' puis ''Nouvelle adhésion''.

L'historique des adhésions est conservé également l'onglet ''Adhésion'' de la fiche adhérent.

==Cas d'une adhésion payée en plusieurs fois==

Prenons le cas d'une adhésion payée en trois fois. Demandez à votre adhérent trois chèques dont la somme est égale à la cotisation qu'il doit. Puis, pour dolibarr, le principe est le même que ci-dessus.

Une fois que vous avec cliqué sur ''Nouvelle adhésion'', entrez la contre-partie correspondant au premier chèque, et spécifiez la période de validité, dans notre cas cela correspond à 1/3 de l'année. Puis, dans le champ ''Libellé,'' indiquez par exemple ''Adhésion 2008 1/3''. Puis validez par un clic sur ''ajout adhésion''. Recommencez l'opération deux fois de plus en adaptant les valeurs pour couvrir toute l'année.

==Résiliation d'adhérent==
Aller sur la fiche adhérent et cliquer sur le bouton ''Résilier''.

=Exemples de cas d'utilisation=

{{ExamplesCaseFr
|nom=UCFO01: L'association veut définir un nouveau type d'adhérent
|situation=L'association veut définir un nouveau type d'adhérent
|actions=Je crée un type d'adhérent par ''Menu Adhérents - Configuration - Types d'adhérents - Nouveau type d'adhérent''.
}}

{{ExamplesCaseFr
|nom=UCFO02: Un nouvel adhérent se présente avec un chèque ou en liquide
|situation=Un nouvel adhérent se présente avec un chèque ou en liquide
|actions=Je crée un adhérent par ''Menu Adhérents - Nouvel adhérent''.
Je crée une adhésion par onglet ''Adhésion''.
}}

{{ExamplesCaseFr
|nom=UCFO03: Un adhérent vient renouveler son adhésion avec un chèque ou en liquide
|situation=Un adhérent vient renouveler son adhésion avec un chèque ou en liquide
|actions=Je vais sur la fiche adhérent puis onglet ''Adhésion''.
Je saisis une nouvelle adhésion.
}}

{{ExamplesCaseFr
|nom=UCFO04: Je veux résilier un adhérent car son adhésion a expirée et non renouvelée depuis longtemps
|situation=Je veux résilier un adhérent car son adhésion a expirée et non renouvelée depuis longtemps
|actions=Je vais sur la fiche adhérent.
Je clique sur ''Résilier''.
}}

Développement module

2023-09-11T15:44:22Z

Kusco: Simple faute de frappe

[[en:モジュール_開発]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" dans la section "Outils multi-modules"

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut dors et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''': Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existe déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

A défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouve des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Editer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondants à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<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>

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

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par 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>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

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

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<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'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/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->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->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>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/mabox1.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Boite'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]