Difference between revisions of "Documentation Développeur"

Revision as of 14:15, 19 October 2011

Organisation et outils de développement

Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.

Règles de codage

Langage et normes de développement

La Base de données

Liste des modules existant

La documentation technique, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page de documentation développeur de chaque module. Choisissez la page qui vous concerne pour y accéder:

La liste des modules standards est définie sur la page Liste des Modules
La liste des modules complémentaires est définie sur la page Modules complémentaires

Développer un nouveau module/extension pour les IHM (nouveaux écrans)

Cette section décrit comment développer un nouveau module sur l'interface utilisateur de Dolibarr (IHM). Un module pour l'IHM contient aussi bien des écrans que des données propres, voir une feuille de style. Le développement de script ne rentre pas dans ce périmètre et est décrit au chapitre suivant. Le développement de modules de numérotations, de documents, de thèmes ou de triggers est décrit dans des chapitres suivants également.

Pour développer votre propre module d'extension des IHM, aller sur le didacticiel: Développement module

Développer un script ligne de commande ou batch

Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, etc...). La réalisation de modification sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: Développement de scripts

Les couches techniques de Dolibarr

Arborescence des fichiers

La hierachie des fichiers de la version actuelle est visibles sur la documentation générées doxygen des sources.

Mais les chemins à utiliser pour ajouter vos fichiers lors de la réalisation d'un nouveau module sont décrits dans la documentation de développement d'u nouveau module (voir plus bas).

Le Système de paramétrage

Il existe 3 niveaux de paramétrage dans Dolibarr.

La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. Voir Fichier de configuration pour plus d'informations.
Le paramétrage des fonctionnalités est stocké dans la Table llx_const. Voir la page Constantes pour plus d'informations.
Le paramétrage propre à un utilisateur est stocké dans la Table llx_user_param. Voir la page Constantes pour plus d'informations.

Le Système des thèmes

Voir la page Themes

Le Système des boites

Voir la page Système des boites

Le Système d'authentification

Voir la page Authentification

Le Système des permissions

Voir la page Permissions

Le Système de traduction

Voir la page Système de traduction

La Gestion d'erreur

Voir la page Gestion d'erreur

Le système des Canvas (surcharge écrans)

Les Canvas sont une fonction développeur pour remplacer les écrans de création, mise a jour ou visualisation d'une fiche (produits, tiers, contacts, ...). Par exemple, vous pouvez remplacer le formulaire de saisie d'un tiers par le votre, ou le formulaire d'édition, ou l'écran de consultation.

Voir la page Développement Canvas

Le système des Triggers

Les Triggers sont une fonctionnalité développeurs pour exécuter du code personnaliser durant l'exécution d'un "événement métier" Dolibarr (création de facture, suppression d'un utilisateur, mise à jour d'un tier, etc...), et uniquement pour des événements métiers. Pour personnaliser du code dans un autre contexte, voir plutôt le chapitre Le système des Hooks.

Pour l'utilisation des triggers voir cette page.

Les Web services

Voir Module Services Web

Le stockage de fichiers/documents

Voir la page Documents générés

Les modules de numérotation

Pour chaque entité créée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation. Plus d'information sur la page Créer un module de numérotation

Les modèles et la génération de documents

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

Les exports/imports de masse

Interfaces et liens avec d'autres applications

Interfaces Dolibarr vers exterieur ou vers Dolibarr (Triggers Dolibarr)
Interfaces Exterieur vers Dolibarr
Module Services Web

FAQ

Toutes les FAQ (Foires Aux Questions) sont disponibles via la page d'index FAQ FR

@@ Line 81: / Line 81: @@
 Les Triggers sont une fonctionnalité développeurs pour exécuter du code personnaliser durant l'exécution d'un "événement métier" Dolibarr (création de facture, suppression d'un utilisateur, mise à jour d'un tier, etc...), et uniquement pour des événements métiers. Pour personnaliser du code dans un autre contexte, voir plutôt le chapitre '''Le système des Hooks'''.
-Pour l'utilisation des triggers voir cette page [[Interfaces et liens avec d'autres applications|this page]].
+Pour l'utilisation des triggers voir [[Interfaces_Dolibarr_vers_exterieur|cette page]].
 == Les Web services ==