Documentation Développeur

Développeurs :

Participer au développement d'un projet libre implique d'utiliser les outils mis en place par le mainteneur du projet. Pour développer sur Dolibarr il faut

• Lire cette documention ;-),
• compléter cette documentation,
• se créer un compte sur Savannah,
• s'inscrire sur la liste de discussions des développeurs et se présenter succinctement dans un premier mail,
• s'inscrire sur la liste cvs. Cette liste est est lecture seule, elle permet aux développeurs de suivre l'activité des commits (cette liste est désactivée par les admins de Savannah temporairement),
• respecter les notices de copyright, cela inclus la mise à jour de celles-ci lorsqu'un développeur modifie de façon conséquente un fichier ou ajoute dans un fichier une fonctionnalité nouvelles,
• prendre conscience des contraintes qu'implique l'utilisation de la GPL comme licence pour le projet, lors de l'utilisation d'une librairie dans Dolibarr si celle-ci n'est pas sous GPL discutez-en sur la liste des développeurs au préalable.

Ces quelques obligations n'ont pour seul but que le développement se fasse dans les meilleures conditions possibles.

Sommaire :

1. Languages de développement
2. Définitions des Permissions
3. Définitions des Constantes
4. Librairies externes
5. Dépendances

TODO Dolibarr à pour objectif d'être modulaire à terme.

2.1 Définition

La définition d'un module se fait en incluant une classe dans le répertoire htdocs/includes/modules.

Cette classe est une extension de la classe modDolibarrModules, son nom doit commencer par le préfixe "mod", la quatrième lettre étant en majuscule (ex : modFacture, modCommercial)

2.1.1 Définition de la classe

La classe doit comporter une fonction d'initialisation qui a le même nom que la class en elle-même (fonctionnalité de php).

Elle comporte les proprietes depends, const et boxes qui sont toutes trois des tableaux à une ou plusieurs dimensions.

Inspirez-vous des classes existantes pour écrire votre propre classe.

3.1 Fichier de configuration

Le fichier de configuration de Dolibarr est conf/conf.php il est écrit par /install.php

Le contenu du fichier standard est :

    $dolibarr_main_document_root="/spare/home/www/dolibarr/dolibarr/htdocs";
    $dolibarr_main_url_root="http://dolibarr.lafrere.lan";
    $dolibarr_main_db_host="localhost";
    $dolibarr_main_db_name="dolibarr";
    $dolibarr_main_db_user="dolibarr";
    $dolibarr_main_db_pass="";

3.1.1 Paramètres optionnels supplémentaires

Vous pouvez ajouter le paramètre supplémentaire optionnel :

    $dolibarr_auto_user="demo";

Si vous souhaitez utiliser Dolibarr en mono-utilisateur, il faut quand même que cet utilisateur existe dans la base de données.

Propositions commerciales

6.1 Modèles

Trois modèles de proposition sont fournit avec Dolibarr, mais vous pouvez en créer autant que vous le souhaitez. Pour cela il vous suffit de créer une nouvelle classe dans un fichier dont le nom doit être de la forme pdf_propale_MISC.modules.php où MISC est une chaine de caractère de votre choix. Une fois ce fichier créé la classe qu'il définit doit se nommer pdf_propale_MISC.

Le nom (MISC) ne doit pas dépasser 50 caractères.

Produits

7.1 Stocks

Trois modèles de proposition sont fournit avec Dolibarr, mais vous pouvez en créer autant que vous le souhaitez. Pour cela il vous suffit de créer une nouvelle classe dans un fichier dont le nom doit être de la forme pdf_propale_MISC.modules.php où MISC est une chaine de caractère de votre choix. Une fois ce fichier créé la classe qu'il définit doit se nommer pdf_propale_MISC.

7.1.1 Mouvement

Les mouvement de stock sont enregistrés dans la table llx_stock_mouvement. Le champ type mouvement prends les valeurs suivantes : 0 pour une correction, 1 pour une appro, 2 pour une livraison.

8.1 Création d'un nouveau thème

Pour créer un nouveau thème, allez dans le répertoire 'htdocs/theme/' recopier par exemple tout le répertoire 'dolibarr' vers un nouveau répertoire qui aura le nom de votre thème. Dans ce répertoire changer le nom du fichier .css pour qu'il ait le même nom que le répertoire. Modifier ensuite le CSS et les images contenues dans le répertoire img pour personnaliser votre thème.