Développement module: Difference between revisions

Jump to navigation Jump to search
m
Orthographe et typographie
m (→‎Création de Module avec le générateur de module: Décrire plus précisément l'activation du générateur de modules. MàJ basée sur Dolibarr 18.0.2)
m (Orthographe et typographie)
Line 50: Line 50:
==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.
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut dors et déjà être utilisé.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut d'ores et déjà être utilisé.


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


==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
'''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===
Line 128: Line 128:
===Tester vos fichiers .sql===
===Tester vos fichiers .sql===


Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existe déjà) et réactiver le module.
Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existent déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.
Line 136: Line 136:
Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.
Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.


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


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


==Affichage des onglets (optionnel)==
==Affichage des onglets (optionnel)==
Line 203: Line 203:
</source>
</source>


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


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

edits

Navigation menu