Dolibarr ERP CRM Wiki - User contributions [en]

Interfaces Dolibarr vers exterieur

2005-07-27T04:13:56Z

81.248.100.2: /* Ajouter son code sur un évênement */

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

Pour permettre de déclencher du code personalisé en réaction à un évenement Dolibarr (création/modification/suppression d'une société/facture/produit), Dolibarr propose un mécanisme de triggers. Ce mécanisme vous permet de personnaliser un workflow afin que les évènements de gestion Dolibarr soit repercutés dans une autre application. 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 à déclencher par trigger, la procédure est la suivante:
# Copier le fichier ''includes/triggers/interface_demo.class.php'' sous le nom ''interface_xxx.class.php'' (ou xxx est une chaine de votre choix), en laissant ce nouveau fchier dans le meme répertoire. Par exemple ''includes/triggers/interface_monworkflow.class.php''
# Editer ce fichier ''interface_monworkflow.class.php'' afin de renommer la classe ''InterfaceDemo'' par ''InterfaceMonWorkflow'' et ajouter votre code dans la fonction ''run_trigger''. Cette fonction est appelée à chaque évennement Dolibarr. Placer votre code en fonction du ou des évenements sur lesquels vous voulez réagir, chaque évenement étant identifié par un test sur la variable $action:

function run_trigger($action,$object,$user,$lang,$conf)
{
// Mettre ici le code à exécuter en réaction de l'action
// Le type de l'évenement 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')
{
dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}

Il n'y a plus qu'à tester, en provoquant l'évènement déclencheur dans Dolibarr.

== Gérer de nouveaux évènements ==

Les évenements Dolibarr qui provoquent un appel de triggers sont, pour l'instant, identifiés par les codes évenements suivants:
* COMPANY_CREATE
* COMPANY_MODIFY
* COMPANY_DELETE
* BILL_VALIDATE

Pour gérer d'autre évenements 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:

// Appel des triggers
include_once(DOL_DOCUMENT_ROOT . "/interfaces.class.php");
$interface=new Interfaces($this->db);
$interface->run_triggers('XXXXX_YYYYYY',$this,$user,$lang,$conf);
// Fin appel triggers

Ici, $this doit etre l'objet de la classe metier qui contient toutes les informations à passer au trigger. Remplacer, de plus, le 'XXXXX_YYYYYY' par un code évenement non déjà utilisé.
Il sera alors possible d'ajouter dans la methode run_trigger, un if qui permet de gérer ce code. La methode run_trigger serait alors de la forme :

function run_trigger($action,$object,$user,$lang,$conf)
{
// Mettre ici le code à exécuter en réaction de l'action
// Le type de l'évenement 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
<b>
if ($action == 'XXXXX_YYYYY')
{
dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
}
</b>
elseif ($action == 'COMPANY_CREATE')
{
dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}

Librairies externes et dépendances

2005-07-27T04:07:23Z

81.248.100.2:

== Librairies embarquées dans le code source ==
* Classe d'export au format tableur
http://www.bettina-attack.de/jonny/view.php/projects/php_writeexcel/
* Librairies de génération de pdf
http://www.fpdf.org/ version 1.52
* Librairies authentification Pear
* Librairies magpierss
* Librairies phplot

== Librairies externes ==
* Librairies PHP
php4-imagick - Les graphiques ne sont pas disponibles si ce module n'est pas présent

Complément :
Sous gentoo, il s'agit du package dev-php/PECL-imagick

Permissions

2005-07-27T04:04:37Z

81.248.100.2:

Chaque permission se voit affecter un id unique. Cet id identifie la permission dans les tables de permission [[Table user_rights]] et [[Table usergourp_rights]].

Avant de créer de nouvelles permissions les développeurs doivent compléter ce document c'est lui et lui seul qui fait office de réservation et d'inventaire des identifiants retenus

Identification des classes :

Tableau d'identification des classes

* 1 - [[Module Facture]]
* 2 - [[Module Propositions commerciales]]
* 3 - [[Module Produits]]
* 4 - [[Module Projets]]
* 5 - Gestion utilisateurs
* 6 - [[Module Fiches d'intervention]]
* 7 - [[Module Adhérents]]
* 8 - [[Module Commandes]]
* 9 - [[Module Comptabilité]]
* 10 - [[Module Expedition]]
* 11 - [[Module Banque]]
* 12 - [[Module Société]]
* 13 - [[Module Caisse]]
* 14 - [[Module Téléphonie]]
* 15 - [[Module Prélèvements bancaires]]
* 16 - [[Module Contrat]]
* 17 - [[Module Fournisseur]]
* 18 - [[Module Fournisseur]] commandes
* 19 - [[Module Téléphonie]] lignes
* 20 - [[Module Téléphonie]] lignes ADSL
* 21 - [[Module Téléphonie]] contrats de lignes téléphonique
* 22 - [[Module Mailing]]
* 23 - [[Module Fournisseur]] factures
* 24 - [[Module Catégorie]]

Extrait de la table des permissions :
<pre>
+-----+---------------------------------------------------+------------+------+-----------+
| id | libelle | module | type | bydefault |
+-----+---------------------------------------------------+------------+------+-----------+
| 10 | Tous les droits sur les factures | facture | a | 0 |
| 11 | Lire les factures | facture | r | 1 |
| 12 | Créer modifier les factures | facture | w | 0 |
| 14 | Valider les factures | facture | d | 0 |
| 15 | Envoyer les factures aux clients | facture | d | 0 |
| 16 | Emettre des paiements sur les factures | facture | d | 0 |
| 19 | Supprimer les factures | facture | d | 0 |
| 20 | Tous les droits sur les propositions commerciales | propale | a | 0 |
| 21 | Lire les propositions commerciales | propale | r | 1 |
| 22 | Créer modifier les propositions commerciales | propale | w | 0 |
| 24 | Valider les propositions commerciales | propale | d | 0 |
| 25 | Envoyer les propositions commerciales aux clients | propale | d | 0 |
| 26 | Clôturer les propositions commerciales | propale | d | 0 |
| 27 | Supprimer les propositions commerciales | propale | d | 0 |
| 30 | Tous les droits sur les produits | produit | a | 0 |
| 31 | Lire les produits | produit | r | 1 |
| 32 | Créer modifier les produits | produit | w | 0 |
| 34 | Supprimer les produits | produit | d | 0 |
| 40 | Tous les droits sur les projets | projet | a | 0 |
| 41 | Lire les projets | projet | r | 1 |
| 42 | Créer modifier les projets | projet | w | 0 |
| 44 | Supprimer les projets | projet | d | 0 |
| 60 | Tous les droits sur les fiches d'intervention | ficheinter | a | 0 |
| 61 | Lire les fiches d'intervention | ficheinter | r | 1 |
| 62 | Créer modifier les fiches d'intervention | ficheinter | w | 0 |
| 64 | Supprimer les fiches d'intervention | ficheinter | d | 0 |
| 90 | Tous les droits sur la compta | compta | a | 0 |
| 91 | Lire les charges | compta | r | 1 |
| 92 | Créer modifier les charges | compta | w | 0 |
| 93 | Supprimer une charge | compta | d | 0 |
| 95 | Lire CA, bilans, résultats | compta | r | 1 |
| 110 | Tous les droits les comptes | banque | a | 0 |
| 111 | Lire les comptes | banque | r | 1 |
| 112 | Créer modifier rapprocher transactions | banque | w | 0 |
| 113 | Configurer les comptes (créer, gérer catégories) | banque | w | 0 |
| 120 | Tous les droits sur les sociétés | societe | a | 0 |
| 121 | Lire les sociétés | societe | r | 1 |
| 122 | Créer modifier les societes | societe | w | 0 |
| 129 | Supprimer les sociétés | societe | w | 0 |
| 130 | Tous les droits les caisses liquides | caisse | a | 0 |
| 131 | Lire les caisses | caisse | r | 1 |
| 132 | Créer modifier transactions | caisse | w | 0 |
| 133 | Configurer les caisses (créer, supprimer) | caisse | w | 0 |
+-----+---------------------------------------------------+------------+------+-----------+
</pre>