Dolibarr ERP CRM Wiki - User contributions [en]

List of modules id

2016-04-22T12:54:20Z

Jeanbaptistejeannot: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}} This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here.

{{Flag fr}} Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici.

{{Flag sp}} Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

= ID 0 - 99999 =
{{Flag en}} Reserved for Dolibarr's internal modules.

{{Flag fr}} Réservé aux modules internes de Dolibarr.

{{Flag sp}} Reservado a los módulos internos de Dolibarr.

= ID 100000 - 499999 =
{{Flag en}} Reserved area for editors in need for an ID range. You can edit this page to add your own range (limited to 1000 values per editor)

{{Flag fr}} Zone réservé aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limité à 1000 valeurs par éditeur)

{{Flag sp}} Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 1000 valores por editor)

* ID 100000 - 100999: OpenThink (http://www.openthink.be)
* ID 101000 - 101999: NLTechno (http://www.nltechno.com)
* ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
* ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
* ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
* ID 105000 - 105999: GPC.solutions
* ID 106000 - 106999: PHPASSO
* ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
* ID 108000 - 108999: ETHICWEB
* ID 109000 - 109999: Aplose
* ID 110000 - 110999: Aternatik
* ID 111000 - 111999: Asset IT (www.assetit.ch)
* ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
* ID 113000 - 113999: Asilib - Alexandre Spangaro
* ID 114000 - 114999: Iceleaf OÜ
* ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
* ID 116000 - 116999: Wolftec GmbH
* ID 117000 - 117999: Oscim (http://www.oscim.fr)
* ID 118000 - 118999: Oarces Web (dev.oarces.com)
* ID 119000 - 119999: Manuel Berrocal - Absolacom
* ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
* ID 121000 - 121999: Oscss - Shop
* ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
* ID 140000 - 140999: Altairis
* ID 150000 - 150999: Jeffinfo
* ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
* ID 190000 - 190999: Diciannove (http://19.coop)
* ID 199000 - 199999: RFMS
* ID 200000 - 200999: Noxiome
* ID 201000 - 201999: Sasa Ostrouska (saxa)
* ID 202000 - 202999: Z-Application
* ID 203000 - 203099: Elidee - elidee.com
* ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
* ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
* ID 205000 - 205999: Kreiz IT
* ID 300000 - 300999: AtooNet (http://www.atoo-net.com)
* ID 400000 - 400999: 2byte.es (http://www.2byte.es)
* ID 401000 - 401999: B&D Informática
* ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
* ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
* ID 404000 - 404999: Aikhan
* ID 405000 - 405999: AIME (http://www.aime.mx)
* ID 420000 - 420099: BBS Concept
* ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
* ID 420200 - 421199: VatCheck (www.abnc.be)
* ID 422200 - 422999: Artaban (http://artaban.fr)
* ID 423000 - 423050: cyberesprit
* ID 424000 - 424999: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr)
* ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
* ID 426000 - 426099: Arkesis-Solution
* ID 426100 - 426149: GetLandy (www.getlandy.com)

= ID > 500000 =
{{Flag en}} If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (1000 ids maximum per partner).

{{Flag fr}} Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (pas plus de 1000 numéros par partenaire).

{{Flag sp}} Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

List of modules id

2016-04-22T12:53:31Z

Jeanbaptistejeannot: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}} This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here.

{{Flag fr}} Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici.

{{Flag sp}} Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

= ID 0 - 99999 =
{{Flag en}} Reserved for Dolibarr's internal modules.

{{Flag fr}} Réservé aux modules internes de Dolibarr.

{{Flag sp}} Reservado a los módulos internos de Dolibarr.

= ID 100000 - 499999 =
{{Flag en}} Reserved area for editors in need for an ID range. You can edit this page to add your own range (limited to 1000 values per editor)

{{Flag fr}} Zone réservé aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limité à 1000 valeurs par éditeur)

{{Flag sp}} Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 1000 valores por editor)

* ID 100000 - 100999: OpenThink (http://www.openthink.be)
* ID 101000 - 101999: NLTechno (http://www.nltechno.com)
* ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
* ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
* ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
* ID 105000 - 105999: GPC.solutions
* ID 106000 - 106999: PHPASSO
* ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
* ID 108000 - 108999: ETHICWEB
* ID 109000 - 109999: Aplose
* ID 110000 - 110999: Aternatik
* ID 111000 - 111999: Asset IT (www.assetit.ch)
* ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
* ID 113000 - 113999: Asilib - Alexandre Spangaro
* ID 114000 - 114999: Iceleaf OÜ
* ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
* ID 116000 - 116999: Wolftec GmbH
* ID 117000 - 117999: Oscim (http://www.oscim.fr)
* ID 118000 - 118999: Oarces Web (dev.oarces.com)
* ID 119000 - 119999: Manuel Berrocal - Absolacom
* ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
* ID 121000 - 121999: Oscss - Shop
* ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
* ID 140000 - 140999: Altairis
* ID 150000 - 150999: Jeffinfo
* ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
* ID 190000 - 190999: Diciannove (http://19.coop)
* ID 199000 - 199999: RFMS
* ID 200000 - 200999: Noxiome
* ID 201000 - 201999: Sasa Ostrouska (saxa)
* ID 202000 - 202999: Z-Application
* ID 203000 - 203099: Elidee - elidee.com
* ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
* ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
* ID 205000 - 205999: Kreiz IT
* ID 300000 - 300999: AtooNet (http://www.atoo-net.com)
* ID 400000 - 400999: 2byte.es (http://www.2byte.es)
* ID 401000 - 401999: B&D Informática
* ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
* ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
* ID 404000 - 404999: Aikhan
* ID 405000 - 405999: AIME (http://www.aime.mx)
* ID 420000 - 420099: BBS Concept
* ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
* ID 420200 - 421199: VatCheck (www.abnc.be)
* ID 422200 - 422999: Artaban (http://artaban.fr)
* ID 423000 - 423050: cyberesprit
* ID 424000 - 424999: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr)
* ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
* ID 426000 - 426099: Arkesis-Solution
* ID 426100 - 426199: GetLandy (www.getlandy.com)

= ID > 500000 =
{{Flag en}} If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (1000 ids maximum per partner).

{{Flag fr}} Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (pas plus de 1000 numéros par partenaire).

{{Flag sp}} Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

Système de Triggers

2016-04-18T07:22:08Z

Jeanbaptistejeannot: /* Ajouter son code sur un événement Dolibarr */

{{TemplateDocDevFr}}

= Ajouter son code sur un événement Dolibarr =

Pour permettre de déclencher du code personnalisé en réaction à un évènement Dolibarr (création/modification/suppression d'une société/facture/produit/utilisateur ou autre), Dolibarr propose un mécanisme de triggers métiers. Ce mécanisme vous permet de personnaliser un workflow afin que les évènements de gestion Dolibarr soient répercutés dans une autre application par exemple.
Rien n'empêche également de l'utiliser pour modifier le comportement de Dolibarr même: par exemple, pour que la validation d'une facture provoque la création d'un contrat automatiquement.

Donc, pour ajouter son propre code qui sera déclenché par trigger, la procédure est la suivante:

1) Copier le fichier '''htdocs/core/triggers/interface_90_all_Demo.class.php-NORUN''' sous le nom:
* '''interface_99_all_''Xxx''.class.php'''
ou bien
* '''interface_99_mod''MonModule_Xxx''.class.php'''
où ''Xxx'' est une chaine de votre choix commençant par une majuscule, ''99'' est le numéro de priorité du trigger (''01'' étant le plus prioritaire), ''MonModule'' est le nom du module si votre trigger ne doit être activé que si le module MonModule est actif. Si on désire que le trigger soit toujours actif, on mettra ''all'' à la place de modMonModule.
Il faut laisser ce nouveau fichier dans le même répertoire.
Rem: Les valeurs utilisable pour modMonModule sont visibles dans le répertoire
''htdocs/core/modules''.
'''ATTENTION''': '''Tous''' ces paramètres sont nécessaires pour que le trigger soit détecté! Ex: si vous oubliez le numéro de priorité, le module ne sera pas detecté!

Par exemple, on pourra nommer notre nouveau trigger:
''htdocs/core/triggers/interface_99_modFacture_Monworkflow.class.php''

En créant un fichier nommé comme dans cet exemple, notre nouveau trigger sera déclenché à chaque évènement métier Dolibarr et à condition que le module Facture soit actif.

'''Note''': Avec Dolibarr 3.2+, il est aussi possible de placer les fichiers triggers dans un sous-dossier de module. Ex: si le module réside dans htdocs/mymodule/, alors il est possible de placer les triggers dans htdocs/mymodule/core/triggers/.
Mais dans ce cas, le trigger ne sera trouvé que si vous le déclarer dans le fichier descripteur de votre module. Pour cela, ajouter ajouter triggers->1 dans le tableau module_parts (ex: '''/monmodule/core/modules/modMonModule.class.php'''):
<source lang="php">
// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
$this->module_parts = array('triggers' => 1);
//$this->module_parts = array('triggers' => 1,
// 'login' => 0,
// 'substitutions' => 0,
// 'menus' => 0);
</source>
Puis désactiver et réactiver le module. Ceci aura pour effet d'ajouter une ligne dans la [[Table llx_const]] pour indiquer à Dolibarr qu'il faut recherch un trigger dans le répertoire de votre module '''htdocs/monmodule/core/triggers'''.

2) Editer ce fichier ''interface_99_modMonModule_Monworkflow.class.php'' afin de renommer la classe ''InterfaceDemo'' par ''InterfaceMonworkflow''

Ensuite, accéder à la page Accueil-> Infos Systèmes -> Dolibarr -> Triggers.
Votre fichier trigger doit apparaitre dans la liste sans erreur indiquant que les opérations précédentes ont été réalisées avec succès.

3) Revenez maintenant à l'édition du fichier trigger afin d'ajouter votre code dans la fonction ''run_trigger''.
Cette fonction est appelée à chaque évènement Dolibarr. Placer votre code en fonction du ou des évènements sur lesquels vous voulez réagir, chaque évènement étant identifié par un code (voir chapitres suivant pour la liste des codes), on peut réagir ou non à un évènement donné par un test sur la variable '''$action''':

<source lang="php">
public function runtrigger($action,$object,$user,$langs,$conf)
{
// Mettre ici le code à exécuter en réaction de l'action
// Le type de l'évènement Dolibarr est stocké dans $action
// Les données de l'action sont stockées dans $object
// La configuration, utilisateur et langage sont dans $conf,$user et $lang
if ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</source>

Vous pouvez faire ce que vous voulez dans cette portion de code du moment que la fonction runtrigger renvoie un code retour sur le principe suivant:

<0 si ko, 0 si aucune action faite, >0 si ok

Vous pouvez de plus dans cette fonction utiliser les objets suivant:
* '''$object''' est l'objet sur lequel porte l'action (voir chapitre suivant)
* '''$user''' est l'objet de l'utilisateur Dolibarr qui réalise l'action
* '''$langs''' est l'objet qui contient la langue de l'utilisateur Dolibarr
* '''$conf''' est l'objet qui contient toute la configuration de Dolibarr.

4) Une fois le code réalisé, il n'y a plus qu'à tester, en provoquant l'évènement déclencheur dans Dolibarr. Attention, l'appel au '''runtrigger''' et encapsuler dans un transaction. Si votre trigger renvoie un code ko, la fonction appelante peut annuler la transaction (ceci dépend de la fonction appelante).
Ajouter des traces dans un fichier dans la fonction '''run_trigger''' afin de vous assurer que le code s'exécute bien. Vous pouvez pour cela si vous le désirer, utiliser la fonction
dol_syslog("mon texte de trace", LOG_DEBUG);

= Liste des événements gérés =
La liste de tous les événements qui provoquent un déclenchement de trigger est disponible dans la table [[Table llx c action trigger]]. Voici un vue rapide des événements identifiés par la valeur suivante au code '''$action''', avec le type de l'objet reçu dans '''$object'''.

En général, le code action de trigger est composé du:
* Nom du module (en majuscule)
* D'autres informations isolés par le caractère _
* L'action.

{{TemplateListOfTriggers}}

Liste non exhaustive.

= Gérer de nouveau évènements =

Pour gérer d'autre évènements que ceux ci-dessus, il faut modifier le code Dolibarr pour y ajouter la séquence suivante dans les méthodes métiers des classes utilisées pour gérer les évenements:

<source lang="php">
// Appel des triggers
include_once(DOL_DOCUMENT_ROOT . "/core/class/interfaces.class.php");
$interface=new Interfaces($this->db);
$result=$interface->run_triggers('XXXXX_YYYYY',$this,$user,$langs,$conf);
if ($result < 0) { $error++; $this->errors=$interface->errors; }
// Fin appel triggers
</source>

Ici, $this doit être l'objet de la classe métier qui contient toutes les informations à passer au trigger. Remplacer, de plus, le 'XXXXX_YYYYY' par un code évènement non déjà utilisé.
'''D'autre part, si l’exécution du trigger revient en erreur, vous devez annuler l'action correspondante.'''

'''A partir de la version 3.7, vous devez utiliser ce type de code :'''
<source lang="php">
// Call trigger
$result=$this->call_trigger('XXXXX_YYYYY',$user);
if ($result < 0) $error++;
// End call triggers
</source>

Il sera alors possible d'ajouter dans la méthode run_trigger, un if qui permet de gérer ce code. La méthode run_trigger serait alors de la forme :

<source lang="php">
function run_trigger($action,$object,$user,$lang,$conf)
{
// Mettre ici le code à exécuter en réaction de l'action
// Le type de l'évènement Dolibarr est stocké dans $action
// Les données de l'action sont stockées dans $object
// La configuration, utilisateur et langage sont dans $conf,$user et $lang
if ($action == 'XXXXX_YYYYY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</source>

= Conclusion =
Vous pouvez donc en quelques minutes, ajouter une interface Dolibarr vers exterieur sans risque puisqu'on ne touche pas au code Dolibarr, on s'est contenté de placer un nouveau fichier trigger dans le répertoire des triggers.
Si cette interface peut être utile à d'autre, n'hésitez pas à la packager en tgz (voir la page [[Développement_module#Créer_un_package_pour_livrer_et_installer_votre_module]]) et de la soumettre dans l'espace des téléchargement-contributions sur le site de Dolibarr.

= Voir aussi =
* [[Système de Hooks]]
* [[Interfaces Dolibarr vers exterieur]]
* [[Interfaces Exterieur vers Dolibarr]]