Difference between revisions of "Interfaces Exterieur vers Dolibarr"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Line 10: Line 10:
  
 
== Utilisation des classes PHP ==
 
== Utilisation des classes PHP ==
Il est possible d'utiliser les objets métiers de dolibarr (Les fichiers xxx.class.php).
+
Il est possible d'utiliser les objets métiers de Dolibarr (Les fichiers xxx.class.php).
Chacun de ces fichiers offre un classe munie de methodes pour:
+
Chacun de ces fichiers offre un classe munie de méthodes pour:
 
* la récupération d'une entité (la méthode fetch)
 
* la récupération d'une entité (la méthode fetch)
 
* l'insertion en base d'une entité (la méthode create ou insert)
 
* l'insertion en base d'une entité (la méthode create ou insert)
Line 19: Line 19:
 
Cette technique est préférable à la précédente.
 
Cette technique est préférable à la précédente.
  
'''Avantages:''' Elle offre l'avantage de passer à travers les couches de validations métiers des données. Le code d'interface ne doit normallement pas etre réécrit en cas de montée de version de Dolibarr.
+
'''Avantages:''' Elle offre l'avantage de passer à travers les couches de validations métiers des données. Le code d'interface ne doit normallement pas être réécrit en cas de montée de version de Dolibarr.
  
 
'''Inconvénients:''' Elle n'est exploitable qu'en langage PHP.
 
'''Inconvénients:''' Elle n'est exploitable qu'en langage PHP.
 +
 +
 +
Voici un exemple pour la création d'un tiers (société client par exemple):
 +
 +
<pre>
 +
include_once('/pathofdolibarrhtdocs/societe.class.php');
 +
$mycompany = new Societe($db);
 +
$mycompany->nom='Big Brother';
 +
$mycompany->client=1;
 +
$mycompany->create($user);
 +
</pre>
 +
 +
Rem: Si on est dans le cas d'un script externe à Dolibarr, il est nécessaire de faire au début
 +
<pre>include('master.inc.php');</pre>
 +
pour que les objets $db, $lang et $user soient créés.
 +
Si on veut que les actions (creation, mise a jour), soit associées dans le suivi à un utilisateur particulier, il est nécessaire de faire avant
 +
<pre>
 +
$user->fetch('loginuser');
 +
</pre>
 +
Ainsi, l'objet user est initialisé avec les infos de l'utilisateur 'loginuser'.

Revision as of 15:59, 19 July 2008

Il y a 2 méthodes pour permettre à une application extérieure d'insérer des données dans Dolibarr. Les 2 techniques possibles sont les suivantes:

Insertion des données directement en base

Cette solution requiert de connaître le modèle physique et les valeurs autorisées des champs. Elle est risquée et devra être réécrite en cas de modification du format de base de Dolibarr.

Avantages: Peut être réalisé dans n'importe quel langage.

Inconvénient: Cette technique est très fortement déconseillée. A la première montée de version de Dolibarr, cette méthode risque de ne plus fonctionner et devoir être réécrite. De plus, en utilisant cette méthode, vous passer outre les règles de validation métier, ce qui crée un risque de corrompre les données. Cette méthode nécessite aussi de connaitre la base Dolibarr.

Utilisation des classes PHP

Il est possible d'utiliser les objets métiers de Dolibarr (Les fichiers xxx.class.php). Chacun de ces fichiers offre un classe munie de méthodes pour:

  • la récupération d'une entité (la méthode fetch)
  • l'insertion en base d'une entité (la méthode create ou insert)
  • la mise à jour d'une entité (la méthode update)
  • la suppression d'une entité (la méthode delete) si applicable à l'objet
  • d'autres méthodes diverses propre à l'entité manipulée.

Cette technique est préférable à la précédente.

Avantages: Elle offre l'avantage de passer à travers les couches de validations métiers des données. Le code d'interface ne doit normallement pas être réécrit en cas de montée de version de Dolibarr.

Inconvénients: Elle n'est exploitable qu'en langage PHP.


Voici un exemple pour la création d'un tiers (société client par exemple):

include_once('/pathofdolibarrhtdocs/societe.class.php');
$mycompany = new Societe($db);
$mycompany->nom='Big Brother';
$mycompany->client=1;
$mycompany->create($user);

Rem: Si on est dans le cas d'un script externe à Dolibarr, il est nécessaire de faire au début

include('master.inc.php');

pour que les objets $db, $lang et $user soient créés. Si on veut que les actions (creation, mise a jour), soit associées dans le suivi à un utilisateur particulier, il est nécessaire de faire avant

$user->fetch('loginuser');

Ainsi, l'objet user est initialisé avec les infos de l'utilisateur 'loginuser'.