diff --git a/htdocs/includes/modules/DolibarrModules.class.php b/htdocs/includes/modules/DolibarrModules.class.php index f112a708667..d8f0582be9e 100644 --- a/htdocs/includes/modules/DolibarrModules.class.php +++ b/htdocs/includes/modules/DolibarrModules.class.php @@ -20,33 +20,38 @@ * */ +/*! \file htdocs/includes/modules/modDolibarrModules.class.php + \brief Fichier de description et activation du module Facture +*/ + + +/*! \class DolibarrModules + \brief Classe mère des classes de description et activation des modules Dolibarr +*/ class DolibarrModules { + var $db; // Handler d'accès aux base + var $boxes; // Tableau des boites + var $const; // Tableau des constantes - /* - * Initialisation - * - */ + /*! \brief Constructeur + * \param DB handler d'accès base + */ function DolibarrModules($DB) { $this->db = $DB ; } - /* - * - * - * - */ + + /*! \brief Fonction d'activation. Insère en base les constantes et boites du module + * \param array_sql tableau de requete sql a exécuter à l'activation + */ function _init($array_sql) { - /* - * Activation du module: - * Insère les constantes dans llx_const - */ + // Insère les constantes $err = 0; - $sql = "REPLACE INTO ".MAIN_DB_PREFIX."const SET name = '".$this->const_name."', value='1', visible = 0"; if (!$this->db->query($sql)) @@ -54,7 +59,7 @@ class DolibarrModules $err++; } - // Ajout des boxes dans llx_boxes_def + // Insère les boxes dans llx_boxes_def foreach ($this->boxes as $key => $value) { $titre = $this->boxes[$key][0]; @@ -142,10 +147,11 @@ class DolibarrModules return 1; } } - /* - * - * - */ + + + /*! \brief Fonction de désactivation. Supprime de la base les constantes et boites du module + * \param array_sql tableau de requete sql a exécuter à la désactivation + */ function _remove($array_sql) { $err = 0; diff --git a/htdocs/includes/modules/modAdherent.class.php b/htdocs/includes/modules/modAdherent.class.php index 4fa73af0c9d..7e382c450db 100644 --- a/htdocs/includes/modules/modAdherent.class.php +++ b/htdocs/includes/modules/modAdherent.class.php @@ -28,11 +28,16 @@ /*! \file htdocs/includes/modules/modAdherent.class.php + \ingroup adherent \brief Fichier de description et activation du module adherents */ include_once "DolibarrModules.class.php"; +/*! \class modAdherent + \brief Classe de description et activation du module Adherent +*/ + class modAdherent extends DolibarrModules { diff --git a/htdocs/includes/modules/modBanque.class.php b/htdocs/includes/modules/modBanque.class.php index ba4721a5b2d..941c3f1161b 100644 --- a/htdocs/includes/modules/modBanque.class.php +++ b/htdocs/includes/modules/modBanque.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modBanque.class.php + \ingroup banque \brief Fichier de description et activation du module Banque */ include_once "DolibarrModules.class.php"; +/*! \class modBanque + \brief Classe de description et activation du module Banque +*/ + class modBanque extends DolibarrModules { diff --git a/htdocs/includes/modules/modBoutique.class.php b/htdocs/includes/modules/modBoutique.class.php index fefc33dd1ec..bb005e7ff6c 100644 --- a/htdocs/includes/modules/modBoutique.class.php +++ b/htdocs/includes/modules/modBoutique.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modBoutique.class.php + \ingroup boutique \brief Fichier de description et activation du module Boutique */ include_once "DolibarrModules.class.php"; +/*! \class modBoutique + \brief Classe de description et activation du module Boutique +*/ + class modBoutique extends DolibarrModules { diff --git a/htdocs/includes/modules/modCaisse.class.php b/htdocs/includes/modules/modCaisse.class.php index 1b276c8c63a..efc4b05f5b1 100644 --- a/htdocs/includes/modules/modCaisse.class.php +++ b/htdocs/includes/modules/modCaisse.class.php @@ -26,11 +26,16 @@ /*! \file htdocs/includes/modules/modCaisse.class.php + \ingroup caisse \brief Fichier de description et activation du module Caisse */ include_once "DolibarrModules.class.php"; +/*! \class modCaisse + \brief Classe de description et activation du module Caisse +*/ + class modCaisse extends DolibarrModules { diff --git a/htdocs/includes/modules/modCommande.class.php b/htdocs/includes/modules/modCommande.class.php index 8339157b353..03b13a4ffc6 100644 --- a/htdocs/includes/modules/modCommande.class.php +++ b/htdocs/includes/modules/modCommande.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modCommande.class.php + \ingroup commande \brief Fichier de description et activation du module Commande */ include_once "DolibarrModules.class.php"; +/*! \class modCommande + \brief Classe de description et activation du module Commande +*/ + class modCommande extends DolibarrModules { diff --git a/htdocs/includes/modules/modCommercial.class.php b/htdocs/includes/modules/modCommercial.class.php index a16d431a6db..6ddac6cd78d 100644 --- a/htdocs/includes/modules/modCommercial.class.php +++ b/htdocs/includes/modules/modCommercial.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modCommercial.class.php + \ingroup commercial \brief Fichier de description et activation du module Commercial */ include_once "DolibarrModules.class.php"; +/*! \class modCommercial + \brief Classe de description et activation du module Commercial +*/ + class modCommercial extends DolibarrModules { diff --git a/htdocs/includes/modules/modComptabilite.class.php b/htdocs/includes/modules/modComptabilite.class.php index be12d61c301..5206d7e5939 100644 --- a/htdocs/includes/modules/modComptabilite.class.php +++ b/htdocs/includes/modules/modComptabilite.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modComptabilite.class.php + \ingroup comptabilite \brief Fichier de description et activation du module Comptabilite */ include_once "DolibarrModules.class.php"; +/*! \class modComptabilite + \brief Classe de description et activation du module Comptabilite +*/ + class modComptabilite extends DolibarrModules { diff --git a/htdocs/includes/modules/modContrat.class.php b/htdocs/includes/modules/modContrat.class.php index 46aaaa43396..975b492fa6e 100644 --- a/htdocs/includes/modules/modContrat.class.php +++ b/htdocs/includes/modules/modContrat.class.php @@ -26,11 +26,16 @@ /*! \file htdocs/includes/modules/modContrat.class.php + \ingroup contrat \brief Fichier de description et activation du module Contrat */ include_once "DolibarrModules.class.php"; +/*! \class modContrat + \brief Classe de description et activation du module Contrat +*/ + class modContrat extends DolibarrModules { diff --git a/htdocs/includes/modules/modDon.class.php b/htdocs/includes/modules/modDon.class.php index 4274a5882a5..c4b5b906368 100644 --- a/htdocs/includes/modules/modDon.class.php +++ b/htdocs/includes/modules/modDon.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modDon.class.php + \ingroup don \brief Fichier de description et activation du module Don */ include_once "DolibarrModules.class.php"; +/*! \class modDon + \brief Classe de description et activation du module Don +*/ + class modDon extends DolibarrModules { diff --git a/htdocs/includes/modules/modExpedition.class.php b/htdocs/includes/modules/modExpedition.class.php index 483911dede7..c241126f1d5 100644 --- a/htdocs/includes/modules/modExpedition.class.php +++ b/htdocs/includes/modules/modExpedition.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modExpedition.class.php + \ingroup expedition \brief Fichier de description et activation du module Expedition */ include_once "DolibarrModules.class.php"; +/*! \class modExpedition + \brief Classe de description et activation du module Expedition +*/ + class modExpedition extends DolibarrModules { diff --git a/htdocs/includes/modules/modExternalRss.class.php b/htdocs/includes/modules/modExternalRss.class.php index 0b808fa6f2e..e82e87d18f6 100644 --- a/htdocs/includes/modules/modExternalRss.class.php +++ b/htdocs/includes/modules/modExternalRss.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modExternalRss.class.php + \ingroup externalrss \brief Fichier de description et activation du module ExternalRss */ include_once "DolibarrModules.class.php"; +/*! \class modExternalRss + \brief Classe de description et activation du module ExternalRss +*/ + class modExternalRss extends DolibarrModules { diff --git a/htdocs/includes/modules/modFacture.class.php b/htdocs/includes/modules/modFacture.class.php index b1daf74bd43..9fe508db904 100644 --- a/htdocs/includes/modules/modFacture.class.php +++ b/htdocs/includes/modules/modFacture.class.php @@ -25,21 +25,25 @@ \brief Module pour gérer les factures clients et/ou fournisseurs */ -/*! - \file htdocs/includes/modules/modFacture.class.php - \brief Fichier de description et activation du module Facture + +/*! \file htdocs/includes/modules/modFacture.class.php + \ingroup facture + \brief Fichier de la classe de description et activation du module Facture */ include_once "DolibarrModules.class.php"; + +/*! \class modFacture + \brief Classe de description et activation du module Facture +*/ + class modFacture extends DolibarrModules { - /* - * Initialisation - * - */ - + /*! \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modFacture($DB) { $this->db = $DB ; @@ -109,17 +113,11 @@ class modFacture extends DolibarrModules $this->boxes[3][1] = "box_factures_fourn.php"; } - /* - * - * - * - */ + /*! \brief Fonction d'activation. Insère en base les constantes, boites et permissions du module + */ function init() { - /* - * Permissions - */ $sql = array( "insert into ".MAIN_DB_PREFIX."rights_def values (10,'Tous les droits sur les factures','facture','a',0);", "insert into ".MAIN_DB_PREFIX."rights_def values (11,'Lire les factures','facture','r',1);", @@ -133,10 +131,9 @@ class modFacture extends DolibarrModules return $this->_init($sql); } - /* - * - * - */ + + /*! \brief Fonction de désactivation. Supprime de la base les constantes, boites et permissions du module + */ function remove() { $sql = array( diff --git a/htdocs/includes/modules/modFicheinter.class.php b/htdocs/includes/modules/modFicheinter.class.php index 08cc2c906ec..91b7fe4961c 100644 --- a/htdocs/includes/modules/modFicheinter.class.php +++ b/htdocs/includes/modules/modFicheinter.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modFicheinter.class.php + \ingroup ficheinter \brief Fichier de description et activation du module Ficheinter */ include_once "DolibarrModules.class.php"; +/*! \class modFicheinter + \brief Classe de description et activation du module Ficheinter +*/ + class modFicheinter extends DolibarrModules { diff --git a/htdocs/includes/modules/modFournisseur.class.php b/htdocs/includes/modules/modFournisseur.class.php index c13a2b9b537..a30c59fb5a7 100644 --- a/htdocs/includes/modules/modFournisseur.class.php +++ b/htdocs/includes/modules/modFournisseur.class.php @@ -27,12 +27,17 @@ /*! \file htdocs/includes/modules/modFournisseur.class.php + \ingroup fournisseur \brief Fichier de description et activation du module Fournisseur */ include_once "DolibarrModules.class.php"; +/*! \class modFournisseur + \brief Classe de description et activation du module Fournisseur +*/ + class modFournisseur extends DolibarrModules { diff --git a/htdocs/includes/modules/modLdap.class.php b/htdocs/includes/modules/modLdap.class.php index 96a8d903638..b94874affb2 100644 --- a/htdocs/includes/modules/modLdap.class.php +++ b/htdocs/includes/modules/modLdap.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modLdap.class.php + \ingroup ldap \brief Fichier de description et activation du module Ldap */ include_once "DolibarrModules.class.php"; +/*! \class modLdap + \brief Classe de description et activation du module Ldap +*/ + class modLdap extends DolibarrModules { /* diff --git a/htdocs/includes/modules/modPostnuke.class.php b/htdocs/includes/modules/modPostnuke.class.php index f649ed882da..9e32262f3e6 100644 --- a/htdocs/includes/modules/modPostnuke.class.php +++ b/htdocs/includes/modules/modPostnuke.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modPostnuke.class.php + \ingroup postnuke \brief Fichier de description et activation du module Postnuke */ include_once "DolibarrModules.class.php"; +/*! \class modPostnuke + \brief Classe de description et activation du module Postnuke +*/ + class modPostnuke extends DolibarrModules { diff --git a/htdocs/includes/modules/modProduit.class.php b/htdocs/includes/modules/modProduit.class.php index b3c02e6fbd4..c0c7a9ed169 100644 --- a/htdocs/includes/modules/modProduit.class.php +++ b/htdocs/includes/modules/modProduit.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modProduit.class.php + \ingroup produit \brief Fichier de description et activation du module Produit */ include_once "DolibarrModules.class.php"; +/*! \class modProduit + \brief Classe de description et activation du module Produit +*/ + class modProduit extends DolibarrModules { diff --git a/htdocs/includes/modules/modProjet.class.php b/htdocs/includes/modules/modProjet.class.php index 50db56eb967..91593013d9b 100644 --- a/htdocs/includes/modules/modProjet.class.php +++ b/htdocs/includes/modules/modProjet.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modProjet.class.php + \ingroup projet \brief Fichier de description et activation du module Projet */ include_once "DolibarrModules.class.php"; +/*! \class modProjet + \brief Classe de description et activation du module Projet +*/ + class modProjet extends DolibarrModules { diff --git a/htdocs/includes/modules/modPropale.class.php b/htdocs/includes/modules/modPropale.class.php index 1bc3a022395..22e2a7901c7 100644 --- a/htdocs/includes/modules/modPropale.class.php +++ b/htdocs/includes/modules/modPropale.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modPropale.class.php + \ingroup propale \brief Fichier de description et activation du module Propale */ include_once "DolibarrModules.class.php"; +/*! \class modPropale + \brief Classe de description et activation du module Propale +*/ + class modPropale extends DolibarrModules { diff --git a/htdocs/includes/modules/modService.class.php b/htdocs/includes/modules/modService.class.php index 8696a02d09b..0b752be8105 100644 --- a/htdocs/includes/modules/modService.class.php +++ b/htdocs/includes/modules/modService.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modService.class.php + \ingroup service \brief Fichier de description et activation du module Service */ include_once "DolibarrModules.class.php"; +/*! \class modService + \brief Classe de description et activation du module Service +*/ + class modService extends DolibarrModules { diff --git a/htdocs/includes/modules/modSociete.class.php b/htdocs/includes/modules/modSociete.class.php index 8ca5628d80e..38de2a41336 100644 --- a/htdocs/includes/modules/modSociete.class.php +++ b/htdocs/includes/modules/modSociete.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modSociete.class.php + \ingroup societe \brief Fichier de description et activation du module Societe */ include_once "DolibarrModules.class.php"; +/*! \class modSociete + \brief Classe de description et activation du module Societe +*/ + class modSociete extends DolibarrModules { diff --git a/htdocs/includes/modules/modStock.class.php b/htdocs/includes/modules/modStock.class.php index ecbd10a9d64..f4f8c136f01 100644 --- a/htdocs/includes/modules/modStock.class.php +++ b/htdocs/includes/modules/modStock.class.php @@ -27,11 +27,16 @@ /*! \file htdocs/includes/modules/modStock.class.php + \ingroup stock \brief Fichier de description et activation du module Stock */ include_once "DolibarrModules.class.php"; +/*! \class modStock + \brief Classe de description et activation du module Stock +*/ + class modStock extends DolibarrModules { diff --git a/htdocs/includes/modules/modWebcalendar.class.php b/htdocs/includes/modules/modWebcalendar.class.php index 92a6e8fa060..18ff570fd36 100644 --- a/htdocs/includes/modules/modWebcalendar.class.php +++ b/htdocs/includes/modules/modWebcalendar.class.php @@ -28,11 +28,16 @@ /*! \file htdocs/includes/modules/modWebcalendar.class.php + \ingroup webcalendar \brief Fichier de description et activation du module Webcalendar */ include_once "DolibarrModules.class.php"; +/*! \class modWebcalendar + \brief Classe de description et activation du module Webcalendar +*/ + class modWebcalendar extends DolibarrModules {