From 164d4365b4b4eb05416af6050a3ce198fa9d451f Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 14 Feb 2011 18:29:06 +0000 Subject: [PATCH] Doxygen --- htdocs/includes/modules/modBanque.class.php | 26 +++++++++++------- htdocs/includes/modules/modSociete.class.php | 28 ++++++++++++-------- htdocs/includes/modules/modUser.class.php | 20 ++++++++------ 3 files changed, 46 insertions(+), 28 deletions(-) diff --git a/htdocs/includes/modules/modBanque.class.php b/htdocs/includes/modules/modBanque.class.php index 4119747b004..7cd88ca981d 100644 --- a/htdocs/includes/modules/modBanque.class.php +++ b/htdocs/includes/modules/modBanque.class.php @@ -151,7 +151,11 @@ class modBanque extends DolibarrModules $this->export_fields_array[$r]=array('b.rowid'=>'IdTransaction','ba.ref'=>'AccountRef','ba.label'=>'AccountLabel','b.datev'=>'DateValue','b.dateo'=>'DateOperation','b.label'=>'Label','b.num_chq'=>'ChequeOrTransferNumber','-b.amount'=>'Debit','b.amount'=>'Credit','b.num_releve'=>'AccountStatement','b.datec'=>"DateCreation","bu.url_id"=>"IdThirdParty","s.nom"=>"ThirdParty","s.code_compta"=>"CustomerAccountancyCode","s.code_compta_fournisseur"=>"SupplierAccountancyCode"); $this->export_entities_array[$r]=array('b.rowid'=>'account','ba.ref'=>'account','ba.label'=>'account','b.datev'=>'account','b.dateo'=>'account','b.label'=>'account','b.num_chq'=>'account','-b.amount'=>'account','b.amount'=>'account','b.num_releve'=>'account','b.datec'=>"account","bu.url_id"=>"company","s.nom"=>"company","s.code_compta"=>"company","s.code_compta_fournisseur"=>"company"); $this->export_special_array[$r]=array('-b.amount'=>'NULLIFNEG','b.amount'=>'NULLIFNEG'); - + if (empty($conf->fournisseur->enabled)) + { + unset($this->export_fields_array[$r]['s.code_compta_fournisseur']); + unset($this->export_entities_array[$r]['s.code_compta_fournisseur']); + } $this->export_sql_start[$r]='SELECT DISTINCT '; $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'bank_account as ba, '.MAIN_DB_PREFIX.'bank as b)'; $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX."bank_url as bu ON (bu.fk_bank = b.rowid AND bu.type = 'company')"; @@ -162,10 +166,12 @@ class modBanque extends DolibarrModules } - /** - * \brief Fonction appel�e 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 called when module is enabled. + * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. + * It also creates data directories. + * @return int 1 if OK, 0 if KO + */ function init() { global $conf; @@ -178,10 +184,12 @@ class modBanque 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 called when module is disabled. + * Remove from database constants, boxes and permissions from Dolibarr database. + * Data directories are not deleted. + * @return int 1 if OK, 0 if KO + */ function remove() { $sql = array(); diff --git a/htdocs/includes/modules/modSociete.class.php b/htdocs/includes/modules/modSociete.class.php index 86548ac1b68..9c8c80650b9 100644 --- a/htdocs/includes/modules/modSociete.class.php +++ b/htdocs/includes/modules/modSociete.class.php @@ -222,7 +222,11 @@ class modSociete extends DolibarrModules $this->export_permission[$r]=array(array("societe","contact","export")); $this->export_fields_array[$r]=array('c.rowid'=>"IdContact",'c.civilite'=>"CivilityCode",'c.name'=>'Lastname','c.firstname'=>'Firstname','c.datec'=>"DateCreation",'c.tms'=>"DateLastModification",'c.priv'=>"ContactPrivate",'c.address'=>"Address",'c.cp'=>"Zip",'c.ville'=>"Town",'c.phone'=>"Phone",'c.fax'=>"Fax",'c.email'=>"EMail",'p.libelle'=>"Country",'p.code'=>"CountryCode",'s.rowid'=>"IdCompany",'s.nom'=>"CompanyName",'s.code_client'=>"CustomerCode",'s.code_fournisseur'=>"SupplierCode"); $this->export_entities_array[$r]=array('s.rowid'=>"company",'s.nom'=>"company",'s.code_client'=>"company",'s.code_fournisseur'=>"company"); // We define here only fields that use another picto - + if (empty($conf->fournisseur->enabled)) + { + unset($this->export_fields_array[$r]['s.code_fournisseur']); + unset($this->export_entities_array[$r]['s.code_fournisseur']); + } $this->export_sql_start[$r]='SELECT DISTINCT '; $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'c_pays as p, '.MAIN_DB_PREFIX.'socpeople as c'; $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'societe as s ON c.fk_soc = s.rowid'; @@ -262,11 +266,12 @@ class modSociete extends DolibarrModules } - /** - * Fonction appelee lors de l'activation du module. Insere en base les constantes, boites, permissions du module. - * Definit egalement les repertoires de donnees a creer pour ce module. - * @param options Options when enabling module - */ + /** + * Function called when module is enabled. + * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. + * It also creates data directories. + * @return int 1 if OK, 0 if KO + */ function init($options='') { global $conf; @@ -284,11 +289,12 @@ class modSociete extends DolibarrModules return $this->_init($sql,$options); } - /** - * Fonction appelee lors de la desactivation d'un module. - * Supprime de la base les constantes, boites et permissions du module. - * @param options Options when disabling module - */ + /** + * Function called when module is disabled. + * Remove from database constants, boxes and permissions from Dolibarr database. + * Data directories are not deleted. + * @return int 1 if OK, 0 if KO + */ function remove($options='') { $sql = array(); diff --git a/htdocs/includes/modules/modUser.class.php b/htdocs/includes/modules/modUser.class.php index a445f298ca2..643ca900c39 100644 --- a/htdocs/includes/modules/modUser.class.php +++ b/htdocs/includes/modules/modUser.class.php @@ -226,10 +226,12 @@ class modUser extends DolibarrModules } - /** - * \brief Fonction appelee lors de l'activation du module. Insere en base les constantes, boites, permissions du module. - * Definit egalement les repertoires de donnees a creer pour ce module. - */ + /** + * Function called when module is enabled. + * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. + * It also creates data directories. + * @return int 1 if OK, 0 if KO + */ function init() { global $conf; @@ -242,10 +244,12 @@ class modUser extends DolibarrModules return $this->_init($sql); } - /** - \brief Fonction appelee lors de la desactivation d'un module. - Supprime de la base les constantes, boites et permissions du module. - */ + /** + * Function called when module is disabled. + * Remove from database constants, boxes and permissions from Dolibarr database. + * Data directories are not deleted. + * @return int 1 if OK, 0 if KO + */ function remove() { $sql = array();