Dolibarr ERP CRM Wiki - User contributions [en]

Vincent de Grandpré

2025-11-09T17:12:49Z

Vdegrandpre: Version initiale

{| class="wikitable"
|
{| class="wikitable"
! colspan="2" |User card / Fiche compte / Ficha cuenta
|-
|Name/Nom/Nombre/Name/Όνομα
|Vincent de Grandpré
|-
|Country/Pays/Pais/Land/Χώρα
|Québec (form. Canada)
|-
|Company/Société/Empresa/Unternehmen/Εταιρεία
|de Grandpré Technologies
|-
|Web
|de-grandpre.quebec
|-
|Date/Datum/Ημερομηνία
|2023-07-01
|-
|Level/Grade/Grado/Grad/Επίπεδο
|[[Projet Dolibarr#D.C3.A9veloppeur grade Amiral .28R.C3.A9aliseur de GIT Pull Request.29|Amiral]] / [[Dolibarr Project#Developer grade Admiral .28GIT Pull Requesters.29|Admiral]]
|-
|Status/Statut/Estado/Κατάσταση
|[[:Category:User Active|Active]]
|-
|Picture/Photo/Foto/Φωτογραφία
|[[File:Vincent de Grandpré.png|thumb]]
|}
|}
'''Other informations / Autres informations / Otra información / Andere Infos / Άλλες πληροφορίες'''

Informaticien généraliste indépendant diplômé en Techniques de l'informatique - gestion (DEC) du Collège de Maisonneuve (2003) et en cheminement au baccalauréat en génie logiciel à l'École de technologie supérieure (Université du Québec). Entrepreneur en informatique, il a utilisé Dolibarr pour la première fois à la version 3 dans un cadre d'emploi. Au moment de s'occuper de la compagnie à temps plein, Dolibarr a été choisi comme ERP/CRM. Quelques années plus tard, une opportunité a permis de choisir Dolibarr comme plateforme sur-mesure pour un projet d'innovation en économie circulaire. Sous cette impulsion, la compagnie a débuté le développement sérieux de modules pour Dolibarr et soumis plusieurs changements et correctifs. En 2023, '''de Grandpré Technologies''' obtient le label [https://www.dolibarr.org/partners.php#countryid_14 Preffered Partner]. Il entre ainsi en contact avec les entreprises qui ont choisi Dolibarr qui l'embauchent pour de la consultation et du développement spécialisé métier. Il est l'auteur du module Québec et souhaite démarrer une communauté locale québécoise pour étendre l'adoption du logiciel et représente Dolibarr auprès de la communauté Linux au Québec.

File:Vincent de Grandpré.png

2025-11-09T16:29:57Z

Vdegrandpre:

Photo INIS, juin 2018

List of modules id

2025-01-02T17:53:47Z

Vdegrandpre: Auto-attribution ID 156750 - 156799

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

This page list all reserved modules numbers / ID. If you build or want to build your own modules (like thi , 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: backbone internet service (www.backbone.co.at) - 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: LAMAC Tech
*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 - 159999: '''Free (take ranges of 50 only please at once, ask us for more)'''
*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 - 179999: '''Free (take ranges of 50 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 - 182999: '''Free (take ranges of 50 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 - 189999: '''Free (take ranges of 50 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 50 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 - 212099: '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 212100 - 212149: Audio Vidéo Technologies (https://www.avtek.fr)
*ID 212150 - 221999: '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 223000 - 223049: Tráfico Canada
*ID 223050 - 229949: '''Free (take ranges of 50 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 50 only please at once, ask us for more)'''
*ID 262700 - 262799: Scopen (https://www.scopen.fr)
*ID 262800 - 274249: '''Free (take ranges of 50 only please at once, ask us for more)'''
*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 50 only please at once, ask us for more)'''
*ID 279000 - 279049: VSDigital Electronics (https://vsdigital.ar) - Argentina
*ID 279050 - 279999: '''Free (take ranges of 50 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 50 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 50 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 - 302499: '''Free (take ranges of 50 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 50 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 50 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 50 only please at once, ask us for more)'''
*ID 314150 - 314199: Benoît PASCAL
*ID 314200 - 319999: '''Free (take ranges of 50 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 - 329999: '''Free (take ranges of 50 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 50 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 50 only please at once, ask us for more)'''
*ID 333300 - 333349: Sense Africa (http://sense.africa)
*ID 333350 - 349999: '''Free (take ranges of 50 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 359000 - 359049: Milen Karaganski0
*ID 350100 - 399999: '''Free (take ranges of 50 only please at once, ask us for more)'''
*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 50 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 50 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 50 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 50 only please at once, ask us for more)'''
*ID 424000 - 424049: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 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: Letusgeek - France
*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 50 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: Free
*ID 438300 - 438399: '''Free (take ranges of 50 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 50 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 50 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: '''Free (take ranges of 50 only please at once, ask us for more)'''
*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 50 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 50 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 - 484999: '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 485000 - 485049: Gest Info Service Plus (contact@gest-plus.fr)
*ID 485050 - 489999: '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 490000 - 490049: VOLD (https://vold.lu)
*ID 490050 - 490999: '''Free (take ranges of 50 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://burofree.es)
*ID 491500 - 491549: EMDELEN (https://emdelen.fr/)
*ID 491550 - 491599: eSoUrCeS Technologie (https://techno.esources.ca/) - Canada
*ID 491600 - 491999: '''Free (take ranges of 50 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 499000 - 499999: 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).

Langages et normes

2023-11-09T13:51:40Z

Vdegrandpre: /* PHP */ remplacement par le bon nom de variable $_COOKIE au lieu de $_COOKIES

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


{{TemplateDocDev}}

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

=Versions=

*Dolibarr doit fonctionner sur:

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

=Normes Copyright=

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

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

=Normes PHP=

==PHP==

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

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

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

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

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

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

*Les chaines doivent avoir les variables sorties de la chaine.

<syntaxhighlight lang="PHP">
print "Mon texte affiche ma ".$variable." !\n";
</syntaxhighlight>

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

<syntaxhighlight lang="PHP">
/* Bloc de commentaire
*
* Fin du bloc
*/

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

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

</syntaxhighlight>

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

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

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

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

==Structures des classes et champs==

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

=Normes SQL=

==Structure des tables et champs==

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

*Structure des tables.

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

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

*Type des champs

Dans la pratique, afin d'être compatible avec toutes les précisions des pays, syntaxes des bases, on utilisera uniquement les types suivants:
- integer pour tout nombre entier, id ou clé étrangère (bigint éventuellement accepté pour les id des très grosses tables)
- smallint pour tout numérique entier de petite taille (comme pour stocker un code de status)
- double(24,8) pour tout montant
- double(6,3) pour les taux de tva
- real pour une quantité
- varchar pour une chaîne (y compris de longueur 1, le type char est de plus en plus déprécié)
- timestamp pour un champ date+heure devant être mis a jour automatiquement
- datetime pour un champ date+heure
- date pour un champ date

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

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

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

Exemple:
fk_facture_fourn_fk_soc

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

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

Exemple:
uk_societe_code_client

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

Exemple:
idx_societe_user_creat

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

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

Exemple '''fichier table llx_matable.sql''':

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

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

Exemple '''fichier clés/index llx_matable.key.sql''':

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

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

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

==Règles de codage SQL==

*Utilisation des alias/nommage de champs

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

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

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

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

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

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

*Les fonctions SQL de date NOW, SYSDATE, DATEDIFF sont interdites au sein des ordres SQL. S'il faut saisir la date du moment dans un champ, la valeur doit venir du PHP, par exemple par la fonction dol_now(), et non du moteur de base de données. Ceci pour les raisons suivantes:
**afin d'avoir une meilleure portabilité du code
**avoir une gestion correcte des TimeZone et ne pas dépendre du TimeZone de la base de donnée (le timezone de réference est le timezone de PHP et le timezone de la base de données peut être différent de celui-ci, aussi les conversions de date doivent se faire toute côté PHP).
**meilleurs performances (voir exemples et commentaire plus loin)

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

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

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

*L'instruction WITH ROLLUP est interdite :

Cette instruction ne doit pas être utilisée : Elle n'est pas gérée de la même manière par des bases de données différentes.
De plus, l'utilisation de WITH ROLLUP brise la pureté des données retournées. L'agrégation intermédiaire de génération de sous-totaux réalisée par cette instruction peut facilement être effectuée à l'aide de PHP et permet de conserver le tableau de données retourné propre (non corrompu par des données insérées artificiellement).
Outres son côté pas bien standardisé, en insérant des résultats de calculs au sein des données, donnant un résultat qui est un mixe donnée et calculs métiers d'aggrégation, la compréhension du code se trouve compliqué et même les évolutions du code sur ces agrégations plus possibles lorsque se complexifient.

*Utilisez $db->ifsql pour le IF SQL

N'incluez pas le IF dans votre requête SQL générée. Mais utilisez plutôt la méthode $db->ifsql() pour créer un SQL IF compatible avec toutes les bases de données SQL.

*Pas de DELETE CASCADE et ON UPDATE CASCADE

De telles instructions SQL sont interdites car elles contournent les règles métiers de l'application. Par exemple, s'il existe une cascade de suppression entre la table A et B, lorsque l'application exécutera le code pour supprimer un enregistrement dans A, les enfants de la table B seront également supprimés. S'il y a eu un trigger Dolibarr PHP (par exemple apporté par un module externe) sur la suppression de l'enregistrement de B (par exemple pour valider la suppression ou pour exécuter une action complémentaire), la DELETE CASCADE sera exécutée sans avoir le trigger Dolibarr PHP exécuté, manquant la validation ou les actions du déclencheur PHP du module. Donc toutes les règles métiers doivent être implémentées du même côté (côté serveur PHP), c'est la raison pour laquelle les règles métier implémentées sur Database ne sont pas autorisées (même situation que le point suivant sur les triggers Database)

==Règles de migration de base==

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

==Spécificités MySQL==

*Les tables doivent être au format InnoDB.

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

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

Pour l'activer (fortement recommandé en développement), ajouter la ligne suivante dans le fichier config du serveur Mysql (my.cnf ou my.ini)
{{MySqlStrictMode}}

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

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

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

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

=Normes HTML=

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

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

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

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

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

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

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

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

=Normes Dolibarr et squelettes de code=

==Squelettes de code==
Afin d'uniformiser le code et d'accélérer le développement de nouveaux composants dans Dolibarr, se trouvent dans le répertoire '''htdocs/modulebuilder/templates'''.

Par exemple:

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

...

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

==Variables globales==
Certaines informations ou objets sont communs et fixes pour toute l'exécution d'une page PHP et doivent être utilisés presque partout dans le code. Pour éviter de propager partout ces
informations ou objets, ils sont stockés dans des variables globales auxquelles vous pouvez accéder partout. Ces variables globales sont initialisées au début de chaque appel PHP (dans le master.inc.php ou master.inc.php ou en haut de la page). Ces objets ne sont normalement instanciés qu’une seule fois. La liste des variables globales disponibles est définie ici :
{{Template:TemplateGlobalVariables}}

*$conf est l'objet qui contient la configuration (enregistrée dans la base de données)
*$user est l'objet de l'utilisateur actuel
*$mysoc est l'objet contenant toutes les informations sur l'entreprise actuelle
*$langs est l'objet avec la langue actuelle
*$db est le gestionnaire de base de données de la connexion actuelle à la base de données
*$hookmanager est une classe d'usine pour gérer les hooks
*$extrafields est une classe d'usine pour gérer les extrafields

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

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

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

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

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

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

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

*En base de donnée, les données sont en UTF8 ou ISO. Cela dépend du pagecode de la base, donc des options à la création de cette base. Dans tous les cas le driver d'accès base Dolibarr (dans /lib/database) s'arrange à la lecture et insertion pour convertir vers et depuis de l'UTF8.
*Les données en mémoires sont donc stockées en UTF8 (instances d'objets PHP).
*Les pages web affichées à l'écran sont au format UTF8

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

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

==Comparer la version==

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

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

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

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

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

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

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

=Design patterns et programmation objet=

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

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

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

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

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

*Le '''Domain Model'''

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

*Le '''Table Module'''

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

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

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

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

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

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

*Le '''Active Record'''

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

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

*Le '''Data Mapper'''

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

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

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

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

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

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

==Design Pattern de Vue - Présentation==
Il existe des frameworks spécialisés dans le Design Pattern de Vue, la partie qui consiste à formater l'écran vue par l'utilisateur.
Les vieilles versions de Dolibarr utilisaient Smarty. Ce framework est une surcouche à un Framework, déjà très puissant, de formatage d'écran nommé... PHP. Les bénéfices étant très inférieurs aux inconvénients, il a été abandonné au profit de templates PHP (fichiers .php ou .tpl.php) qui restent le plus simple, le plus universel, le plus évolutif et le plus performant, des frameworks de présentation.

Son seul défaut est qu'il ne peut garantir à 100% les écarts d'un développeur qui irait intégrer dans la Vue, une logique sans rapport avec la présentation (donc autre que du code à vocation de génération, de formatage, de sortie HTML, de logique de test ou de boucle). Ce point est toutefois contrôlé par le mécanisme de validation du code des chefs de projets.

La encore, c'est l'expérience et le constat "sur le terrain" d'un meilleur rendement de productivité qui a motivé l'abandon des frameworks de Présentation externes au profit du framework PHP.

Dolibarr suppliers Canada

2023-10-17T00:22:36Z

Vdegrandpre: Mise à jour de fiche.

{{Dolibar_partners_list}}

{{TemplateCompany||country=Canada|desc=de Grandpré Technologies est une entreprise de consultation informatique québécoise enregistrée en 2003.

Son expertise est orientée autour des logiciels libres, des techniques de l'informatique, du génie logiciel et de la conception interactive.

Elle analyse, conçoit, développe, implémente et soutien des solutions informatiques pour ses clients.

Notamment, la société assiste les organisations dans leur transformation numérique et leurs différentes innovations.

Enfin, elle est officiellement partenaire Dolibarr depuis septembre 2023.
|email=clientele@de-grandpre.quebec|name=de Grandpré Technologies|service_dev=yes|service_emailsupport=yes|service_formation=yes|service_local=yes|service_onlinesupport=yes|town=Montréal|zip=H1T 3A7|web=https://de-grandpre.quebec/|phone=+1 438 380-6811}}

Dilamphis Group Officials 
1800 Barton Street East, Hamilton ON Canada. 
2 King street west, Hamilton ON, Canada. 
[https://dilamphis.com dilamphis.com] Hello@dilamphis.com 
Services provided: 
Dolibarr SaaS web hosting 
On premise/Virtual installation/setup 
On premise/virtual support 
Specific development & Training

Outils de développement - Composants optionnels

2023-08-04T15:24:43Z

Vdegrandpre: /* Prérequis : */

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<syntaxhighlight lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</syntaxhighlight>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<syntaxhighlight lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</syntaxhighlight>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<syntaxhighlight lang="bash">
sudo apt-get install php5-xdebug
</syntaxhighlight>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<syntaxhighlight lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</syntaxhighlight>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

'''NOTE :''' Les tests Selenium ne fonctionnent qu'avec PHPUnit 4, installé avec ''composer install''.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<syntaxhighlight lang="bash">
sudo pear upgrade PHP_CodeSniffer
</syntaxhighlight>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==

===Depuis Google Chrome et la ligne de commande===
Suivre ces étapes pour agencer un environnement de test Selenium pour vos modules.

====Prérequis====
Sur votre poste de développement / machine de test :

*Vous avez téléchargé selenium-server-standalone.jar en version 2.53.1 (ou dernière version de Selenium 2)
**https://github.com/SeleniumHQ/selenium/releases/download/selenium-2.53.1/selenium-server-standalone-2.53.1.jar
*Vous avez téléchargé chromedriver pour la version 83 de Google Chrome WebDriver
**https://chromedriver.storage.googleapis.com/index.html?path=83.0.4103.14/
**Le fichier binaire ''chromedriver'' est extrait et est exécutable (chmod +x)

====Agencement====
Commencer par lancer le serveur Selenium en spécifiant le chemin vers l'exécutable ''chromedriver.''

p. ex :<syntaxhighlight lang="bash">
~/Développement/selenium$ java -jar -Dwebdriver.chrome.driver=/home/[votre_usager]/chromedriver-linux64/chromedriver selenium-server-standalone-2.53.1.jar
</syntaxhighlight>
[[File:Capture d’écran de 2023-08-03 14-55-34.png|thumb]]

Ensuite, renseigner l'adresse de votre instance à tester dans le fichier de test (variable $base_url). et modifiez les paramètres $dol_admin_user et $dol_admin_password de sorte que ça corresponde à un identifiant valide, et modifier la fonction authenticate() du fichier de test pour utiliser ces variables ($login->value(self::$dol_admin_user); etc. ).

Enfin, exécuter la commande phpunit, sur le fichier de test à exécuter. Il faut utiliser le fichier binaire fourni avec Dolibarr. Alors, le test sera exécuté dans Selenium avec Chrome WebDriver sur votre instance.

L'instance n'a pas besoin d'être sur votre poste de développement.

P. ex. :<syntaxhighlight lang="bash">
~/dolibarr-dev/htdocs/custom/monmodule/test$ ../../../includes/bin/phpunit ./phpunit/functionnal/MonModuleFunctionalTest.php
</syntaxhighlight>

ModuleBuilder de Dolibarr créé déjà pour nous les méthodes de base pour tester un nouveau module et ses pages de configuration.

Enfin, vous voudrez vous assurer que le module Dolibarr Barre de débogue soit désactivé afin que l'outil automatisé puisse cliquer sur les boutons en bas de page.

Bons tests !

===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

Outils de développement - Composants optionnels

2023-08-03T19:23:45Z

Vdegrandpre: /* Agencement : */

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<syntaxhighlight lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</syntaxhighlight>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<syntaxhighlight lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</syntaxhighlight>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<syntaxhighlight lang="bash">
sudo apt-get install php5-xdebug
</syntaxhighlight>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<syntaxhighlight lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</syntaxhighlight>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

'''NOTE :''' Les tests Selenium ne fonctionnent qu'avec PHPUnit 4, installé avec ''composer install''.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<syntaxhighlight lang="bash">
sudo pear upgrade PHP_CodeSniffer
</syntaxhighlight>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==

===Depuis Google Chrome et la ligne de commande===
Suivre ces étapes pour agencer un environnement de test Selenium pour vos modules.

===='''Prérequis :'''====
Sur votre poste de développement / machine de test :

*Vous avez téléchargé selenium-server-standalone.jar en version 2.53.1 (ou dernière version de Selenium 2)
**https://github.com/SeleniumHQ/selenium/releases/download/selenium-2.53.1/selenium-server-standalone-2.53.1.jar
*Vous avez téléchargé chromedriver pour la version 83 de Google Chrome WebDriver
**https://chromedriver.storage.googleapis.com/index.html?path=83.0.4103.14/
**Le fichier binaire ''chromedriver'' est extrait et est exécutable (chmod +x)

====Agencement :====
Commencer par lancer le serveur Selenium en spécifiant le chemin vers l'exécutable ''chromedriver.''

p. ex :<syntaxhighlight lang="bash">
~/Développement/selenium$ java -jar -Dwebdriver.chrome.driver=/home/[votre_usager]/chromedriver-linux64/chromedriver selenium-server-standalone-2.53.1.jar
</syntaxhighlight>
[[File:Capture d’écran de 2023-08-03 14-55-34.png|thumb]]

Ensuite, renseigner l'adresse de votre instance à tester dans le fichier de test (variable $base_url). et modifiez les paramètres $dol_admin_user et $dol_admin_password de sorte que ça corresponde à un identifiant valide, et modifier la fonction authenticate() du fichier de test pour utiliser ces variables ($login->value(self::$dol_admin_user); etc. ).

Enfin, exécuter la commande phpunit, sur le fichier de test à exécuter. Il faut utiliser le fichier binaire fourni avec Dolibarr. Alors, le test sera exécuté dans Selenium avec Chrome WebDriver sur votre instance.

L'instance n'a pas besoin d'être sur votre poste de développement.

P. ex. :<syntaxhighlight lang="bash">
~/dolibarr-dev/htdocs/custom/monmodule/test$ ../../../includes/bin/phpunit ./phpunit/functionnal/MonModuleFunctionalTest.php
</syntaxhighlight>

ModuleBuilder de Dolibarr créé déjà pour nous les méthodes de base pour tester un nouveau module et ses pages de configuration.

Bons tests !

===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

Outils de développement - Composants optionnels

2023-08-03T19:22:22Z

Vdegrandpre: /* Agencement : */

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<syntaxhighlight lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</syntaxhighlight>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<syntaxhighlight lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</syntaxhighlight>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<syntaxhighlight lang="bash">
sudo apt-get install php5-xdebug
</syntaxhighlight>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<syntaxhighlight lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</syntaxhighlight>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

'''NOTE :''' Les tests Selenium ne fonctionnent qu'avec PHPUnit 4, installé avec ''composer install''.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<syntaxhighlight lang="bash">
sudo pear upgrade PHP_CodeSniffer
</syntaxhighlight>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==

===Depuis Google Chrome et la ligne de commande===
Suivre ces étapes pour agencer un environnement de test Selenium pour vos modules.

===='''Prérequis :'''====
Sur votre poste de développement / machine de test :

*Vous avez téléchargé selenium-server-standalone.jar en version 2.53.1 (ou dernière version de Selenium 2)
**https://github.com/SeleniumHQ/selenium/releases/download/selenium-2.53.1/selenium-server-standalone-2.53.1.jar
*Vous avez téléchargé chromedriver pour la version 83 de Google Chrome WebDriver
**https://chromedriver.storage.googleapis.com/index.html?path=83.0.4103.14/
**Le fichier binaire ''chromedriver'' est extrait et est exécutable (chmod +x)

====Agencement :====
Commencer par lancer le serveur Selenium en spécifiant le chemin vers l'exécutable ''chromedriver.''

p. ex :<syntaxhighlight lang="bash">
~/Développement/selenium$ java -jar -Dwebdriver.chrome.driver=/home/[votre_usager]/chromedriver-linux64/chromedriver selenium-server-standalone-2.53.1.jar
</syntaxhighlight>
[[File:Capture d’écran de 2023-08-03 14-55-34.png|thumb]]

Ensuite, renseigner l'adresse de votre instance à tester dans le fichier de test (variable $base_url). et modifiez les paramètres $dol_admin_user et $dol_admin_password de sorte que ça corresponde à un identifiant valide, et modifier la fonction authenticate() du fichier de test pour utiliser ces variables ($login->value(self::$dol_admin_user); etc. ).

Enfin, exécuter la commande phpunit sur le fichier de test à exécuter, pour utiliser le fichier binaire fourni avec Dolibarr va exécuter le test dans Selenium avec Chrome WebDriver.

P. ex. :<syntaxhighlight lang="bash">
~/dolibarr-dev/htdocs/custom/monmodule/test$ ../../../includes/bin/phpunit ./phpunit/functionnal/MonModuleFunctionalTest.php
</syntaxhighlight>

ModuleBuilder de Dolibarr créé déjà pour nous les méthodes de base pour tester un nouveau module et ses pages de configuration.

Bons tests !

===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

Outils de développement - Composants optionnels

2023-08-03T19:15:18Z

Vdegrandpre: /* Agencement : */

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<syntaxhighlight lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</syntaxhighlight>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<syntaxhighlight lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</syntaxhighlight>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<syntaxhighlight lang="bash">
sudo apt-get install php5-xdebug
</syntaxhighlight>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<syntaxhighlight lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</syntaxhighlight>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

'''NOTE :''' Les tests Selenium ne fonctionnent qu'avec PHPUnit 4, installé avec ''composer install''.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<syntaxhighlight lang="bash">
sudo pear upgrade PHP_CodeSniffer
</syntaxhighlight>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==

===Depuis Google Chrome et la ligne de commande===
Suivre ces étapes pour agencer un environnement de test Selenium pour vos modules.

===='''Prérequis :'''====
Sur votre poste de développement / machine de test :

*Vous avez téléchargé selenium-server-standalone.jar en version 2.53.1 (ou dernière version de Selenium 2)
**https://github.com/SeleniumHQ/selenium/releases/download/selenium-2.53.1/selenium-server-standalone-2.53.1.jar
*Vous avez téléchargé chromedriver pour la version 83 de Google Chrome WebDriver
**https://chromedriver.storage.googleapis.com/index.html?path=83.0.4103.14/
**Le fichier binaire ''chromedriver'' est extrait et est exécutable (chmod +x)

====Agencement :====
Commencez par lancer le serveur Selenium en spécifiant le chemin vers l'exécutable ''chromedriver.''

p. ex :<syntaxhighlight lang="bash">
~/Développement/selenium$ java -jar -Dwebdriver.chrome.driver=/home/[votre_usager]/chromedriver-linux64/chromedriver selenium-server-standalone-2.53.1.jar
</syntaxhighlight>
[[File:Capture d’écran de 2023-08-03 14-55-34.png|thumb]]

Ensuite, renseignez l'adresse de votre instance à tester dans le fichier de test (variable $base_url). et modifiez les paramètres $dol_admin_user et $dol_admin_password de sorte que ça corresponde à un identifiant valide, et modifier la fonction authenticate() du fichier de test pour utiliser ces variables ($login->value(self::$dol_admin_user); etc. ).

Enfin, exécuter la commande phpunit sur le fichier de test à exécuter, pour utiliser le fichier binaire fourni avec Dolibarr va exécuter le test dans Selenium avec Chrome WebDriver.

P. ex. :<syntaxhighlight lang="bash">
~/dolibarr-dev/htdocs/custom/monmodule/test$ ../../../includes/bin/phpunit ./phpunit/functionnal/MonModuleFunctionalTest.php
</syntaxhighlight>

ModuleBuilder de Dolibarr créé déjà pour nous les méthodes de base pour tester un nouveau module et ses pages de configuration.

Bons tests !

===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

Outils de développement - Composants optionnels

2023-08-03T19:14:24Z

Vdegrandpre: /* Pour développer ou utiliser les tests Selenium */

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<syntaxhighlight lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</syntaxhighlight>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<syntaxhighlight lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</syntaxhighlight>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<syntaxhighlight lang="bash">
sudo apt-get install php5-xdebug
</syntaxhighlight>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<syntaxhighlight lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</syntaxhighlight>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

'''NOTE :''' Les tests Selenium ne fonctionnent qu'avec PHPUnit 4, installé avec ''composer install''.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<syntaxhighlight lang="bash">
sudo pear upgrade PHP_CodeSniffer
</syntaxhighlight>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==

=== Depuis Google Chrome et la ligne de commande ===
Suivre ces étapes pour agencer un environnement de test Selenium pour vos modules.

==== '''Prérequis :''' ====
Sur votre poste de développement / machine de test :

* Vous avez téléchargé selenium-server-standalone.jar en version 2.53.1 (ou dernière version de Selenium 2)
** https://github.com/SeleniumHQ/selenium/releases/download/selenium-2.53.1/selenium-server-standalone-2.53.1.jar
* Vous avez téléchargé chromedriver pour la version 83 de Google Chrome WebDriver
** https://chromedriver.storage.googleapis.com/index.html?path=83.0.4103.14/
** Le fichier binaire ''chromedriver'' est extrait et est exécutable (chmod +x)

==== Agencement : ====
Commencez par lancer le serveur Selenium en spécifiant le chemin vers l'exécutable ''chromedriver.''

p. ex :<syntaxhighlight lang="bash">
~/Développement/selenium$ java -jar -Dwebdriver.chrome.driver=/home/[votre_usager]/chromedriver-linux64/chromedriver selenium-server-standalone-2.53.1.jar
</syntaxhighlight>
[[File:Capture d’écran de 2023-08-03 14-55-34.png|thumb]]

Ensuite, renseignez l'adresse de votre instance à tester dans le fichier de test (variable $base_url). et modifiez les paramètres $dol_admin_user et $dol_admin_password de sorte que ça corresponde à un identifiant valide, et modifier la fonction authenticate() du fichier de test pour utiliser ces variables ($login->value(self::$dol_admin_user); etc. ).

Enfin, exécuter la commande phpunit sur fichier de test à exécuter, pour utiliser le fichier binaire fourni avec Dolibarr va exécuter le test dans Selenium avec Chrome WebDriver.

P. ex. :<syntaxhighlight lang="bash">
~/dolibarr-dev/htdocs/custom/monmodule/test$ ../../../includes/bin/phpunit ./phpunit/functionnal/MonModuleFunctionalTest.php
</syntaxhighlight>

ModuleBuilder de Dolibarr créé déjà pour nous les méthodes de base pour tester un nouveau module et ses pages de configuration.

Bons tests !

===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

File:Capture d’écran de 2023-08-03 15-12-54.png

2023-08-03T19:13:26Z

Vdegrandpre:

Test en exécution.

File:Capture d’écran de 2023-08-03 14-55-34.png

2023-08-03T18:56:18Z

Vdegrandpre:

Serveur Selenium démarré

Module Collecteur de courrier électronique

2023-07-07T16:32:27Z

Vdegrandpre: /* Introduction */

[[en:Module_EMail_Collector]]


{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Collecteur de courrier électronique|
num=50320|
devdoc=[[Module Collecteur de courrier électronique (développeur)]]|
userdoc=Cette page}}

=Introduction=
Ajoute un travail planifié et une page de configuration pour analyser régulièrement les boîtes aux lettres (à l'aide du protocole IMAP) et enregistrer les courriers électroniques reçus dans votre application, au bon endroit et/ou créer automatiquement certains enregistrements (comme des opportunités).

Voir Quoi de neuf dans Dolibarr v10 : https://youtu.be/GaLi7uTYEm8?t=48 + https://youtu.be/lcUBteiW7gA?t=2887

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

Pour déplacer un mail qui a été chargé, il est nécessaire de que le nom du dossier ne comporte pas de caractère spécial.

=Utilisation=

Laissez le planificateur de travaux s'exécuter automatiquement et voyez vos données enregistrées dans Dolibarr.

Pour éviter d'attendre trop, vous pouvez forcer à exécuter manuellement le collecteur d'e-mails depuis la fiche du collecteur d'e-mails avec le bouton "Exécuter maintenant". Lors du test, une bonne pratique consiste à définir le nombre maximum d'e-mails collectés sur une valeur faible.

Module Collecteur de courrier électronique

2023-07-07T16:31:31Z

Vdegrandpre: /* Installation */

[[en:Module_EMail_Collector]]


{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Collecteur de courrier électronique|
num=50320|
devdoc=[[Module Collecteur de courrier électronique (développeur)]]|
userdoc=Cette page}}

=Introduction=
Ajoute un travail planifié et une page de configuration pour analyser régulièrement les boîtes aux lettres (à l'aide du protocole IMAP) et enregistrer les courriers électroniques reçus dans votre application, au bon endroit et/ou créer automatiquement certains enregistrements (comme des opportunités).

Voir Quoi de neuf dans Dolibarr v10 : <nowiki>https://youtu.be/GaLi7uTYEm8?t=48</nowiki> + <nowiki>https://youtu.be/lcUBteiW7gA?t=2887</nowiki>

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

Pour déplacer un mail qui a été chargé, il est nécessaire de que le nom du dossier ne comporte pas de caractère spécial.

=Utilisation=

Laissez le planificateur de travaux s'exécuter automatiquement et voyez vos données enregistrées dans Dolibarr.

Pour éviter d'attendre trop, vous pouvez forcer à exécuter manuellement le collecteur d'e-mails depuis la fiche du collecteur d'e-mails avec le bouton "Exécuter maintenant". Lors du test, une bonne pratique consiste à définir le nombre maximum d'e-mails collectés sur une valeur faible.

Module EMail Collector

2023-07-07T16:30:19Z

Vdegrandpre: /* Examples and explanation of some collectors */

[[fr:Module_Collecteur_de_courrier_électronique]]



{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=EMailCollector|
num=50320|
devdoc=[[Module EMail Collector (developer)]]|
userdoc=This page}}

=Introduction=
This module permits to collect emails from a mailbox using the IMAP protocol and record event or data in your Dolbarr using information found into email.

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}

==Create an email collector==

Create as many email collector you need.

'''Source directory'''

*To collect received email, enter here "INBOX"
*To collect email sent, enter here "Sent"

'''Target directory'''
A good practice is to move the collected email into another folder to avoid to have them collected twice.
You must create the output target IMAP directory manually before running your email collector.

For example, with Gmail, to create a new IMAP directory:

*Sign in to your Gmail account.
*At the top right of the Gmail window, click Settings See all settings.
*Click Labels.
*Create Label and check the box "Show in IMAP"

'''Filters'''

'''Operations to do'''

=Examples and explanation of some collectors=

What's new in Dolibarr v10 : https://youtu.be/GaLi7uTYEm8?t=48 + https://youtu.be/lcUBteiW7gA?t=2887

=Usage=
Let the job scheduler being executed automatically and see your data being recorded into Dolibarr.

To avoid to wait the batch, you can force to execute the email collector manually from the Email collector record with the button "Run now". When making test, a good practice is to set the maximum number of email collected to a low value.

Module EMail Collector

2023-07-06T19:45:00Z

Vdegrandpre: /* Examples and explanation of some collectors */

[[fr:Module_Collecteur_de_courrier_électronique]]



{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=EMailCollector|
num=50320|
devdoc=[[Module EMail Collector (developer)]]|
userdoc=This page}}

=Introduction=
This module permits to collect emails from a mailbox using the IMAP protocol and record event or data in your Dolbarr using information found into email.

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}

==Create an email collector==

Create as many email collector you need.

'''Source directory'''

*To collect received email, enter here "INBOX"
*To collect email sent, enter here "Sent"

'''Target directory'''
A good practice is to move the collected email into another folder to avoid to have them collected twice.
You must create the output target IMAP directory manually before running your email collector.

For example, with Gmail, to create a new IMAP directory:

*Sign in to your Gmail account.
*At the top right of the Gmail window, click Settings See all settings.
*Click Labels.
*Create Label and check the box "Show in IMAP"

'''Filters'''

'''Operations to do'''

=Examples and explanation of some collectors=

Nouveautés de Dolibarr v10 : https://youtu.be/GaLi7uTYEm8?t=48 + https://youtu.be/lcUBteiW7gA?t=2887

=Usage=
Let the job scheduler being executed automatically and see your data being recorded into Dolibarr.

To avoid to wait the batch, you can force to execute the email collector manually from the Email collector record with the button "Run now". When making test, a good practice is to set the maximum number of email collected to a low value.

Outils de développement - Composants optionnels

2022-12-09T22:47:30Z

Vdegrandpre: /* En ligne de commande manuelle */ note sur les tests Selenium

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<source lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</source>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<source lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</source>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<source lang="bash">
sudo apt-get install php5-xdebug
</source>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<source lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</source>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit ====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

'''NOTE :''' Les tests Selenium ne fonctionnent qu'avec PHPUnit 4, installé avec ''composer install''.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<source lang="bash">
sudo pear upgrade PHP_CodeSniffer
</source>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==
===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

Outils de développement

2022-12-09T21:51:24Z

Vdegrandpre: retrait du titre redondant

{{TemplateDocDevFr}}

Tout environnement de développement peut être utilisé.
Toutefois voici une liste d'outils fortement recommandés pour leur complétude, leur qualité et la productivité du développement qu'ils apportent. Ils sont utilisés par la plupart des développeurs principaux de Dolibarr. Notons que toutes ces solutions sont gratuites et OpenSource.

=[[File:Eclipsephp.jpg]] Pour tout développeur=

Voici le socle de travail recommandé, toutefois tout outil respectant les standards Web, PHP, Mysql peuvent faire l'affaire.

==Un serveur AMP==

*Apache, MariaDB et PHP

Sur Linux: Ces 3 produits sont disponibles dans toutes distributions.

Sur Windows: Installez [http://www.wampserver.com/WampServer] (base MariaDB, Apache et PHP tout clé en main). Ce serveur WAMP offre le trio MariaDB + Apache + PHP, avec possibilité de basculer de version pour n'importe lequel de ces composants d'un simple clic).

==Chrome ou Firefox et plugins==

*Chrome

A télécharger depuis le site http://www.chrome.com

*Firefox avec les plugins:
**Firebug + Firecookie + FirePHP,
**HTML Validator,
**User agent switcher pour simuler des accès depuis un smartphone
**Selenium IDE
**Cert Viewer Plus si vous comptez faire des tests en HTTPS,
**QuickProxy si vous voulez basculer rapidement votre navigateur vers des utilitaires Proxy (WebScarab)...

A télécharger depuis le site http://www.firefox.com

==Un outil d'accès aux bases de données==

Exemple:

*SquirrelSQL pour l'administration de base - A télécharger depuis le site http://squirrel-sql.sf.net
*DBeaver - https://dbeaver.io/

==IDE (Eclipse, VSCode) et plugins==

===Eclipse===

====Installation d'Eclipse====
Nous recommandons la version suivante d'Eclipse:

{{DownloadEclipse}}

Sinon toute version disponible sur le site [http://www.eclipse.org Eclipse] fait l'affaire.

Une fois Eclipse installé, il est recommandé de modifier/vérifier les paramètres suivants:
{{EclipseStandardSetup}}

====Installation du plugin Eclipse pour PHP: PDT.====
Avec certaines installations d'Eclipse, PDT peut etre installé depuis Help -> Install new software et choisir PDT.
Si PDT n'est pas présent, si vous avez installé la version Eclipse ci-dessus, il suffit d'utiliser la procédure Help -> Install new software -> Add -> pour installer le package complémentaire:

{{DownloadEclipsePDT}}

Une fois PDT installé, il faut aussi le configurer dans Eclipse comme défini dans le chapitre [[Outils_de_développement_-_Composants_optionnels#Depuis_Eclipse]].

====Configurer Eclipse pour récupérer les sources====
Une fois qu'Eclipse est installé, vous pouvez vous connecter au repository GIT pour y récupérer les dernières versions de développement.

Pour cela, voir la page [[FAQ Récupérer, mettre à jours les sources GIT du projet]].

===VSCode===

===={{DownloadVSCode}}====

==Git Hooks==

===Installer le hook git Pre-commit===
L'utilisation de ce hook git est essentiel pour vérifier la syntaxe des fichiers qui sont commit et pouvoir annuler celui-ci si la syntaxe est mauvaise. Si phpcs et phpcbf sont installés, la syntaxe peut être modifiée automatiquement. Voici comment faire:

Allez dans '''/dev/setup/git/hooks''' de votre dépôt local, copiez le fichier '''pre-commit''' dans le dossier '''.git/hooks''' se trouvant a la racine de votre dépôt git local et rendez-le exécutable.

Ensuite, il est nécessaire d'éditer le fichier '''pre-commit''' présent dans '''.git/hooks''' pour modifier la variable DIRPHPCS pour ajouter le chemin des outils phpcs et phpcbf (le laisser vide si les outils sont disponibles dans la variable PATH).

Ce type de hook est utilisé lorsqu'on utilise l'invité de commande mais aussi lorsque qu'un commit est créé avec un IDE commun (exemple Eclipse et Virtual Studio Code). Une fois installé, le hook démarrera lors de votre prochain commit pour reformater votre code, pour que votre code corresponde toujours aux règles de syntaxe de codage. Si tout le monde active ce hook, tout le monde utilisera la même règle de syntaxe de codage, il est donc fortement recommandé de l'activer si vous le pouvez.

=[[File:Computer.png]] Optionnel=
Vous pouvez aussi installer des composants optionnels pour avoir le support de technologies suplémentaires.
Voir la page [[Outils de développement - Composants optionnels]].

Outils de développement - Composants optionnels

2022-12-09T20:33:46Z

Vdegrandpre: Configuration XDebug pour VSCode

{{TemplateDocDev}}
Cette page liste les composants et autres technologies supplémentaires que vous pourriez vouloir installer sur votre environnement de développement. Elles ne sont pas requises pour développer sur Dolibarr, ni pour réaliser des modules mais peuvent être utiles pour des travaux très particuliers.

==Si vous désirez faire des scripts en Perl==

*Installation du plugin Eclipse pour Perl: EPIC

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

==Si vous désirez faire des scripts en Python==

*Installation du plugin Eclipse pour PyThon: PyDev

Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://pydev.org/updates

==Si vous êtes sous Windows==

*Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

*WinMerge (pour la comparaison de fichiers ou répertoires)

*CygWin (pour la commande patch si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

==Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug)==

*Pour ajouter des infos de tuning page dans la console javascript à partir de Dolibarr 3.8, ajouter la variable d'environnement MAIN_SHOW_TUNING_INFO à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:

<source lang="ini">
SetEnv MAIN_SHOW_TUNING_INFO 1
</source>

*Pour du tuning à la ligne de code près, installer XDebug:

===[[File:Logo_windows.png|24px]] In Windows===

*Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

*Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:

<source lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
</source>

===[[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux===

*Installer le package '''php-xdebug''':

<source lang="bash">
sudo apt-get install php5-xdebug
</source>

*Modifier xdebug.ini pour ajouter les paramètres suivants après les lignes de type zend_extension=xxx (ou similaire):

<source lang="ini">
; With xdebug 2.1 and more
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/tmp
xdebug.profiler_append=0
xdebug.profiler_enable=0
xdebug.profiler_enable_trigger=1
; Add also this for xdebug 2.2 and more
xdebug.show_mem_delta=1
xdebug.trace_output_dir=/tmp
xdebug.auto_trace=0
xdebug.trace_enable_trigger=1
</source>

===[[File:Eclipsephp.jpg|24px]] Eclipse configuration===

*Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisir le navigateur par défaut de votre système.

*Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

*Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

*Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

*Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

Ensuite pour analyser les fichiers de profiling générés par XDebug, il faut appeler l'url avec XDEBUG_PROFILE=1 pour générer le fichier profiling puis installer KCacheGrind (Linux) ou WinCacheGrind (Windows) pour l'analyser.

===Visual Studio Code (VSCode)===
Pour fonctionner sous VSCode, la configuration XDebug se fait par un fichier client, par exemple avec le port 9000 :
=====Configuration dans l'IDE=====
Fichier de projet : .vscode/launch.json

Pour plus d'informations, visitez : [https://go.microsoft.com/fwlink/?linkid=830387 la documentation de l'éditeur]

<syntaxhighlight lang="json" line="1" start="1">
{
// Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
// Pointez pour afficher la description des attributs existants.
// Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Écouter pour Xdebug",
"type": "php",
"request": "launch",
"port": 9000,
"pathMappings": {
"/vagrant/dolibarr/": "${workspaceRoot}"
},
"log": true
}
]
}
</syntaxhighlight>

Noter à la ligne '''13''' la clé est le chemin du serveur web qui correspond à la racine du projet (dans cet exemple, le dossier racine Dolibarr).

=====Configuration dans le php.ini du serveur web=====

En plus de ce qui est écrit plus haut, ajouter à la section xdebug de php.ini :

<syntaxhighlight lang="ini">
xdebug.remote_autostart = true
</syntaxhighlight>

==Pour développer ou utiliser les contrôles Qualité (PHPUnit, PHPCodeSniffer, PHPCpd, PHPDepends)==
===Depuis Eclipse===
Le plugin PTI pour utiliser PHPUnit et PHPCodesniffer est maintenant abandonnée.

*Pour utiliser PHPUnit, ceci est disponible en standard dans une installation de base d'Eclipse.

*Pour utiliser PHPCodesniffer, vous pouvez créer une entrée "External Tools" avec une configuration de ce type

[[Image:Setup_phpcs.png]]

===En ligne de commande manuelle===
====Installer PHPUnit====

*Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
*Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
*Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

====Exécuter les tests PHPUnit====

*Aller dans le répertoire '''/test''' des sources. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer un ou plusieurs tests PHPUnit.

====Installer les autres outils====

*Référez vous à la documentation des différents outils (PHPCodeSniffer, PHPCpd, PHPDepends) pour leur installation et utilisation en ligne de commande. Par exemple, pour installer ou mettre à jour PHPCodeSniffer:

<source lang="bash">
sudo pear upgrade PHP_CodeSniffer
</source>
Les librairies pear seront installées dans '''/usr/share/php/PHP''' mais pour les prendre en compte avec Eclipse PTI, il faut ajouter une entrée "PHP" sur '''/usr/share/php''' et configurer PHPCheckstyle pour utiliser cette entrée.

==Pour développer ou utiliser les tests Selenium==
===Depuis Firefox===
====Installer le plugin pour Firefox Selenium IDE====

*Télécharger le fichier du plugin Selenium IDE pour Firefox.
*L'ajouter dans Outils - Modules complémentaires de Firefox.

====Exécuter les tests Selenium====

*Aller dans le menu Outils - Selinum IDE de firefox.
*Ouvrir le fichier de tests xml
*Executer le test.

==Pour générer la documentation Doxygen==

*Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
*Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

==Pour ajouter le support asciidoc à Eclipse==

Ajouter l'URL http://download.eclipse.org/mylyn/snapshots/nightly/docs/ dans les Install repositories. Puis installer le package '''Mylyn Docs - Mylyn Wikitext Extras'''

Outils de développement

2022-12-09T20:23:46Z

Vdegrandpre: Installation de VSCode

{{TemplateDocDevFr}}

Tout environnement de développement peut être utilisé.
Toutefois voici une liste d'outils fortement recommandés pour leur complétude, leur qualité et la productivité du développement qu'ils apportent. Ils sont utilisés par la plupart des développeurs principaux de Dolibarr. Notons que toutes ces solutions sont gratuites et OpenSource.

=[[File:Eclipsephp.jpg]] Pour tout développeur=

Voici le socle de travail recommandé, toutefois tout outil respectant les standards Web, PHP, Mysql peuvent faire l'affaire.

==Un serveur AMP==

*Apache, MariaDB et PHP

Sur Linux: Ces 3 produits sont disponibles dans toutes distributions.

Sur Windows: Installez [http://www.wampserver.com/WampServer] (base MariaDB, Apache et PHP tout clé en main). Ce serveur WAMP offre le trio MariaDB + Apache + PHP, avec possibilité de basculer de version pour n'importe lequel de ces composants d'un simple clic).

==Chrome ou Firefox et plugins==

*Chrome

A télécharger depuis le site http://www.chrome.com

*Firefox avec les plugins:
**Firebug + Firecookie + FirePHP,
**HTML Validator,
**User agent switcher pour simuler des accès depuis un smartphone
**Selenium IDE
**Cert Viewer Plus si vous comptez faire des tests en HTTPS,
**QuickProxy si vous voulez basculer rapidement votre navigateur vers des utilitaires Proxy (WebScarab)...

A télécharger depuis le site http://www.firefox.com

==Un outil d'accès aux bases de données==

Exemple:

*SquirrelSQL pour l'administration de base - A télécharger depuis le site http://squirrel-sql.sf.net
*DBeaver - https://dbeaver.io/

==IDE (Eclipse, VSCode) et plugins==

===Eclipse===

====Installation d'Eclipse====
Nous recommandons la version suivante d'Eclipse:

{{DownloadEclipse}}

Sinon toute version disponible sur le site [http://www.eclipse.org Eclipse] fait l'affaire.

Une fois Eclipse installé, il est recommandé de modifier/vérifier les paramètres suivants:
{{EclipseStandardSetup}}

====Installation du plugin Eclipse pour PHP: PDT.====
Avec certaines installations d'Eclipse, PDT peut etre installé depuis Help -> Install new software et choisir PDT.
Si PDT n'est pas présent, si vous avez installé la version Eclipse ci-dessus, il suffit d'utiliser la procédure Help -> Install new software -> Add -> pour installer le package complémentaire:

{{DownloadEclipsePDT}}

Une fois PDT installé, il faut aussi le configurer dans Eclipse comme défini dans le chapitre [[Outils_de_développement_-_Composants_optionnels#Depuis_Eclipse]].

====Configurer Eclipse pour récupérer les sources====
Une fois qu'Eclipse est installé, vous pouvez vous connecter au repository GIT pour y récupérer les dernières versions de développement.

Pour cela, voir la page [[FAQ Récupérer, mettre à jours les sources GIT du projet]].

===VSCode===

==== Installation de VSCode ====

==== {{DownloadVSCode}} ====

==Git Hooks==

===Installer le hook git Pre-commit===
L'utilisation de ce hook git est essentiel pour vérifier la syntaxe des fichiers qui sont commit et pouvoir annuler celui-ci si la syntaxe est mauvaise. Si phpcs et phpcbf sont installés, la syntaxe peut être modifiée automatiquement. Voici comment faire:

Allez dans '''/dev/setup/git/hooks''' de votre dépôt local, copiez le fichier '''pre-commit''' dans le dossier '''.git/hooks''' se trouvant a la racine de votre dépôt git local et rendez-le exécutable.

Ensuite, il est nécessaire d'éditer le fichier '''pre-commit''' présent dans '''.git/hooks''' pour modifier la variable DIRPHPCS pour ajouter le chemin des outils phpcs et phpcbf (le laisser vide si les outils sont disponibles dans la variable PATH).

Ce type de hook est utilisé lorsqu'on utilise l'invité de commande mais aussi lorsque qu'un commit est créé avec un IDE commun (exemple Eclipse et Virtual Studio Code). Une fois installé, le hook démarrera lors de votre prochain commit pour reformater votre code, pour que votre code corresponde toujours aux règles de syntaxe de codage. Si tout le monde active ce hook, tout le monde utilisera la même règle de syntaxe de codage, il est donc fortement recommandé de l'activer si vous le pouvez.

=[[File:Computer.png]] Optionnel=
Vous pouvez aussi installer des composants optionnels pour avoir le support de technologies suplémentaires.
Voir la page [[Outils de développement - Composants optionnels]].

Template:DownloadVSCode

2022-12-09T19:38:42Z

Vdegrandpre: Ajout des instructions de téléchargement de VSCode

Voir [https://code.visualstudio.com/docs/setup/setup-overview les instructions d'installation de l'éditeur].

Dolibarr suppliers Canada

2022-12-08T16:46:41Z

Vdegrandpre: Correction de texte de description VdeG

{{Dolibar_partners_list}}

{{TemplateCompany||country=Canada|desc=de Grandpré Technologies est une entreprise de consultation informatique québécoise enregistrée en 2003.

Son expertise est orientée autour des logiciels libres, des techniques de l'informatique, du génie logiciel et de la conception interactive.

Elle analyse, conçoit, développe, implémente et soutien des solutions informatiques pour ses clients.

Notamment, la société assiste les organisations dans leur transformation numérique et leurs différentes innovations.|email=public@de-grandpre.quebec|name=de Grandpré Technologies|profid=NEQ : 2261373437|service_dev=yes|service_emailsupport=yes|service_formation=yes|service_local=yes|service_onlinesupport=yes|town=Montréal|zip=H1T 3A7|web=https://de-grandpre.quebec/|phone=+1 438 380-6811}}

Dilamphis Group Officials 
1800 Barton Street East, Hamilton ON Canada. 
2 King street west, Hamilton ON, Canada. 
[https://dilamphis.com dilamphis.com] Hello@dilamphis.com 
Services provided: 
Dolibarr SaaS web hosting 
On premise/Virtual installation/setup 
On premise/virtual support 
Specific development & Training

Dolibarr suppliers Canada

2022-12-08T16:42:53Z

Vdegrandpre: Ajout du fournisseur québécois « de Grandpré Technologies » (Vincent de Grandpré).

{{Dolibar_partners_list}}

{{TemplateCompany||country=Canada|desc=de Grandpré Technologies est une entreprise de consultation informatique québécoise enregistrée depuis 2003.

Son expertise est orientée autour des logiciels libres, des techniques de l'informatique, du génie logiciel et de la conception interactive.

Elle analyse, conçoit, développe, implémente et soutien des solutions informatiques pour ses clients.

Notamment, la société assiste les organisations dans leur transformation numérique et leurs différentes innovations.|email=public@de-grandpre.quebec|name=de Grandpré Technologies|profid=NEQ : 2261373437|service_dev=yes|service_emailsupport=yes|service_formation=yes|service_local=yes|service_onlinesupport=yes|town=Montréal|zip=H1T 3A7|web=https://de-grandpre.quebec/|phone=+1 438 380-6811}}

Dilamphis Group Officials 
1800 Barton Street East, Hamilton ON Canada. 
2 King street west, Hamilton ON, Canada. 
[https://dilamphis.com dilamphis.com] Hello@dilamphis.com 
Services provided: 
Dolibarr SaaS web hosting 
On premise/Virtual installation/setup 
On premise/virtual support 
Specific development & Training