From 2496848e3d039a74ef4159a2d211bdd5e07ea034 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Tue, 23 Nov 2004 20:04:19 +0000 Subject: [PATCH] Doc: Documentation doxygen --- htdocs/includes/modules/modAdherent.class.php | 38 +++++++----- htdocs/includes/modules/modBanque.class.php | 26 ++++---- htdocs/includes/modules/modBoutique.class.php | 36 +++++------ htdocs/includes/modules/modCaisse.class.php | 32 ++++++---- htdocs/includes/modules/modCommande.class.php | 33 ++++++---- .../includes/modules/modCommercial.class.php | 32 +++++----- .../modules/modComptabilite.class.php | 25 ++++---- htdocs/includes/modules/modContrat.class.php | 29 +++++---- htdocs/includes/modules/modDon.class.php | 42 ++++++------- .../includes/modules/modExpedition.class.php | 32 ++++++---- .../includes/modules/modExternalRss.class.php | 35 ++++++----- htdocs/includes/modules/modFacture.class.php | 24 +++++--- .../includes/modules/modFicheinter.class.php | 29 +++++---- .../includes/modules/modFournisseur.class.php | 32 ++++++---- htdocs/includes/modules/modLdap.class.php | 29 +++++---- htdocs/includes/modules/modPostnuke.class.php | 32 +++++----- .../includes/modules/modPrelevement.class.php | 60 ++++++------------- htdocs/includes/modules/modProduit.class.php | 34 ++++++----- htdocs/includes/modules/modProjet.class.php | 28 ++++----- htdocs/includes/modules/modPropale.class.php | 39 ++++++------ htdocs/includes/modules/modService.class.php | 25 ++++---- htdocs/includes/modules/modSociete.class.php | 31 ++++++---- htdocs/includes/modules/modStock.class.php | 32 ++++++---- .../includes/modules/modTelephonie.class.php | 27 ++++----- .../includes/modules/modWebcalendar.class.php | 29 +++++---- 25 files changed, 431 insertions(+), 380 deletions(-) diff --git a/htdocs/includes/modules/modAdherent.class.php b/htdocs/includes/modules/modAdherent.class.php index 4fb90e4402d..5a689a6f069 100644 --- a/htdocs/includes/modules/modAdherent.class.php +++ b/htdocs/includes/modules/modAdherent.class.php @@ -43,11 +43,10 @@ include_once "DolibarrModules.class.php"; class modAdherent extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modAdherent($DB) { $this->db = $DB ; @@ -58,6 +57,10 @@ class modAdherent extends DolibarrModules $this->description = "Gestion des adhérents d'une association"; $this->const_name = "MAIN_MODULE_ADHERENT"; $this->const_config = MAIN_MODULE_ADHERENT; + $this->special = 0; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = "adherent.php"; @@ -66,9 +69,8 @@ class modAdherent extends DolibarrModules $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); - $this->boxes = array(); - $this->const[0]= array("ADHERENT_MAIL_RESIL","texte","Votre adhesion sur %SERVEUR% vient d'etre resilie.\r\nNous esperons vous revoir tres bientot","Mail de résiliation"); $this->const[1]=array("ADHERENT_MAIL_VALID","texte","Votre adhesion vient d'etre validee. \r\nVoici le rappel de vos coordonnees (toute information erronee entrainera la non validation de votre inscription) :\r\n\r\n%INFO%\r\n\r\nVous pouvez a tout moment, grace a votre login et mot de passe, modifier vos coordonnees a l'adresse suivante : \r\n%SERVEUR%public/adherents/","Mail de validation"); $this->const[2]= array("ADHERENT_MAIL_EDIT","texte","Voici le rappel des coordonnees que vous avez modifiees (toute information erronee entrainera la non validation de votre inscription) :\r\n\r\n%INFO%\r\n\r\nVous pouvez a tout moment, grace a votre login et mot de passe, modifier vos coordonnees a l'adresse suivante :\r\n%SERVEUR%public/adherents/","Mail d'edition"); @@ -104,13 +106,16 @@ class modAdherent extends DolibarrModules $this->const[32] = array("ADHERENT_BANK_ACCOUNT","chaine","","ID du Compte banquaire utilise"); $this->const[33] = array("ADHERENT_BANK_CATEGORIE","chaine","","ID de la categorie banquaire des cotisations"); $this->const[34] = array("ADHERENT_ETIQUETTE_TYPE","chaine","L7163","Type d etiquette (pour impression de planche d etiquette)"); - } - /* - * - * - * - */ + // Boites + $this->boxes = array(); + + } + + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -127,9 +132,10 @@ class modAdherent extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modBanque.class.php b/htdocs/includes/modules/modBanque.class.php index 75cab8bd3c8..1db230d7c4a 100644 --- a/htdocs/includes/modules/modBanque.class.php +++ b/htdocs/includes/modules/modBanque.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modBanque extends DolibarrModules { - /** Initialisation de l'objet - * - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modBanque($DB) { $this->db = $DB ; @@ -65,12 +64,12 @@ class modBanque extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /** initialisation du module - * - * - * - */ + + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -86,9 +85,10 @@ class modBanque extends DolibarrModules return $this->_init($sql); } - /** suppression du module - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modBoutique.class.php b/htdocs/includes/modules/modBoutique.class.php index 7240a77be20..7a3dfea76cd 100644 --- a/htdocs/includes/modules/modBoutique.class.php +++ b/htdocs/includes/modules/modBoutique.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modBoutique extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modBoutique($DB) { $this->db = $DB ; @@ -57,9 +56,9 @@ class modBoutique extends DolibarrModules $this->description = "Gestion des boutiques"; $this->const_name = "MAIN_MODULE_BOUTIQUE"; $this->const_config = MAIN_MODULE_BOUTIQUE; + $this->special = 0; - $this->special = 1; - + // Dir $this->dirs = array(); // Config pages @@ -69,19 +68,19 @@ class modBoutique extends DolibarrModules $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); - /* - * Boites - */ $this->boxes[0][0] = "Livres"; $this->boxes[0][1] = "box_boutique_livre.php"; } - /* - * - * - * - */ + + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -92,9 +91,10 @@ class modBoutique extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modCaisse.class.php b/htdocs/includes/modules/modCaisse.class.php index 364f81050ee..5df44108888 100644 --- a/htdocs/includes/modules/modCaisse.class.php +++ b/htdocs/includes/modules/modCaisse.class.php @@ -41,11 +41,10 @@ include_once "DolibarrModules.class.php"; class modCaisse extends DolibarrModules { - /** Initialisation de l'objet - * - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modCaisse($DB) { $this->db = $DB ; @@ -56,20 +55,26 @@ class modCaisse extends DolibarrModules $this->description = "Gestion des comptes financiers de type Caisses liquides (pas encore opérationnel)"; $this->const_name = "MAIN_MODULE_CAISSE"; $this->const_config = MAIN_MODULE_CAISSE; + $this->special = 0; + + // Dir to create + $this->dirs = array(); // Dépendances $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); } - /** initialisation du module - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -85,9 +90,10 @@ class modCaisse extends DolibarrModules return $this->_init($sql); } - /** suppression du module - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modCommande.class.php b/htdocs/includes/modules/modCommande.class.php index 14554da9514..857c2ac0236 100644 --- a/htdocs/includes/modules/modCommande.class.php +++ b/htdocs/includes/modules/modCommande.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modCommande extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modCommande($DB) { $this->db = $DB ; @@ -57,6 +56,10 @@ class modCommande extends DolibarrModules $this->description = "Gestion des commandes"; $this->const_name = "MAIN_MODULE_COMMANDE"; $this->const_config = MAIN_MODULE_COMMANDE; + $this->special = 0; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = "commande.php"; @@ -65,17 +68,19 @@ class modCommande extends DolibarrModules $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); $this->boxes[0][0] = "Commandes"; $this->boxes[0][1] = "box_commandes.php"; } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -95,9 +100,11 @@ class modCommande extends DolibarrModules return $this->_init($sql); } - /* - * - * + + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modCommercial.class.php b/htdocs/includes/modules/modCommercial.class.php index dacf1056125..b2ce65ce307 100644 --- a/htdocs/includes/modules/modCommercial.class.php +++ b/htdocs/includes/modules/modCommercial.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modCommercial extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modCommercial($DB) { $this->db = $DB ; @@ -57,24 +56,30 @@ class modCommercial extends DolibarrModules $this->description = "Gestion commercial"; $this->const_name = "MAIN_MODULE_COMMERCIAL"; $this->const_config = MAIN_MODULE_COMMERCIAL; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array("modSociete"); $this->requiredby = array("modPropale","modContrat","modCommande",); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); $this->boxes[0][0] = "Derniers clients"; $this->boxes[0][1] = "box_clients.php"; $this->boxes[1][0] = "Derniers prospects enregistrés"; $this->boxes[1][1] = "box_prospect.php"; } - /** initialisation du module - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -85,11 +90,10 @@ class modCommercial extends DolibarrModules return $this->_init($sql); } - /** suppression du module - * - * + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ - function remove() { $sql = array(); diff --git a/htdocs/includes/modules/modComptabilite.class.php b/htdocs/includes/modules/modComptabilite.class.php index 5b10f21974b..4dde122ab53 100644 --- a/htdocs/includes/modules/modComptabilite.class.php +++ b/htdocs/includes/modules/modComptabilite.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modComptabilite extends DolibarrModules { - /** Initialisation de l'objet - * - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modComptabilite($DB) { $this->db = $DB ; @@ -68,12 +67,11 @@ class modComptabilite extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /** initialisation du module - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -91,9 +89,10 @@ class modComptabilite extends DolibarrModules return $this->_init($sql); } - /** suppression du module - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modContrat.class.php b/htdocs/includes/modules/modContrat.class.php index 852e8d72021..68e25fcf418 100644 --- a/htdocs/includes/modules/modContrat.class.php +++ b/htdocs/includes/modules/modContrat.class.php @@ -39,11 +39,10 @@ include_once "DolibarrModules.class.php"; class modContrat extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modcontrat($DB) { $this->db = $DB ; @@ -54,6 +53,10 @@ class modContrat extends DolibarrModules $this->description = "Gestion des contrats de services"; $this->const_name = "MAIN_MODULE_CONTRAT"; $this->const_config = MAIN_MODULE_CONTRAT; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array("modService"); @@ -63,12 +66,11 @@ class modContrat extends DolibarrModules $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -80,9 +82,10 @@ class modContrat extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modDon.class.php b/htdocs/includes/modules/modDon.class.php index 84bf2212249..2e66d1192b5 100644 --- a/htdocs/includes/modules/modDon.class.php +++ b/htdocs/includes/modules/modDon.class.php @@ -40,10 +40,10 @@ include_once "DolibarrModules.class.php"; class modDon extends DolibarrModules { - /* - * Initialisation - * - */ + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modDon($DB) { $this->db = $DB ; @@ -54,41 +54,41 @@ class modDon extends DolibarrModules $this->description = "Gestion des dons (expérimental)"; $this->const_name = "MAIN_MODULE_DON"; $this->const_config = MAIN_MODULE_DON; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); - $this->boxes = array(); - - /* - * Constantes - */ $this->const[0][0] = "DONS_FORM"; $this->const[0][1] = "chaine"; $this->const[0][2] = "fsfe.fr.php"; $this->const[0][3] = 'Nom du gestionnaire de formulaire de dons'; $this->const[0][4] = 1; + + // Boxes + $this->boxes = array(); } - /* - * - * - * - */ + + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { - /* - * Activation du module - */ - $sql = array(); return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modExpedition.class.php b/htdocs/includes/modules/modExpedition.class.php index 9998e37c53c..3e917906dba 100644 --- a/htdocs/includes/modules/modExpedition.class.php +++ b/htdocs/includes/modules/modExpedition.class.php @@ -40,11 +40,10 @@ include_once "DolibarrModules.class.php"; class modExpedition extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modExpedition($DB) { $this->db = $DB ; @@ -55,6 +54,10 @@ class modExpedition extends DolibarrModules $this->description = "Gestion des expéditions"; $this->const_name = "MAIN_MODULE_EXPEDITION"; $this->const_config = MAIN_MODULE_EXPEDITION; + $this->special = 0; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = "expedition.php"; @@ -63,15 +66,17 @@ class modExpedition extends DolibarrModules $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -89,9 +94,10 @@ class modExpedition extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modExternalRss.class.php b/htdocs/includes/modules/modExternalRss.class.php index ef68eb0308e..9bd76377d1c 100644 --- a/htdocs/includes/modules/modExternalRss.class.php +++ b/htdocs/includes/modules/modExternalRss.class.php @@ -40,11 +40,10 @@ include_once "DolibarrModules.class.php"; class modExternalRss extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modExternalRss($DB) { $this->db = $DB ; @@ -55,6 +54,10 @@ class modExternalRss extends DolibarrModules $this->description = "Ajout de files d'informations RSS dans les écrans Dolibarr"; $this->const_name = "MAIN_MODULE_EXTERNALRSS"; $this->const_config = MAIN_MODULE_EXTERNALRSS; + $this->special = 0; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = array("external_rss.php"); @@ -63,21 +66,20 @@ class modExternalRss extends DolibarrModules $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); - /* - * Boites - */ $this->boxes[0][0] = "Informations externes RSS"; $this->boxes[0][1] = "box_external_rss.php"; } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -88,9 +90,10 @@ class modExternalRss extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modFacture.class.php b/htdocs/includes/modules/modFacture.class.php index f98540faf6d..ae3b00dcc28 100644 --- a/htdocs/includes/modules/modFacture.class.php +++ b/htdocs/includes/modules/modFacture.class.php @@ -43,7 +43,8 @@ include_once "DolibarrModules.class.php"; class modFacture extends DolibarrModules { - /*! \brief Constructeur. Definit les noms, constantes et boites + /** + * \brief Constructeur. Definit les noms, constantes et boites * \param DB handler d'accès base */ function modFacture($DB) @@ -56,15 +57,20 @@ class modFacture extends DolibarrModules $this->description = "Gestion des factures"; $this->const_name = "MAIN_MODULE_FACTURE"; $this->const_config = MAIN_MODULE_FACTURE; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array("modSociete","modComptabilite"); $this->requiredby = array(); + // Config pages $this->config_page_url = "facture.php"; + // Constantes $this->const = array(); - $this->boxes = array(); $this->const[0][0] = "FAC_PDF_INTITULE"; $this->const[0][1] = "chaine"; @@ -102,6 +108,8 @@ class modFacture extends DolibarrModules $this->const[8][2] = "pluton"; // Boxes + $this->boxes = array(); + $this->boxes[0][0] = "Factures clients récentes impayées"; $this->boxes[0][1] = "box_factures_imp.php"; @@ -116,9 +124,10 @@ class modFacture extends DolibarrModules } - /*! \brief Fonction d'activation. Insère en base les constantes, boites et permissions du module + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. */ - function init() { $this->remove(); @@ -136,9 +145,10 @@ class modFacture extends DolibarrModules return $this->_init($sql); } - /*! \brief Fonction de désactivation. Supprime de la base les constantes, boites et permissions du module - */ - + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * 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 02d380ec476..869b11b8406 100644 --- a/htdocs/includes/modules/modFicheinter.class.php +++ b/htdocs/includes/modules/modFicheinter.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modFicheinter extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modFicheinter($DB) { $this->db = $DB ; @@ -57,6 +56,10 @@ class modFicheinter extends DolibarrModules $this->description = "Gestion des fiches d'intervention"; $this->const_name = "MAIN_MODULE_FICHEINTER"; $this->const_config = MAIN_MODULE_FICHEINTER; + $this->special = 0; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = "fichinter.php"; @@ -68,12 +71,11 @@ class modFicheinter extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -93,9 +95,10 @@ class modFicheinter extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modFournisseur.class.php b/htdocs/includes/modules/modFournisseur.class.php index 1aa3c81981d..aa788006161 100644 --- a/htdocs/includes/modules/modFournisseur.class.php +++ b/htdocs/includes/modules/modFournisseur.class.php @@ -41,11 +41,10 @@ include_once "DolibarrModules.class.php"; class modFournisseur extends DolibarrModules { - /** Initialisation de l'objet - * - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modFournisseur($DB) { $this->db = $DB ; @@ -56,22 +55,28 @@ class modFournisseur extends DolibarrModules $this->description = "Gestion des fournisseurs"; $this->const_name = "MAIN_MODULE_FOURNISSEUR"; $this->const_config = MAIN_MODULE_FOURNISSEUR; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array("modSociete"); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); $this->boxes[0][0] = "Derniers founisseurs"; $this->boxes[0][1] = "box_fournisseurs.php"; } - /** - * initialisation du module - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -81,9 +86,10 @@ class modFournisseur extends DolibarrModules return $this->_init($sql); } - /** suppression du module - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modLdap.class.php b/htdocs/includes/modules/modLdap.class.php index 7b0e530a212..2dbb33e9c7f 100644 --- a/htdocs/includes/modules/modLdap.class.php +++ b/htdocs/includes/modules/modLdap.class.php @@ -39,10 +39,10 @@ include_once "DolibarrModules.class.php"; class modLdap extends DolibarrModules { - /* - * Initialisation - * - */ + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modLdap($DB) { $this->db = $DB ; @@ -53,6 +53,10 @@ class modLdap extends DolibarrModules $this->description = "Synchronisation Ldap"; $this->const_name = "MAIN_MODULE_LDAP"; $this->const_config = MAIN_MODULE_LDAP; + $this->special = 1; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = "ldap.php"; @@ -64,11 +68,11 @@ class modLdap extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /* - * - * - * - */ + + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -80,9 +84,10 @@ class modLdap extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modPostnuke.class.php b/htdocs/includes/modules/modPostnuke.class.php index 7b37bd82f8d..1c09e47ffda 100644 --- a/htdocs/includes/modules/modPostnuke.class.php +++ b/htdocs/includes/modules/modPostnuke.class.php @@ -40,11 +40,10 @@ include_once "DolibarrModules.class.php"; class modPostnuke extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modPostnuke($DB) { $this->db = $DB ; @@ -55,22 +54,26 @@ class modPostnuke extends DolibarrModules $this->description = "Gestion de l'outil Postnuke"; $this->const_name = "MAIN_MODULE_POSTNUKE"; $this->const_config = MAIN_MODULE_POSTNUKE; - $this->special = 1; + // Dir + $this->dirs = array(); + // Dépendances $this->depends = array(); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -82,9 +85,10 @@ class modPostnuke extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modPrelevement.class.php b/htdocs/includes/modules/modPrelevement.class.php index edd44da168a..85a7348a5b2 100644 --- a/htdocs/includes/modules/modPrelevement.class.php +++ b/htdocs/includes/modules/modPrelevement.class.php @@ -39,11 +39,10 @@ include_once "DolibarrModules.class.php"; class modPrelevement extends DolibarrModules { - /** Initialisation de l'objet - * - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modPrelevement($DB) { $this->db = $DB ; @@ -54,7 +53,10 @@ class modPrelevement extends DolibarrModules $this->description = "Gestion des Prélèvements (experimental)"; $this->const_name = "MAIN_MODULE_PRELEVEMENT"; $this->const_config = MAIN_MODULE_PRELEVEMENT; + $this->special = 0; + // Dir + $this->dirs = array(); $this->data_directory = DOL_DATA_ROOT . "/prelevement/bon/"; // Dépendances @@ -64,12 +66,11 @@ class modPrelevement extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /** initialisation du module - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -85,42 +86,15 @@ class modPrelevement extends DolibarrModules * Documents * */ - if (defined("DOL_DATA_ROOT")) - { - $dir[0] = DOL_DATA_ROOT . "/prelevement/" ; - $dir[1] = DOL_DATA_ROOT . "/prelevement/bon" ; - - for ($i = 0 ; $i < sizeof($dir) ; $i++) - { - if (is_dir($dir[$i])) - { - dolibarr_syslog ("Le dossier '".$dir[$i]."' existe"); - } - else - { - if (! @mkdir($dir[$i], 0755)) - { - print "Impossible de créer : ".$dir[$i]."Erreur"; - dolibarr_syslog ("Impossible de créer '".$dir[$i]); - $error++; - } - else - { - dolibarr_syslog ("Le dossier '".$dir[$i]."' a ete créé"); - } - } - } - } - + $this->dirs[0] = DOL_DATA_ROOT . "/prelevement/" ; + $this->dirs[1] = DOL_DATA_ROOT . "/prelevement/bon" ; return $this->_init($sql); - - - } - /** suppression du module - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modProduit.class.php b/htdocs/includes/modules/modProduit.class.php index c07d267fe22..8cde8479a2f 100644 --- a/htdocs/includes/modules/modProduit.class.php +++ b/htdocs/includes/modules/modProduit.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modProduit extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modProduit($DB) { $this->db = $DB ; @@ -57,22 +56,28 @@ class modProduit extends DolibarrModules $this->description = "Gestion des produits"; $this->const_name = "MAIN_MODULE_PRODUIT"; $this->const_config = MAIN_MODULE_PRODUIT; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array(); $this->requiredby = array("modStock","modService"); + // Constantes $this->const = array(); - $this->boxes = array(); + // Boxes + $this->boxes = array(); $this->boxes[0][0] = "Derniers produits/services enregistrés"; $this->boxes[0][1] = "box_produits.php"; } - /* - * - * - * - */ + + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -92,9 +97,10 @@ class modProduit extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modProjet.class.php b/htdocs/includes/modules/modProjet.class.php index 8d4ba6c569d..ce6b3110f2d 100644 --- a/htdocs/includes/modules/modProjet.class.php +++ b/htdocs/includes/modules/modProjet.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modProjet extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modProjet($DB) { $this->db = $DB ; @@ -65,17 +64,13 @@ class modProjet extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { - /* - * Activation du module - */ /* * Permissions */ @@ -90,9 +85,10 @@ class modProjet extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modPropale.class.php b/htdocs/includes/modules/modPropale.class.php index 3abdabb1b88..4de09c172d3 100644 --- a/htdocs/includes/modules/modPropale.class.php +++ b/htdocs/includes/modules/modPropale.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modPropale extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modPropale($DB) { $this->db = $DB ; @@ -57,17 +56,18 @@ class modPropale extends DolibarrModules $this->description = "Gestion des propositions commerciales"; $this->const_name = "MAIN_MODULE_PROPALE"; $this->const_config = MAIN_MODULE_PROPALE; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array("modSociete","modCommercial"); $this->config_page_url = "propale.php"; + // Constantes $this->const = array(); - $this->boxes = array(); - /* - * Constantes - */ $this->const[0][0] = "PROPALE_ADDON_PDF"; $this->const[0][1] = "chaine"; $this->const[0][2] = "rouge"; @@ -80,18 +80,16 @@ class modPropale extends DolibarrModules $this->const[1][3] = 'Nom du gestionnaire de numérotation des propales'; $this->const[1][4] = 0; - /* - * Boites - */ + // Boxes + $this->boxes = array(); $this->boxes[0][0] = "Proposition commerciales"; $this->boxes[0][1] = "box_propales.php"; } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -115,9 +113,10 @@ class modPropale extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modService.class.php b/htdocs/includes/modules/modService.class.php index 01851a221f3..d90f20f3327 100644 --- a/htdocs/includes/modules/modService.class.php +++ b/htdocs/includes/modules/modService.class.php @@ -42,11 +42,10 @@ include_once "DolibarrModules.class.php"; class modService extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modService($DB) { $this->db = $DB ; @@ -68,12 +67,11 @@ class modService extends DolibarrModules $this->boxes[0][0] = "Derniers produits/services contractés"; $this->boxes[0][1] = "box_services_vendus.php"; } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -92,9 +90,10 @@ class modService extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modSociete.class.php b/htdocs/includes/modules/modSociete.class.php index c8906bace48..e40b4ad840d 100644 --- a/htdocs/includes/modules/modSociete.class.php +++ b/htdocs/includes/modules/modSociete.class.php @@ -42,10 +42,10 @@ include_once "DolibarrModules.class.php"; class modSociete extends DolibarrModules { - /* - * Initialisation - * - */ + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modSociete($DB) { $this->db = $DB ; @@ -56,20 +56,26 @@ class modSociete extends DolibarrModules $this->description = "Gestion des sociétés et contacts"; $this->const_name = "MAIN_MODULE_SOCIETE"; $this->const_config = MAIN_MODULE_SOCIETE; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendances $this->depends = array(); $this->requiredby = array("modFacture","modFournisseur","modFicheinter","modPropale","modContrat","modCommande"); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -85,9 +91,10 @@ class modSociete extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modStock.class.php b/htdocs/includes/modules/modStock.class.php index e1bc8543e7c..6f1bdb3ec55 100644 --- a/htdocs/includes/modules/modStock.class.php +++ b/htdocs/includes/modules/modStock.class.php @@ -40,11 +40,10 @@ include_once "DolibarrModules.class.php"; class modStock extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modStock($DB) { $this->db = $DB ; @@ -55,21 +54,27 @@ class modStock extends DolibarrModules $this->description = "Gestion des stocks"; $this->const_name = "MAIN_MODULE_STOCK"; $this->const_config = MAIN_MODULE_STOCK; + $this->special = 0; + + // Dir + $this->dirs = array(); // Dépendences $this->depends = array("modProduit"); $this->requiredby = array(); + // Constantes $this->const = array(); + + // Boxes $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -81,9 +86,10 @@ class modStock extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modTelephonie.class.php b/htdocs/includes/modules/modTelephonie.class.php index cd12f25f1ed..cd19b2a55a4 100644 --- a/htdocs/includes/modules/modTelephonie.class.php +++ b/htdocs/includes/modules/modTelephonie.class.php @@ -39,11 +39,10 @@ include_once "DolibarrModules.class.php"; class modTelephonie extends DolibarrModules { - /** Initialisation de l'objet - * - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modTelephonie($DB) { $this->db = $DB ; @@ -54,9 +53,9 @@ class modTelephonie extends DolibarrModules $this->description = "Gestion de la Telephonie (experimental)"; $this->const_name = "MAIN_MODULE_TELEPHONIE"; $this->const_config = MAIN_MODULE_TELEPHONIE; - $this->special = 1; + // Dir $this->dirs = array(); // Dépendances @@ -66,12 +65,11 @@ class modTelephonie extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /** initialisation du module - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -101,9 +99,10 @@ class modTelephonie extends DolibarrModules } - /** suppression du module - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() { diff --git a/htdocs/includes/modules/modWebcalendar.class.php b/htdocs/includes/modules/modWebcalendar.class.php index 1888525a990..9dad1cb0617 100644 --- a/htdocs/includes/modules/modWebcalendar.class.php +++ b/htdocs/includes/modules/modWebcalendar.class.php @@ -41,11 +41,10 @@ include_once "DolibarrModules.class.php"; class modWebcalendar extends DolibarrModules { - /* - * Initialisation - * - */ - + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'accès base + */ function modWebcalendar($DB) { $this->db = $DB ; @@ -56,6 +55,10 @@ class modWebcalendar extends DolibarrModules $this->description = "Gestion de l'outil Webcalendar"; $this->const_name = "MAIN_MODULE_WEBCALENDAR"; $this->const_config = MAIN_MODULE_WEBCALENDAR; + $this->special = 0; + + // Dir + $this->dirs = array(); // Config pages $this->config_page_url = "webcalendar.php"; @@ -67,12 +70,11 @@ class modWebcalendar extends DolibarrModules $this->const = array(); $this->boxes = array(); } - /* - * - * - * - */ + /** + * \brief Fonction appelé lors de l'activation du module. Insère en base les constantes, boites, permissions du module. + * Définit également les répertoires de données à créer pour ce module. + */ function init() { /* @@ -84,9 +86,10 @@ class modWebcalendar extends DolibarrModules return $this->_init($sql); } - /* - * - * + + /** + * \brief Fonction appelée lors de la désactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. */ function remove() {