Changes

Modul Entwicklung (view source)

Revision as of 06:44, 28 October 2020

60 bytes removed , 4 years ago

Übersetzung

Line 14: Line 14:

Um ein neues Modul zu erstellen, gibt es mehrere Schritte. Dieses Tutorial soll beschreiben, wie Sie ein Modul hinzuzufügen können, um die Möglichkeiten von Dolibarr zu erweitern und eine oder mehreren folgender Funktionen einzufügen:

−

* Hinzufügen neuer Basistabellen

+

*Hinzufügen neuer Basistabellen

−

* Einfügen eigener Menüeinträge

+

*Einfügen eigener Menüeinträge

−

* Hinzufügen eigener Bildschirmmasken für die Eingabe/Ausgabe von neuen Tabellen

+

*Hinzufügen eigener Bildschirmmasken für die Eingabe/Ausgabe von neuen Tabellen

−

* Einfügen eines Karteireiter in Objektansichten bzw. Seiten (Rechnung, Produkte, Bestellung, Termine, ...)

+

*Einfügen eines Karteireiter in Objektansichten bzw. Seiten (Rechnung, Produkte, Bestellung, Termine, ...)

−

* Einfügen eines Datenexport vordefiniert für die Exportfunktion

+

*Einfügen eines Datenexport vordefiniert für die Exportfunktion

−

* Ergänzen von neuen Boxen für die Startseite

+

*Ergänzen von neuen Boxen für die Startseite

−

* Substitutionsvariablen hinzufügen

+

*Substitutionsvariablen hinzufügen

−

* Definieren von neuen Berechtigungen

+

*Definieren von neuen Berechtigungen

−

* Triggercode für eine automatisierte Dolibarr-Aktion

+

*Triggercode für eine automatisierte Dolibarr-Aktion

−

* Eigenen Code an den Dolibarr-Hooks einhängen

+

*Eigenen Code an den Dolibarr-Hooks einhängen

−

* Einfügen von eigenen Nummerierungsmodulen

+

*Einfügen von eigenen Nummerierungsmodulen

−

* Hinzufügen einer Dokumentvorlage

+

*Hinzufügen einer Dokumentvorlage

−

* Hinzufügen eigener Themen

+

*Hinzufügen eigener Themen

+

etc...

Line 33: Line 34: −

= [[File:Art.png]] Beispielvorlage für ein Modul/Pluginodule =

+

=[[File:Art.png]] Beispielvorlage für ein Modul/Pluginodule=

Ein gutes Vorlagen-Gerüst (Template) für ein Modul finden sie hier: [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Modul-Template]

−

= [[File:Art.png]] ~~Créer un module~~ =

+

=[[File:Art.png]] Erstellen eines Moduls=

−

~~Les sous chapitres suivant décrivent les actions à faire pour créer un module~~ Dolibarr. ~~Les premiers chapitres sont obligatoires quelle que soit la vocation du module~~, ~~les suivants dépendront de ce que doit faire le module~~.

+

In den folgenden Unterkapiteln werden die Aktionen beschrieben, welche zum Erstellen eines Dolibarr-Moduls ausgeführt werden müssen. Die ersten Kapitel sind, unabhängig vom Zweck des Moduls, zwingend erforderlich. Die folgenden Kapitel hängen von der Funktion des Moduls ab.

−

== Créer un descripteur de Module (obligatoire) ==

+

==Créer un descripteur de Module (obligatoire)==

'''Quand''': Obligatoire dès qu'une extension est développée, quelle que soit sa vocation (sauf pour l'ajout de thème ou de modèle de document).

−

=== Créer votre descripteur ===

+

===Créer votre descripteur===

La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

−

* Créer le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, aller dans le répertoire '''dev/skeletons''' et recopier le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.

+

−

* Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

+

*Créer le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, aller dans le répertoire '''dev/skeletons''' et recopier le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.

+

*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

+

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

−

