Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
back:mapping_dolibarr_-_react [2025/09/03 08:46] – caprelback:mapping_dolibarr_-_react [2025/09/16 20:45] (Version actuelle) – modification externe 127.0.0.1
Ligne 1: Ligne 1:
 #Mapping dolibarr <-> react #Mapping dolibarr <-> react
  
-Pour que le front "sache" quel type de données sont envoyées par le back les objets dolibarr sont "exposés" au front. Comme certains types de données côté dolibarr n'existent pas à l'identique côté front nous avons mis en place des mécanismes de "correspondance" ou "mapping" dont vous trouverez les détails ci après.+Pour que le front sache quel type de données sont envoyées par le back les objets dolibarr sont exposés au front.
  
-Pour optimiser les échanges entre le back (php) et le front (react) nous avons fait le choix de permettre la modification des données côté back avant l'envoi vers le front.+Comme certains types de données côté dolibarr n'existent pas à l'identique côté front nous avons mis en place des mécanismes de correspondance ou **mapping** dont vous trouverez les détails ci après. 
 + 
 +Pour optimiser les échanges entre le back (php) et le front (react) nous avons fait le choix de permettre la modification des données côté back (fond et forme) avant l'envoi vers le front et lors du retour.
  
 ##Listez les champs de l'objet dolibarr que vous voulez publier vers le front ##Listez les champs de l'objet dolibarr que vous voulez publier vers le front
  
-Vous pouvez limiter côté back la liste des champs qui seront envoyés vers l'application react en lisant tout simplement les champs que vous voulez exporter dans la variable ` _listOfPublishedFields` comme par exemple+Vous pouvez limiter côté back la liste des champs qui seront envoyés vers l'application react en lisant les champs que vous voulez exporter dans la variable ` listOfPublishedFields` comme par exemple ci après.  
 + 
 +La clé est le nom du champ de l'objet dolibarr et la valeur est le nom que vous voulez donner côté réact : Dans l'exemple ci dessous le champ ''nom'' de la société côté dolibarr sera transformé en ''name'' pour le côté front (react). 
 + 
 +Les clés étrangères comme ''fk_departement'' sont transformée au vol pour passer la valeur au front qui n'a donc pas besoin de connaître l'implémentation et faire une sous requête pour obtenir la valeur du champ en question.
  
-la clé est le nom du champ de l'objet dolibarr et la valeur est le nom que vous voulez donner côté réact :+Ce choix est clairement fait pour que le front soit le plus générique possible.
  
 ``` ```
  //corresponding fields left dolibarr right front app  //corresponding fields left dolibarr right front app
- protected $_listOfPublishedFields = [+ protected $listOfPublishedFields = [
  'rowid' => 'rowid',  'rowid' => 'rowid',
  'nom' => 'name',  'nom' => 'name',
Ligne 30: Ligne 36:
 ``` ```
  
-Ensuite au moment où les données seront mises en formes pour être envoyées vers react un certain nombre de mécanismes seront mis en oeuvre:+Ensuite au moment où les données seront mises en formes pour être envoyées vers react un certain nombre de mécanismes sont mis en œuvre:
  
-## Filtrer le contenu : fonction magique _fieldFilterValueXXXX+## Filtrer le contenu : fonction magique fieldFilterValueXXXX
  
-Imaginez que vous voulez rendre le logo de l'objet Société accessible à l'application react : l'objet dolibarr contient le nom du fichier logo et l'application react s'attend à avoir un logo sous la forme d'un champ base64 encodé ...+Imaginez que vous voulez rendre le logo de l'objet Société accessible à l'application react : l'objet dolibarr contient le nom du fichier logo et l'application react s'attend à avoir un logo sous la forme d'un champ base64 encodé (choix qui a été fait pour des questions d'optimisation et d'uniformité / code générique).
  
-Vous pouvez tout simplement implémenter la fonction _fieldFilterValueXXXX en replaçant XXXX par le nom du champ dont vous voulez filtrer le contenu (avec la 1ere lettre en majuscule), dans notre exemple ça serait donc _fieldFilterValueLogo dans votre classe de mappage dmSociete donc+Vous pouvez implémenter la fonction ''fieldFilterValueXXXX'' en replaçant ''XXXX'' par le nom du champ dont vous voulez filtrer le contenu (avec la 1ere lettre en majuscule), dans notre exemple ça serait donc ''fieldFilterValueLogo'' dans la classe de mappage ''dmSociete''
  
  
 ``` ```
- public function _fieldFilterValueLogo($societe)+ public function fieldFilterValueLogo($societe)
  {  {
  global $conf;  global $conf;
- // dol_syslog("##### dmHelper : call for _fieldFilterValueLogo for " . $societe->logo);+ // dol_syslog("##### dmHelper : call for fieldFilterValueLogo for " . $societe->logo);
  $dir     = $conf->societe->multidir_output[$societe->entity] . "/" . $societe->id . "/logos";  $dir     = $conf->societe->multidir_output[$societe->entity] . "/" . $societe->id . "/logos";
  $logo = $dir . '/' . $societe->logo;  $logo = $dir . '/' . $societe->logo;
Ligne 64: Ligne 70:
 Certains objets dolibarr sont composés de lignes (Exemple : une facture, un devis, un bon de commande...) il faut donc Certains objets dolibarr sont composés de lignes (Exemple : une facture, un devis, un bon de commande...) il faut donc
  
-a) envoyer une description des lignes au front pour savoir ce qu'il faut afficher comme composants+a) envoyer une description des lignes au front pour savoir ce qu'il faut afficher comme composants pour afficher les données (par exemple 4 colonnes : id de type nombre, description de type texte, prix unitaire, quantité, total)
 b) envoyer le contenu des lignes b) envoyer le contenu des lignes
  
-Malheureusement tous les objets dolibarr ne sont pas conçus de manière strictement identiques (certains ont un prefixe `Line` et d'autres `Ligne`, comme par exemple `FichinterLigne` et `OrderLine`) nous avons donc implémenté la solution suivante:+Malheureusement tous les objets dolibarr ne sont pas conçus de manière strictement identiques (certains ont un préfixe ''Line'' et d'autres ''Ligne'', comme par exemple ''FichinterLigne'' et ''OrderLine'').: 
 + 
 +D'autre part les objets dolibarr ont tous une variable "fields" qui décrit l'objet mais il n'en est pas de même pour la description des lignes des objets ce qui rends impossible la gestion de code générique côté front.
  
-Dans votre objet de description du mapping (exemple `dmSmartinter`) vous pouvez utiliser+SmartMaker apporte une solution à ce double problème: dans la classe de description du mapping de votre objet (exemple ''dmSmartinter'') vous pouvez utiliser
  
-  * a) `parentClassNameForLines` pour indiquer le nom de la classe dolibarr qui implémente les lignes de l'objet +  * a) ''parentClassNameForLines'' pour indiquer le nom de la classe dolibarr qui implémente les lignes de l'objet 
-  * b) `_listOfPublishedFieldsForLines` pour indiquer la liste des champs que vous voulez exporter et sous quel nom (mapping dolibarr -> application) +  * b) ''listOfPublishedFieldsForLines'' pour indiquer la liste des champs que vous voulez exporter et sous quel nom (mapping dolibarr -> application) 
-  * c) `parentLabelForLines` pour indiquer le titre (qui sera traduit) que vous voulez afficher au dessus de la liste des lignes sur l'application (par exemple "Détail des lignes de la facture")+  * c) ''parentLabelForLines'' pour indiquer le titre (qui sera traduit) que vous voulez afficher au dessus de la liste des lignes sur l'application (par exemple "Détail des lignes de la facture")