Interfaces from foreign systems toward Dolibarr: Difference between revisions

Jump to navigation Jump to search

Interfaces from foreign systems toward Dolibarr (view source)

Revision as of 15:22, 3 September 2010

2,323 bytes removed ,  16 years ago
→‎Using PHP classes
VisualWikitext
Line 13: Line 13:


= Using PHP classes =
= Using PHP classes =
It is possible to use business objects Dolibarr (xxx.class.php files). Each of these files has provided a class of methods for:
See page [[Business Objects]].
* recovery of an entity (the fetch method)
* insertion into database of an entity (the create method or insert)
* updating an entity (the update method)
* deletion of an entity (the delete method) if applicable to the object
* various other methods specific to the entity manipulated.
 
This technique is better than first one.
 
'''Advantages:''' It offers the advantage of passing through layers of data validation business. The interface code should normally not be rewritten when upgrading version Dolibarr.
 
'''Disadvantages:''' It is usable in PHP only. Your code must be stored on same server than Dolibarr files.
 
== Example for a third party ==
Here is an example for the creation of a third party (eg customer company):
 
If we make a new script or an external script, we must add at the beginning, before making anything else:
<source lang="php">
include('/pathofdolibarrhtdocs/master.inc.php');
</source>
This will initialize Dolibarr environment objects ($conf, $db, $lang and $user).
If we want that actions (create, update) are tagged with a particular user as the create/update user, we must do after the include of master.inc.php and before calling any create or update method
<source lang="php">
$user->fetch(0,'loginuser');
</source>
 
Now we can make our business code.
 
<source lang="php">
// We declare the class we want to use
include_once('/pathofdolibarrhtdocs/societe.class.php');
 
// We create an instance of object to manipulate
$mycompany = new Societe($db);
 
// We set properties on object
$mycompany->nom='Big Brother';
$mycompany->client=1;
 
// If we want that creation is tagged as done by a particular user 'loginuser',
// you must uncomment this line to load all characteristics of this user.
// If we keep the comment, Dolibarr will use null if fields that should store the create or update user.
// $user->fetch('loginuser');
 
// On call method to create
$id=$mycompany->create($user);
 
// This is to read/load an already created object
$mycompany->fetch($id);
 
// To update object
$mycompany->update($user);
</source>
 
== Other examples ==
You may find other example for manipulating Dolibarr objects (Create, Read, Update, Delete) into directory '''dev/samples''' of Dolibarr cvs snapshot.


= Web services =
= Web services =
See [[Module Web Services]].
See [[Module Web Services]].
Retrieved from "https://wiki.dolibarr.org/index.php/Special:MobileDiff/20117"

Navigation menu