lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2011-06-06 09:29:22 +00:00
parent cf7c5d990f
commit 0198464a1e
7 changed files with 118 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
htdocs/includes/triggers/interface_all_Demo.class.php-NORUN
View File

@ -41,8 +41,8 @@ class InterfaceDemo
var $db; var $db;
/** /**
* \brief Constructeur. * Constructor.
* \param DB Handler d'acces base * @param DB Database handler
*/ */
function InterfaceDemo($DB) function InterfaceDemo($DB)
{ {
@ -56,8 +56,8 @@ class InterfaceDemo
/** /**
* \brief Renvoi nom du lot de triggers * Return name of trigger file
* \return string Nom du lot de triggers * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -65,8 +65,8 @@ class InterfaceDemo
} }
/** /**
* \brief Renvoi descriptif du lot de triggers * Return description of trigger file
* \return string Descriptif du lot de triggers * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -74,8 +74,8 @@ class InterfaceDemo
} }
/** /**
* \brief Renvoi version du lot de triggers * Return version of trigger file
* \return string Version du lot de triggers * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -90,19 +90,19 @@ class InterfaceDemo
} }
/** /**
* \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. * Function called when a Dolibarrr business event is done.
* D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers
* \param action Code de l'evenement * @param action Code de l'evenement
* \param object Objet concerne * @param object Objet concerne
* \param user Objet user * @param user Objet user
* \param lang Objet lang * @param langs Objet langs
* \param conf Objet conf * @param conf Objet conf
* \return int <0 if fatal error, 0 si nothing done, >0 if ok * @return int <0 if KO, 0 if no triggered ran, >0 if OK
*/ */
function run_trigger($action,$object,$user,$langs,$conf) function run_trigger($action,$object,$user,$langs,$conf)
{ {
// Mettre ici le code a executer en reaction de l'action // Put here code you want to execute when a Dolibarr business events occurs.
// Les donnees de l'action sont stockees dans $object // Data and type of action are stored into $object and $action
// Users // Users
if ($action == 'USER_LOGIN') if ($action == 'USER_LOGIN')

32
htdocs/includes/triggers/interface_all_Logevents.class.php
View File

@ -41,7 +41,7 @@ class InterfaceLogevents
/** /**
* Constructor. * Constructor.
* @param DB Database handler access * @param DB Database handler
*/ */
function InterfaceLogevents($DB) function InterfaceLogevents($DB)
{ {
@ -54,8 +54,8 @@ class InterfaceLogevents
} }
/** /**
* \brief Renvoi nom du lot de triggers * Return name of trigger file
* \return string Nom du lot de triggers * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -63,8 +63,8 @@ class InterfaceLogevents
} }
/** /**
* \brief Renvoi descriptif du lot de triggers * Return description of trigger file
* \return string Descriptif du lot de triggers * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -72,8 +72,8 @@ class InterfaceLogevents
} }
/** /**
* \brief Renvoi version du lot de triggers * Return version of trigger file
* \return string Version du lot de triggers * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -87,15 +87,15 @@ class InterfaceLogevents
} }
/** /**
* \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. * Function called when a Dolibarrr business event is done.
* D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers
* \param action Code de l'evenement * @param action Code de l'evenement
* \param object Objet concerne * @param object Objet concerne
* \param user Objet user * @param user Objet user
* \param langs Objet langs * @param langs Objet langs
* \param conf Objet conf * @param conf Objet conf
* \param entity Entity * @param entity Value for instance of data (Always 1 except if module MultiCompany is installed)
* \return int <0 si ko, 0 si aucune action faite, >0 si ok * @return int <0 if KO, 0 if no triggered ran, >0 if OK
*/ */
function run_trigger($action,$object,$user,$langs,$conf,$entity=1) function run_trigger($action,$object,$user,$langs,$conf,$entity=1)
{ {

20
htdocs/includes/triggers/interface_modAgenda_ActionsAuto.class.php
View File

@ -53,8 +53,8 @@ class InterfaceActionsAuto
} }
/** /**
* Return name of triggers set * Return name of trigger file
* @return string Name of triggers set * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -62,8 +62,8 @@ class InterfaceActionsAuto
} }
/** /**
* Return description of triggers set * Return description of trigger file
* @return string Description of triggers set * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -71,8 +71,8 @@ class InterfaceActionsAuto
} }
/** /**
* Return version of triggers set * Return version of trigger file
* @return string Version of triggers set * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -87,7 +87,7 @@ class InterfaceActionsAuto
/** /**
* Function called when a Dolibarrr business event is done. * 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: * Following properties must be filled:
* $object->actiontypecode (translation action code: AC_OTH, ...) * $object->actiontypecode (translation action code: AC_OTH, ...)
@ -109,8 +109,10 @@ class InterfaceActionsAuto
function run_trigger($action,$object,$user,$langs,$conf) function run_trigger($action,$object,$user,$langs,$conf)
{ {
$key='MAIN_AGENDA_ACTIONAUTO_'.$action; $key='MAIN_AGENDA_ACTIONAUTO_'.$action;
//dol_syslog("xxxxxxxxxxx".$key); //dol_syslog("xxxxxxxxxxx".$key);
if (empty($conf->global->$key)) return 0; // Log events not enabled for this action
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; $ok=0;

37
htdocs/includes/triggers/interface_modLdap_Ldapsynchro.class.php
View File

@ -36,8 +36,8 @@ class InterfaceLdapsynchro
/** /**
* \brief Constructeur. * Constructor.
* \param DB Handler d'acces base * @param DB Database handler
*/ */
function InterfaceLdapsynchro($DB) function InterfaceLdapsynchro($DB)
{ {
@ -50,8 +50,8 @@ class InterfaceLdapsynchro
} }
/** /**
* \brief Renvoi nom du lot de triggers * Return name of trigger file
* \return string Nom du lot de triggers * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -59,8 +59,8 @@ class InterfaceLdapsynchro
} }
/** /**
* \brief Renvoi descriptif du lot de triggers * Return description of trigger file
* \return string Descriptif du lot de triggers * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -68,8 +68,8 @@ class InterfaceLdapsynchro
} }
/** /**
* \brief Renvoi version du lot de triggers * Return version of trigger file
* \return string Version du lot de triggers * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -83,21 +83,18 @@ class InterfaceLdapsynchro
} }
/** /**
* \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. * Function called when a Dolibarrr business event is done.
* D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers
* \param action Code de l'evenement * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
* \param object Objet concerne * @param object Object action is done on
* \param user Objet user * @param user Object user
* \param lang Objet lang * @param langs Object langs
* \param conf Objet conf * @param conf Object conf
* \return int <0 si ko, 0 si aucune action faite, >0 si ok * @return int <0 if KO, 0 if no action are done, >0 if OK
*/ */
function run_trigger($action,$object,$user,$langs,$conf) function run_trigger($action,$object,$user,$langs,$conf)
{ {
// Mettre ici le code a executer en reaction de l'action if (empty($conf->ldap->enabled)) return 0; // Module not active, we do nothing
// Les donnees de l'action sont stockees dans $object
if (! $conf->ldap->enabled) return 0; // Module non actif
if (! function_exists('ldap_connect')) if (! function_exists('ldap_connect'))
{ {

38
htdocs/includes/triggers/interface_modNotification_Notification.class.php
View File

@ -36,8 +36,8 @@ class InterfaceNotification
'FICHEINTER_VALIDATE','ORDER_SUPPLIER_APPROVE','ORDER_SUPPLIER_REFUSE'); 'FICHEINTER_VALIDATE','ORDER_SUPPLIER_APPROVE','ORDER_SUPPLIER_REFUSE');
/** /**
* \brief Constructeur. * Constructor.
* \param DB Handler d'acces base * @param DB Database handler
*/ */
function InterfaceNotification($DB) function InterfaceNotification($DB)
{ {
@ -50,8 +50,8 @@ class InterfaceNotification
} }
/** /**
* \brief Renvoi nom du lot de triggers * Return name of trigger file
* \return string Nom du lot de triggers * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -59,8 +59,8 @@ class InterfaceNotification
} }
/** /**
* \brief Renvoi descriptif du lot de triggers * Return description of trigger file
* \return string Descriptif du lot de triggers * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -68,8 +68,8 @@ class InterfaceNotification
} }
/** /**
* \brief Renvoi version du lot de triggers * Return version of trigger file
* \return string Version du lot de triggers * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -83,22 +83,18 @@ class InterfaceNotification
} }
/** /**
* \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. * Function called when a Dolibarrr business event is done.
* D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers
* \param action Code de l'evenement * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
* \param object Objet concerne * @param object Object action is done on
* \param user Objet user * @param user Object user
* \param lang Objet lang * @param langs Object langs
* \param conf Objet conf * @param conf Object conf
* \return int <0 si ko, 0 si aucune action faite, >0 si ok * @return int <0 if KO, 0 if no action are done, >0 if OK
*/ */
function run_trigger($action,$object,$user,$langs,$conf) function run_trigger($action,$object,$user,$langs,$conf)
{ {
// Mettre ici le code a executer en reaction de l'action if (empty($conf->notification->enabled)) return 0; // Module not active, we do nothing
// Les donnees de l'action sont stockees dans $object
// Si module notification non actif, on ne fait rien
if (! $conf->notification->enabled) return 0;
require_once(DOL_DOCUMENT_ROOT .'/core/class/notify.class.php'); require_once(DOL_DOCUMENT_ROOT .'/core/class/notify.class.php');

39
htdocs/includes/triggers/interface_modPropale_Exportsynchro.class.php-NORUN
View File

@ -35,8 +35,8 @@ class InterfaceExportsynchro
var $db; var $db;
/** /**
* \brief Constructeur. * Constructor.
* \param DB Handler d'acces base * @param DB Database handler
*/ */
function InterfaceExportsynchro($DB) function InterfaceExportsynchro($DB)
{ {
@ -50,8 +50,8 @@ class InterfaceExportsynchro
/** /**
* \brief Renvoi nom du lot de triggers * Return name of trigger file
* \return string Nom du lot de triggers * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -59,8 +59,8 @@ class InterfaceExportsynchro
} }
/** /**
* \brief Renvoi descriptif du lot de triggers * Return description of trigger file
* \return string Descriptif du lot de triggers * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -68,8 +68,8 @@ class InterfaceExportsynchro
} }
/** /**
* \brief Renvoi version du lot de triggers * Return version of trigger file
* \return string Version du lot de triggers * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -84,19 +84,18 @@ class InterfaceExportsynchro
} }
/** /**
* \brief Fonction appelee lors du declenchement d'un evenement Dolibarr. * Function called when a Dolibarrr business event is done.
* D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers
* \param action Code de l'evenement * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
* \param object Objet concerne * @param object Object action is done on
* \param user Objet user * @param user Object user
* \param lang Objet lang * @param langs Object langs
* \param conf Objet conf * @param conf Object conf
* \return int <0 if fatal error, 0 si nothing done, >0 if ok * @return int <0 if KO, 0 if no action are done, >0 if OK
*/ */
function run_trigger($action,$object,$user,$langs,$conf) function run_trigger($action,$object,$user,$langs,$conf)
{ {
// Mettre ici le code a executer en reaction de l'action if (empty($conf->propale->enabled)) return 0; // Module not active, we do nothing
// Les donnees de l'action sont stockees dans $object
// Proposals // Proposals
if ($action == 'PROPAL_CLOSE_SIGNED') if ($action == 'PROPAL_CLOSE_SIGNED')
@ -108,6 +107,10 @@ class InterfaceExportsynchro
return 0; return 0;
} }
/**
* Create a CVS export file
*/
function _create_csv_files($action,$object,$user,$langs,$conf) function _create_csv_files($action,$object,$user,$langs,$conf)
{ {
include_once(DOL_DOCUMENT_ROOT."/comm/propal/class/propal.class.php"); include_once(DOL_DOCUMENT_ROOT."/comm/propal/class/propal.class.php");

37
htdocs/includes/triggers/interface_modWorkflow_WorkflowManager.class.php
View File

@ -34,8 +34,8 @@ class InterfaceWorkflowManager
var $db; var $db;
/** /**
* \brief Constructeur. * Constructor.
* \param DB Handler d'acces base * @param DB Database handler
*/ */
function InterfaceWorkflowManager($DB) function InterfaceWorkflowManager($DB)
{ {
@ -49,8 +49,8 @@ class InterfaceWorkflowManager
/** /**
* \brief Renvoi nom du lot de triggers * Return name of trigger file
* \return string Nom du lot de triggers * @return string Name of trigger file
*/ */
function getName() function getName()
{ {
@ -58,8 +58,8 @@ class InterfaceWorkflowManager
} }
/** /**
* \brief Renvoi descriptif du lot de triggers * Return description of trigger file
* \return string Descriptif du lot de triggers * @return string Description of trigger file
*/ */
function getDesc() function getDesc()
{ {
@ -67,8 +67,8 @@ class InterfaceWorkflowManager
} }
/** /**
* \brief Renvoi version du lot de triggers * Return version of trigger file
* \return string Version du lot de triggers * @return string Version of trigger file
*/ */
function getVersion() function getVersion()
{ {
@ -83,21 +83,20 @@ class InterfaceWorkflowManager
} }
/** /**
* Fonction appelee lors du declenchement d'un evenement Dolibarr. * Function called when a Dolibarrr business event is done.
* D'autres fonctions run_trigger peuvent etre presentes dans includes/triggers * All functions "run_trigger" are triggered if file is inside directory htdocs/includes/triggers
* \param action Code de l'evenement * @param action Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
* \param object Objet concerne * @param object Object action is done on
* \param user Objet user * @param user Object user
* \param lang Objet lang * @param langs Object langs
* \param conf Objet conf * @param conf Object conf
* \return int <0 if fatal error, 0 si nothing done, >0 if ok * @return int <0 if KO, 0 if no action are done, >0 if OK
*/ */
function run_trigger($action,$object,$user,$langs,$conf) function run_trigger($action,$object,$user,$langs,$conf)
{ {
// Mettre ici le code a executer en reaction de l'action if (empty($conf->workflow->enabled)) return 0; // Module not active, we do nothing
// Les donnees de l'action sont stockees dans $object
// Proposals // Proposals to order
if ($action == 'PROPAL_CLOSE_SIGNED') if ($action == 'PROPAL_CLOSE_SIGNED')
{ {
dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id); dol_syslog("Trigger '".$this->name."' for action '$action' launched by ".__FILE__.". id=".$object->id);