From be497226ae1253ee2735830dc1c35a8f56b132a7 Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Wed, 26 Aug 2020 12:15:16 +0200 Subject: [PATCH] doc / contrib: Some fixes and adjustments --- doc/contrib/contrib.docbook | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/doc/contrib/contrib.docbook b/doc/contrib/contrib.docbook index c0030877..ae5b98f9 100644 --- a/doc/contrib/contrib.docbook +++ b/doc/contrib/contrib.docbook @@ -3,21 +3,41 @@ Contribution -Comme tout projet libre qui se respecte, les contributions à LdapSaisie sont les bienvenues. Ce chapitre explique les possibilités de contribution. +Comme tout projet libre qui se respecte, les contributions à LdapSaisie sont les bienvenues. Ce chapitre explique +les possibilités de contribution. LSaddons - Les &LSaddons; sont utilisés pour implémenter dans &LdapSaisie; des fonctionnalités spécifiques tel que le support d'une famille d'attributs spécifiques (POSIX, Samba, SUPANN…) ou encore des tâches communes et génériques (envoi de mails, connexion FTP…). Les &LSaddons; vous permettront également d'adapter &LdapSaisie; à vos besoins spécifiques en écrivant par exemple les fonctions appelées par les déclencheurs ou encore écrire des &customSearchActions; sur des recherches ou des &customActions; sur des &LSobjects;. + Les &LSaddons; sont utilisés pour implémenter dans &LdapSaisie; des fonctionnalités spécifiques tel que : + + le support d'une famille d'attributs spécifiques (POSIX, Samba, SUPANN…) par le biais de + méthodes de génération de la valeur de ces attributs par exemple (paramètre + generate_function) ; + des tâches communes et génériques (envoi de mails, connexion FTP/SSH…) ;. + l'implémentation de déclencheurs spécifiques à + votre environnement : création automatique du dossier client sur le serveur de fichiers de l'entreprise, création + de la boite mail de l'utilisateur… ; + l'implémentation de vues personnalisées proposées + dans l'interface + l'implémentation d'action personnalisée sur les + objets (synchronisation, archivage…) ou sur les + résultats de recherches (export, rapport personnalisé…) ; + + Structure d'écriture - L'écriture d'un &LSaddon; doit respecter une structure suffisamment souple afin de ne pas être un frein à vos contributions, tout en permettant d'assurer la bonne intégration de votre contribution au projet. Le code que vous écrirez sera réparti dans deux fichiers : + L'écriture d'un &LSaddon; doit respecter une structure suffisamment souple afin de ne pas être un frein à vos + contributions, tout en permettant d'assurer la bonne intégration de votre contribution au projet. Le code que vous + écrirez sera réparti dans deux fichiers : conf/LSaddons/config.LSaddons.[addon name].php - Ce fichier contiendra la configuration de votre &LSaddon;. On y retrouvera la déclaration de constances et/ou variables de configuration permettant d'adapter votre &LSaddon; à une installation et à un environnement. + Ce fichier contiendra la configuration de votre &LSaddon;. On y retrouvera la déclaration de + constances et/ou variables de configuration permettant d'adapter votre &LSaddon; à une installation et à un + environnement. @@ -156,14 +176,14 @@ les messages d'erreurs liés au support de cet &LSaddon;. On utilise pour cela la méthode LSerror :: defineError() qui attends en premier argument, l'identifiant du message d'erreur et en tant que second argument, le &LSformat; du message d'erreur. Par convention, les identifiants des messages d'erreurs seront en majuscule et préfixés du nom du &LSaddon;. - On déclare ensuite une fonction LSaddon_[myaddon]_support qui sera exécuté lors du chargement de + On déclare ensuite une fonction LSaddon_[myaddon]_support qui sera exécutée lors du chargement de l'addon et qui permettra de s'assurer du support de celui-ci. Cette fonction devra retourner True si c'est le cas ou False dans le cas contraire. Cette fonction s'assura notamment : que les librairies dont l'addon dépends sont bien chargées et fonctionnelles ; - que les variables et constantes de configuration sont bien définies ; - de déclarer les vues personnalisées fournies par cet &LSaddon; ; + que ses variables et constantes de configuration sont bien définies ; + de déclarer les vues personnalisées fournies par cet &LSaddon; ; de déclarer les commandes CLI personnalisées fournies par cet &LSaddon; ;