Difference between revisions of "Développement de scripts"

Latest revision as of 13:21, 23 July 2019

Localisation

Les scripts en ligne de commande de Dolibarr doivent être situés dans le répertoire scripts de Dolibarr. Les scripts sont ensuite répartis dans des sous-répertoires en fonction de leur vocation. Un certain nombre de scripts est donc fourni en standard.

Développer un nouveau script

Les scripts étant souvent réalisés pour un besoin spécifique, il y a de fortes chances que vous ne trouviez pas celui qui vous intéresse. Dans ce cas, nous allons vous expliquer comment développer votre propre script.

Etape 1 - Création du squelette du script

La première étape est de reprendre le squelette de script disponible en dev/skeletons/skeleton_scripts.php et de le recopier en renommant, ce script dans le répertoire scripts/monrep/monscript.php

Une fois le script renommé, donnez lui les droits en exécution. Sous Linux, cela peut se faire par la commande:

cd scripts/monrep;
chmod a+rx monscript.php

Ensuite, lancez le pour voir si vous pouvez exécuter un script en mode ligne de commande. Pour cela, taper:

php-cli ./monscript.php

ou

php ./monscript.php

Vous devriez obtenir le résultat suivant:

Usage: monscript.php param1 param2 ...

Etape 2 - Edition du code du script

Modifier le contenu du script pour réaliser les opérations qui vous intéressent. Tout le code qui se trouve entre les balises

// ---------- START OF YOUR CODE HERE

et

// ---------- END OY YOUR CODE

est fourni à titre d'exemple. Vous pouvez le supprimer et y mettre le code qui vous intéresse. Notez que dans cette portion, vous pouvez utiliser la variable $db qui est la ressource d'accès à la base Dolibarr et qui est déjà initialisée. L'objet $conf qui contient la configuration Dolibarr est également disponible.

Exemples

Des exemples de code (créer des commande, créer des produits...) sont disponibles dans le répertoire /dev/examples/.

@@ Line 1: / Line 1: @@
-== Localisation ==
+<!-- BEGIN interlang links -->
-Les scripts en ligne de commande de Dolibarr doivent etre situés dans le répertoire '''scripts''' de Dolibarr. Les scripts sont ensuite répartis dans des sous-répertoire en fonction de leur vocation.
+<!-- Do NOT edit this section
+     Links below are automatically managed by PolyglotBot
+     You can edit links on the English source page : Script_development -->
+[[en:Script_development]]
+[[zh:脚本开发]]
+[[es:Desarrollo_de_scripts]]
+<!-- END interlang links -->
+[[Category:Noyau]]
+{{TemplateDocDev}}
+= Localisation =
+Les scripts en ligne de commande de Dolibarr doivent être situés dans le répertoire '''scripts''' de Dolibarr. Les scripts sont ensuite répartis dans des sous-répertoires en fonction de leur vocation.
 Un certain nombre de scripts est donc fourni en standard.
-== Développer un nouveau script ==
+= Développer un nouveau script =
-Les scripts étant souvent réalisés pour un besoin spécifiques, il y a de forte chance que vous ne trouviez pas celui qui vous intéresse. Dans ce cas, nous allons vous expliquer comment développer votre propre script.
+Les scripts étant souvent réalisés pour un besoin spécifique, il y a de fortes chances que vous ne trouviez pas celui qui vous intéresse. Dans ce cas, nous allons vous expliquer comment développer votre propre script.
-=== Etape 1 - Création du squelette du script ===
+== Etape 1 - Création du squelette du script ==
-La première étape est de reprendre le squelette de script disponible en '''dev/skeletons/skeleton_scripts.php''' et de recopier en le renommant, ce script dans le répertoire '''scripts/monrep/monscript.php'''
+La première étape est de reprendre le squelette de script disponible en '''dev/skeletons/skeleton_scripts.php''' et de le recopier en renommant, ce script dans le répertoire '''scripts/monrep/monscript.php'''
-Une fois le script renommé, donnez lui les droits en exécution par la commande:
+Une fois le script renommé, donnez lui les droits en exécution.
-<pre>
+Sous Linux, cela peut se faire par la commande:
+<source lang="bash">
 cd scripts/monrep;
 chmod a+rx monscript.php
-</pre>
+</source>
 Ensuite, lancez le pour voir si vous pouvez exécuter un script en mode ligne de commande. Pour cela, taper:
-<pre>php-cli ./monscript.php
+<source lang="bash">
+php-cli ./monscript.php
+</source>
 ou
-php ./monscript.php</pre>
+<source lang="bash">
-Vous devriez obtenir le resultat suivant:
+php ./monscript.php
-<pre>
+</source>
+Vous devriez obtenir le résultat suivant:
+<source lang="bash">
 Usage: monscript.php param1 param2 ...
-</pre>
+</source>
-=== Etape 2 - Edition du code du script ===
+== Etape 2 - Edition du code du script ==
 Modifier le contenu du script pour réaliser les opérations qui vous intéressent.
 Tout le code qui se trouve entre les balises
-<pre>// ---------- START OF YOUR CODE HERE</pre>
+<source lang="php">// ---------- START OF YOUR CODE HERE</source>
 et
-<pre>// ---------- END OY YOUR CODE</pre>
+<source lang="php">// ---------- END OY YOUR CODE</source>
 est fourni à titre d'exemple.
 Vous pouvez le supprimer et y mettre le code qui vous intéresse.
@@ Line 34: / Line 51: @@
 L'objet $conf qui contient la configuration Dolibarr est également disponible.
-==== Exemple insertion d'un produit ====
+= Exemples =
-Par exemple pour insérer un produit dans la base dolibarr, vous pouvez y placer le code suivant:
+Des exemples de code (créer des commande, créer des produits...) sont disponibles dans le répertoire '''/dev/examples/'''.
-<pre>
-// Inclusion classe métier product
-require_once(DOL_DOCUMENT_ROOT."/product.class.php");
-// Création d'une instance de product
-$myproduct=new Product($db);
-// Définition des propriétés de l'instance product
-$product->ref                = '1234'
-$product->libelle            = 'libelle';
-$product->price              = '10';
-$product->price_base_type    = 'HT';
-$product->tva_tx             = '19.6';
-$product->type               = 0;
-$product->status             = 1;
-$product->description        = 'Description';
-$product->note               = 'Note';
-// Création du produit en base
-$idproduct = $product->create('');
-// Gestion erreur
-if ($idproduct < 0) dolibarr_print_error($db,$product->error);
-else print "Produit $idproduct cree.\n";
-</pre>