* les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par ''''mod'''' et ne contenir que des '''caractères alphabétiques'''.

+

−

* $this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués: [[List of modules id|Liste des id de modules]].

+

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.

−

* Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

+

*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués: [[List of modules id|Liste des id de modules]].

+

*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

−

=== Tester votre descripteur ===

+

===Tester votre descripteur===

Lancer Dolibarr et aller sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).

C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

−

== Arborescence d'un nouveau module ==

+

==Arborescence d'un nouveau module==

Voici l'arborescence à respecter pour l'organisation des fichiers d'un module.

Line 67: Line 71:

Un modèle de module a été crée par un contributeur Dolibarr, il est accessible ici : [https://github.com/rdoursenaud/dolibarr-module-template]

−

== Créer vos tables SQL et les classes PHP DAO (optionnel) ==

+

==Créer vos tables SQL et les classes PHP DAO (optionnel)==

'''Quand''': Si votre module a besoin de gérer des données qui lui sont propres

−

=== Créer vos fichiers .sql ===

+

===Créer vos fichiers .sql===

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

Line 82: Line 86:

''Règles à respecter:''

−

* Ajouter les fichiers d'ordre de création de vos tables sur le principe d'un fichier '''llx_matable.sql''' par table accompagné éventuellement du fichier '''llx_matable.key.sql''' (voir les fichiers existants dans '''install/mysql/tables''' pour exemple).

+

−

* The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].

+

*Ajouter les fichiers d'ordre de création de vos tables sur le principe d'un fichier '''llx_matable.sql''' par table accompagné éventuellement du fichier '''llx_matable.key.sql''' (voir les fichiers existants dans '''install/mysql/tables''' pour exemple).

−

* Pour ce qui est des commandes pour ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.

+

*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].

+

*Pour ce qui est des commandes pour ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.

+

Exemple de contenu de fichier data.sql

Line 94: Line 100:

Rem: Les fichiers des autres bases ne sont pas à maintenir. Ils sont lus et convertit à la volée par le driver de la base de données.

−

=== Tester vos fichier .sql ===

+

===Tester vos fichier .sql===

Une fois les fichiers prêts, vous pouvez retourner sous Dolibarr puis désactiver le module, dropper les tables en base et réactiver le module.

Line 100: Line 106:

Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

−

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

+

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

Une fois votre ou vos tables créées en base, aller dans le répertoire '''dev/skeletons''', copiez le fichier '''build_class_from_table.php''' dans le répertoire sql/ de votre module, et lancez le script

Line 112: Line 118:

Un fichier '''out.nomtable_script.php''' a également été généré et contient un exemple de code pour utiliser la classe pour chacune des 4 méthodes CRUD.

−

== Affichage des onglets (optionnel) ==

+

==Affichage des onglets (optionnel)==

−

=== Ajouter ou supprimer des onglets sur les fiches objets ===

+

===Ajouter ou supprimer des onglets sur les fiches objets===

'''Quand''' : Pour ajouter votre propre onglet parmi les onglets standard d'une fiche entité (facture, commande, proposition commercial, adhérent...)

Line 127: Line 133:

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.

Le format de la chaîne étant composé de 6 parties séparées par ":"

−

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

+

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

−

* Partie 2: Nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)

+

−

* Partie 3: Le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.

+

*Partie 2: Nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)

−

* Partie 4: Le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang

+

*Partie 3: Le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.

−

* Partie 5: Une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.

+

*Partie 4: Le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang

−

* Partie 6: L'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

+

*Partie 5: Une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.

+

*Partie 6: L'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

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

Line 139: Line 147:

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

−

=== Ajouter les onglets standard d'un objet sur sa propre page ===

+

===Ajouter les onglets standard d'un objet sur sa propre page===

'''Quand''' : Pour afficher les onglets standard d'une fiche entité (produit, tiers, etc.) sur votre propre page onglet d'une entité.

Line 150: Line 158:

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

−

* Entité tiers (thirdparty) :

+

−

** DOL_DOCUMENT_ROOT/societe/class/societe.class.php

+

*Entité tiers (thirdparty) :

−

** DOL_DOCUMENT_ROOT/core/lib/company.lib.php

+

**DOL_DOCUMENT_ROOT/societe/class/societe.class.php

−

* Entité produit (product) :

+

**DOL_DOCUMENT_ROOT/core/lib/company.lib.php

−

** DOL_DOCUMENT_ROOT/product/class/product.class.php

+

*Entité produit (product) :

−

** DOL_DOCUMENT_ROOT/core/lib/product.lib.php

+

**DOL_DOCUMENT_ROOT/product/class/product.class.php

−

* Entité facture (invoice) :

+

**DOL_DOCUMENT_ROOT/core/lib/product.lib.php

−

** DOL_DOCUMENT_ROOT/compta/facture/facture.class.php

+

*Entité facture (invoice) :

−

** DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

+

**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php

+

**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

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

Line 211: Line 220:

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

−

== Créer vos pages écran PHP (optionnel) ==

+

==Créer vos pages écran PHP (optionnel)==

'''Quand''': Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

−

=== Créer une page écran PHP brute ===

+

===Créer une page écran PHP brute===

Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''dev/skeletons''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]).

Line 243: Line 252:

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

−

* $user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.

+

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.

−

* $conf L'objet qui contient la configuration de Dolibarr.

+

*$conf L'objet qui contient la configuration de Dolibarr.

−

* $db L'objet qui contient le handler de connexion ouvert à la base de données.

+

*$db L'objet qui contient le handler de connexion ouvert à la base de données.

−

* $langs L'objet qui contient la langue de l'utilisateur.

+

*$langs L'objet qui contient la langue de l'utilisateur.

+

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

−

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

''Exemple :''

Line 254: Line 264:

</source>

−

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

+

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

+

''Exemple :''

Line 261: Line 272:

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

−

=== Remplacer les parties d'écrans templatés (version 3.3+) ===

+

===Remplacer les parties d'écrans templatés (version 3.3+)===

Certaines portion d'écran de Dolibarr sont isolés dans des fichiers templates.

Vous pouvez développer un module pour remplacer un ou plusieurs de ces templates par les vôtres.

−

=== Accès à la base ===

+

===Accès à la base===

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

Line 305: Line 316:

</source>

−

=== Définition du style ===

+

===Définition du style===

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

Par exemple:

−

* class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.

+

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.

−

* class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.

+

*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.

−

* class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).

+

*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).

−

* class="'''button'''" sur les objets de type ''input type="submit"''.

+

*class="'''button'''" sur les objets de type ''input type="submit"''.

−

=== Utiliser le sélecteur de date de Dolibarr ===

+

===Utiliser le sélecteur de date de Dolibarr===

Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:

Line 332: Line 343:

</source>

−

== Définir votre page de configuration (optionnel) ==

+

==Définir votre page de configuration (optionnel)==

'''Quand''': Si votre module offre plusieurs options paramétrables.

−

=== Créer votre page d'édition de configuration ===

+

===Créer votre page d'édition de configuration===

Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).

Créer une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.

Line 345: Line 356:

</source>

−

=== Tester votre page ===

+

===Tester votre page===

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

−

== Définir vos entrées de menu (optionnel) ==

+

==Définir vos entrées de menu (optionnel)==

'''Quand''': Si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

−

=== Définissez vos entrées menus ===

+

===Définissez vos entrées menus===

Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.

Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.

Line 396: Line 407:

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

−

=== Tester vos entrées menus ===

+

===Tester vos entrées menus===

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

−

== Définir vos propres permissions (optionnel) ==

+

==Définir vos propres permissions (optionnel)==

'''Quand''': Si vous voulez ajouter de nouvelles permissions.

Line 429: Line 440:

</source>

−

== Définir vos propres box (optionnel) ==

+

==Définir vos propres box (optionnel)==

'''Quand''': Si votre module amène avec lui une ou plusieurs Boxes.

−

=== Définissez vos box ===

+

===Définissez vos box===

Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.

Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

Line 447: Line 458:

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

−

=== Tester la présence de vos box dans Dolibarr ===

+

===Tester la présence de vos box dans Dolibarr===

Désactiver et réactiver le module.

Line 454: Line 465:

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

−

== Définir vos propres exports (optionnel) ==

+

==Définir vos propres exports (optionnel)==

'''Quand''': Si votre module amène avec lui des exports prédéfini de données (pour ces propres tables ou des tables déjà existante d'un autre module de Dolibarr).

−

=== Définissez l'export ===

+

===Définissez l'export===

Pour cela, décommenter et modifier les tableaux $this->export_xxx du votre fichier descripteur de module.

−

=== Tester votre export ===

+

===Tester votre export===

Aller dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponible (si votre module est bien activé).

Le choisir, vous devez alors voir les champs possible définis dans le tableau à l'étape précédente.

Choisir quelques champs et tenter une génération du fichier export.

−

== Définir vos styles CSS (optionnel) ==

+

==Définir vos styles CSS (optionnel)==

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

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

−

=== Créer et déclarer votre feuille de style ===

+

===Créer et déclarer votre feuille de style===

Créer un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et le placer dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.

Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créer un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.

Line 480: Line 491:

</source>

−

=== Tester votre feuille de style ===

+

===Tester votre feuille de style===

Désactiver et réactiver votre module.

Line 487: Line 498:

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

−

== Définir vos fonctions Javascript (optionnel) ==

+

==Définir vos fonctions Javascript (optionnel)==

'''Quand''': Si dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Line 500: Line 511:

</source>

−

== Déclencher du code sur un évènement Dolibarr (optionnel) ==

+

==Déclencher du code sur un évènement Dolibarr (optionnel)==

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

Line 506: Line 517:

et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

−

== Insérer votre code aux emplacement hooks de Dolibarr (optionnel) ==

+

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==

'''Quand''': Quand vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

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

−

== Ajouter un module de numérotation (optionnel) ==

+

==Ajouter un module de numérotation (optionnel)==

'''Quand''': Lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

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

−

== Ajouter un nouveau modèle de document (optionnel) ==

+

==Ajouter un nouveau modèle de document (optionnel)==

'''Quand''': Lorsque vous voulez ajouter un nouveau modèle de document.

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

−

== Ajouter un thème (optionnel) ==

+

==Ajouter un thème (optionnel)==

'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

−

= [[File:Art.png]] Quelques règles de codage et fonctions pour développeurs =

+

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=

Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

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

−

= [[File:Art.png]] Créer un package pour livrer et installer votre module =

+

=[[File:Art.png]] Créer un package pour livrer et installer votre module=

Cette procédure doit être utilisé pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.

Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

−

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

+

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

+

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

−

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

+

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

+

perl makepack-dolibarrmodule.pl

Line 545: Line 558:

Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

−

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

+

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

+

tar -xvf monmodule.zip

</source>

−

* Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créer un compte auparavant et utiliser le lien "Soumettre un module/produit").

+

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créer un compte auparavant et utiliser le lien "Soumettre un module/produit").

−

** Si votre module a été fabriqué correctement, le fichier sera validé rapidement.

+

**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.

−

** Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

+

**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

−

= [[File:Art.png]] Validation/activation du module externe sur Dolistore =

+

=[[File:Art.png]] Validation/activation du module externe sur Dolistore=

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

NichtSichtBar

16

edits