From 0198464a1e0a2a66097728a57ca9a06634834dfa Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 6 Jun 2011 09:29:22 +0000 Subject: [PATCH] Doxygen --- .../interface_all_Demo.class.php-NORUN | 36 ++++++++--------- .../interface_all_Logevents.class.php | 32 +++++++-------- .../interface_modAgenda_ActionsAuto.class.php | 20 +++++----- .../interface_modLdap_Ldapsynchro.class.php | 37 ++++++++---------- ...ace_modNotification_Notification.class.php | 38 ++++++++---------- ...e_modPropale_Exportsynchro.class.php-NORUN | 39 ++++++++++--------- ...face_modWorkflow_WorkflowManager.class.php | 37 +++++++++--------- 7 files changed, 118 insertions(+), 121 deletions(-) diff --git a/htdocs/includes/triggers/interface_all_Demo.class.php-NORUN b/htdocs/includes/triggers/interface_all_Demo.class.php-NORUN index f6a533a4aed..18d7b0b8a2c 100644 --- a/htdocs/includes/triggers/interface_all_Demo.class.php-NORUN +++ b/htdocs/includes/triggers/interface_all_Demo.class.php-NORUN @@ -41,8 +41,8 @@ class InterfaceDemo var $db; /** - * \brief Constructeur. - * \param DB Handler d'acces base + * Constructor. + * @param DB Database handler */ function InterfaceDemo($DB) { @@ -56,8 +56,8 @@ class InterfaceDemo /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -65,8 +65,8 @@ class InterfaceDemo } /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -74,8 +74,8 @@ class InterfaceDemo } /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -90,19 +90,19 @@ class InterfaceDemo } /** - * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param lang Objet lang - * \param conf Objet conf - * \return int <0 if fatal error, 0 si nothing done, >0 if ok + * Function called when a Dolibarrr business event is done. + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers + * @param action Code de l'evenement + * @param object Objet concerne + * @param user Objet user + * @param langs Objet langs + * @param conf Objet conf + * @return int <0 if KO, 0 if no triggered ran, >0 if OK */ function run_trigger($action,$object,$user,$langs,$conf) { - // Mettre ici le code a executer en reaction de l'action - // Les donnees de l'action sont stockees dans $object + // Put here code you want to execute when a Dolibarr business events occurs. + // Data and type of action are stored into $object and $action // Users if ($action == 'USER_LOGIN') diff --git a/htdocs/includes/triggers/interface_all_Logevents.class.php b/htdocs/includes/triggers/interface_all_Logevents.class.php index 47b8d9b7913..e0e232d4c7e 100644 --- a/htdocs/includes/triggers/interface_all_Logevents.class.php +++ b/htdocs/includes/triggers/interface_all_Logevents.class.php @@ -41,7 +41,7 @@ class InterfaceLogevents /** * Constructor. - * @param DB Database handler access + * @param DB Database handler */ function InterfaceLogevents($DB) { @@ -54,8 +54,8 @@ class InterfaceLogevents } /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -63,8 +63,8 @@ class InterfaceLogevents } /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -72,8 +72,8 @@ class InterfaceLogevents } /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -87,15 +87,15 @@ class InterfaceLogevents } /** - * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param langs Objet langs - * \param conf Objet conf - * \param entity Entity - * \return int <0 si ko, 0 si aucune action faite, >0 si ok + * Function called when a Dolibarrr business event is done. + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers + * @param action Code de l'evenement + * @param object Objet concerne + * @param user Objet user + * @param langs Objet langs + * @param conf Objet conf + * @param entity Value for instance of data (Always 1 except if module MultiCompany is installed) + * @return int <0 if KO, 0 if no triggered ran, >0 if OK */ function run_trigger($action,$object,$user,$langs,$conf,$entity=1) { diff --git a/htdocs/includes/triggers/interface_modAgenda_ActionsAuto.class.php b/htdocs/includes/triggers/interface_modAgenda_ActionsAuto.class.php index dec23a7426d..9339e5573ca 100644 --- a/htdocs/includes/triggers/interface_modAgenda_ActionsAuto.class.php +++ b/htdocs/includes/triggers/interface_modAgenda_ActionsAuto.class.php @@ -53,8 +53,8 @@ class InterfaceActionsAuto } /** - * Return name of triggers set - * @return string Name of triggers set + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -62,8 +62,8 @@ class InterfaceActionsAuto } /** - * Return description of triggers set - * @return string Description of triggers set + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -71,8 +71,8 @@ class InterfaceActionsAuto } /** - * Return version of triggers set - * @return string Version of triggers set + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -87,7 +87,7 @@ class InterfaceActionsAuto /** * Function called when a Dolibarrr business event is done. - * All functions run_trigger are triggered if file is inside directory includes/triggers + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers * * Following properties must be filled: * $object->actiontypecode (translation action code: AC_OTH, ...) @@ -109,8 +109,10 @@ class InterfaceActionsAuto function run_trigger($action,$object,$user,$langs,$conf) { $key='MAIN_AGENDA_ACTIONAUTO_'.$action; - //dol_syslog("xxxxxxxxxxx".$key); - if (empty($conf->global->$key)) return 0; // Log events not enabled for this action + //dol_syslog("xxxxxxxxxxx".$key); + + if (empty($conf->agenda->enabled)) return 0; // Module not active, we do nothing + if (empty($conf->global->$key)) return 0; // Log events not enabled for this action $ok=0; diff --git a/htdocs/includes/triggers/interface_modLdap_Ldapsynchro.class.php b/htdocs/includes/triggers/interface_modLdap_Ldapsynchro.class.php index 38947e60790..2efa8c80f92 100644 --- a/htdocs/includes/triggers/interface_modLdap_Ldapsynchro.class.php +++ b/htdocs/includes/triggers/interface_modLdap_Ldapsynchro.class.php @@ -36,8 +36,8 @@ class InterfaceLdapsynchro /** - * \brief Constructeur. - * \param DB Handler d'acces base + * Constructor. + * @param DB Database handler */ function InterfaceLdapsynchro($DB) { @@ -50,8 +50,8 @@ class InterfaceLdapsynchro } /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -59,8 +59,8 @@ class InterfaceLdapsynchro } /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -68,8 +68,8 @@ class InterfaceLdapsynchro } /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -83,21 +83,18 @@ class InterfaceLdapsynchro } /** - * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param lang Objet lang - * \param conf Objet conf - * \return int <0 si ko, 0 si aucune action faite, >0 si ok + * Function called when a Dolibarrr business event is done. + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers + * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...) + * @param object Object action is done on + * @param user Object user + * @param langs Object langs + * @param conf Object conf + * @return int <0 if KO, 0 if no action are done, >0 if OK */ function run_trigger($action,$object,$user,$langs,$conf) { - // Mettre ici le code a executer en reaction de l'action - // Les donnees de l'action sont stockees dans $object - - if (! $conf->ldap->enabled) return 0; // Module non actif + if (empty($conf->ldap->enabled)) return 0; // Module not active, we do nothing if (! function_exists('ldap_connect')) { diff --git a/htdocs/includes/triggers/interface_modNotification_Notification.class.php b/htdocs/includes/triggers/interface_modNotification_Notification.class.php index 702daf981d1..49b34af40ed 100644 --- a/htdocs/includes/triggers/interface_modNotification_Notification.class.php +++ b/htdocs/includes/triggers/interface_modNotification_Notification.class.php @@ -36,8 +36,8 @@ class InterfaceNotification 'FICHEINTER_VALIDATE','ORDER_SUPPLIER_APPROVE','ORDER_SUPPLIER_REFUSE'); /** - * \brief Constructeur. - * \param DB Handler d'acces base + * Constructor. + * @param DB Database handler */ function InterfaceNotification($DB) { @@ -50,8 +50,8 @@ class InterfaceNotification } /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -59,8 +59,8 @@ class InterfaceNotification } /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -68,8 +68,8 @@ class InterfaceNotification } /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -83,22 +83,18 @@ class InterfaceNotification } /** - * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param lang Objet lang - * \param conf Objet conf - * \return int <0 si ko, 0 si aucune action faite, >0 si ok + * Function called when a Dolibarrr business event is done. + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers + * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...) + * @param object Object action is done on + * @param user Object user + * @param langs Object langs + * @param conf Object conf + * @return int <0 if KO, 0 if no action are done, >0 if OK */ function run_trigger($action,$object,$user,$langs,$conf) { - // Mettre ici le code a executer en reaction de l'action - // Les donnees de l'action sont stockees dans $object - - // Si module notification non actif, on ne fait rien - if (! $conf->notification->enabled) return 0; + if (empty($conf->notification->enabled)) return 0; // Module not active, we do nothing require_once(DOL_DOCUMENT_ROOT .'/core/class/notify.class.php'); diff --git a/htdocs/includes/triggers/interface_modPropale_Exportsynchro.class.php-NORUN b/htdocs/includes/triggers/interface_modPropale_Exportsynchro.class.php-NORUN index 1c05cff6fe0..bcbae646407 100644 --- a/htdocs/includes/triggers/interface_modPropale_Exportsynchro.class.php-NORUN +++ b/htdocs/includes/triggers/interface_modPropale_Exportsynchro.class.php-NORUN @@ -35,8 +35,8 @@ class InterfaceExportsynchro var $db; /** - * \brief Constructeur. - * \param DB Handler d'acces base + * Constructor. + * @param DB Database handler */ function InterfaceExportsynchro($DB) { @@ -50,8 +50,8 @@ class InterfaceExportsynchro /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -59,8 +59,8 @@ class InterfaceExportsynchro } /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -68,8 +68,8 @@ class InterfaceExportsynchro } /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -84,19 +84,18 @@ class InterfaceExportsynchro } /** - * \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param lang Objet lang - * \param conf Objet conf - * \return int <0 if fatal error, 0 si nothing done, >0 if ok + * Function called when a Dolibarrr business event is done. + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers + * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...) + * @param object Object action is done on + * @param user Object user + * @param langs Object langs + * @param conf Object conf + * @return int <0 if KO, 0 if no action are done, >0 if OK */ function run_trigger($action,$object,$user,$langs,$conf) { - // Mettre ici le code a executer en reaction de l'action - // Les donnees de l'action sont stockees dans $object + if (empty($conf->propale->enabled)) return 0; // Module not active, we do nothing // Proposals if ($action == 'PROPAL_CLOSE_SIGNED') @@ -108,6 +107,10 @@ class InterfaceExportsynchro return 0; } + + /** + * Create a CVS export file + */ function _create_csv_files($action,$object,$user,$langs,$conf) { include_once(DOL_DOCUMENT_ROOT."/comm/propal/class/propal.class.php"); diff --git a/htdocs/includes/triggers/interface_modWorkflow_WorkflowManager.class.php b/htdocs/includes/triggers/interface_modWorkflow_WorkflowManager.class.php index 0d247afb34b..2ba6172b928 100755 --- a/htdocs/includes/triggers/interface_modWorkflow_WorkflowManager.class.php +++ b/htdocs/includes/triggers/interface_modWorkflow_WorkflowManager.class.php @@ -34,8 +34,8 @@ class InterfaceWorkflowManager var $db; /** - * \brief Constructeur. - * \param DB Handler d'acces base + * Constructor. + * @param DB Database handler */ function InterfaceWorkflowManager($DB) { @@ -49,8 +49,8 @@ class InterfaceWorkflowManager /** - * \brief Renvoi nom du lot de triggers - * \return string Nom du lot de triggers + * Return name of trigger file + * @return string Name of trigger file */ function getName() { @@ -58,8 +58,8 @@ class InterfaceWorkflowManager } /** - * \brief Renvoi descriptif du lot de triggers - * \return string Descriptif du lot de triggers + * Return description of trigger file + * @return string Description of trigger file */ function getDesc() { @@ -67,8 +67,8 @@ class InterfaceWorkflowManager } /** - * \brief Renvoi version du lot de triggers - * \return string Version du lot de triggers + * Return version of trigger file + * @return string Version of trigger file */ function getVersion() { @@ -83,21 +83,20 @@ class InterfaceWorkflowManager } /** - * Fonction appelee lors du declenchement d'un evenement Dolibarr. - * D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers - * \param action Code de l'evenement - * \param object Objet concerne - * \param user Objet user - * \param lang Objet lang - * \param conf Objet conf - * \return int <0 if fatal error, 0 si nothing done, >0 if ok + * Function called when a Dolibarrr business event is done. + * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers + * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...) + * @param object Object action is done on + * @param user Object user + * @param langs Object langs + * @param conf Object conf + * @return int <0 if KO, 0 if no action are done, >0 if OK */ function run_trigger($action,$object,$user,$langs,$conf) { - // Mettre ici le code a executer en reaction de l'action - // Les donnees de l'action sont stockees dans $object + if (empty($conf->workflow->enabled)) return 0; // Module not active, we do nothing - // Proposals + // Proposals to order if ($action == 'PROPAL_CLOSE_SIGNED') { dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id);