|{{:undo-2.svg?30|}}| [[certif:procedure:develop:angular]]|
|{{:connexe.jpg?40|}} **Sujets connexes**|   |
====== Règles sur les classes ======
|**Suivi des modifications majeures** |04/2026 - Nicolas MARCHAND - Création\\ 05-2026 - Evolutions majeurs|
|**Suivi des approbations** |Cartographie fonctionnelle|
|**Objet** |Normaliser les classes servant à mapper dans Angular les objets du back (/ de la BDD)|
|**Destinataires** |**- Validation des modifications : ** Chef de projet\\  **- Approbation du document** : Tous développeurs|
======  ======

===== Nommage des classes de donnée (modele) =====

Classe correspondant à

^ Correspondance ^ Règle de nommage ^
| une table des BDDs | Dans ce cas le nom doit être celui de la classe pascal. Soit TSQL + nom de la table dans la base. Exemples : TSQLPersonne, TSQLFamille …  Pour facilité le fichier s'appelle record + nom de la classe (a l'image du back). Il est stocké dans ''ngx-logeasweb-ui\src\lib\models\BDD\Nom bdd\'' |
| à une classe interne au front | On préfixe le nom de la lettre T suivi d'un nom parlant. NB : on ne crée pas une classe copie d'une classe TSQL, si on a besoin d'ajouter des éléments on utilise l'héritage (extends) \\ Exemple : ''TPersonnePlus extends TSQLPersonne { nomDeJeuneFille : string ...}'' \\ ou on ajoute une propriété à la classe de base calculée \\ Exemple : ''getNomComplet(){return `${this.titre} ${this.prenom} ${this.nom}`}'' \\ Si la classe est à usage unique du composant on pourra utiliser une Interface |
| classes dérivées pour affichage | En fait il ne s'agit pas de classe mais d'interface (pas de fonction de traitement). Le nommage se fait sur le nom de la table plus Grid \\ Exemple : ''IPersonneGrid'' corresponds au type ''TSQLPersonne'' mis à plat pour usage dans la grille |

===== Les classes issues des BDDs (TSQL…) =====

==== Quelques règles génériques ====
  * On ne **charge/enregistre/efface** les données depuis le back directement depuis le code mais uniquement au travers des fonctions des classes **extends SynopseClientService** afin d'avoir des comportements homogènes
  * Une classe **NE DOIT APPELER** qu'une autre classe de typage, jamais DGService ou extends SynopseClientService. Si c'est le cas c'est le service qui doit le faire. \\ Exemple : pour effacer une famille il faut vérifier les personnes donc on devrait importer TSQPersonne dans recordFamille et réciproquement — on aurait donc ''TSQLFamille'' qui appelle une méthode de ''TSQLPersonne'' et réciproquement => à mettre dans TBaseLoGeAs.
  * Vu les problématiques à respecter la syntaxe ou privilégiera TSQLFamille[] à créer y=une classe TSQLFamilles

==== Les fonctions des classes "Serveurs" ====
=== Chargement de données (chargeFromBDD$) ===
<code>async chargeFromBDD$<T extends TSQLRecord>( classe: TSQLRecordConstructor<T>, filtre: Partial<T>|null = null): Promise<T[]></code>
^Entrée^Fonction^
|**classe: TSQLRecordConstructor<T>**|Indique la table qui doit être chargée au travers de la classe (exemple : TSQLPersonne, TSQLHistoriqueDon...)|
|**filtre: Partial<T>|null = null**|Paramètre optionnel\\ Si il est indiquer le filtrage demandé à la BDD pends en compte ce filtrage\\ Si il est omis la fonction **calculFiltre_chargeFromBDD** de la classe (indiqué si dessus) et appelée pour créer si pertinent un filtre sur secteur, exercice, utilisateur)|

^Sortie^Fonction^
|**Promise<T[]>**|Un tableau contenant des éléments de la classe indiqué.\\ Les éléments du tableau doivent être typé/traduit correctement au travers de la fonction de la classe **corrigeDataFromBDD** qui est appeler pour chaque élément via la procédure **mapArrayTo**.\\ NB: Celle-ci prends aussi en charge les problématiques de case\\ Si une erreur est détectée, l'utilisateur est informé et un tableau vide est rendu|

== Exemple d'appel : ==
<code>
*********** CLASSIQUE ***********
  detailDon!:TSQLHistoriqueDon[];
  listeCerfa!:TSQLHistoriqueDonSynthese[];
  [...]
  this.detailDon = await this.DG.BaseCourante.chargeFromBDD$(TSQLHistoriqueDon,filtre);
  this.listeCerfa = await this.DG.BaseCourante.chargeFromBDD$(TSQLHistoriqueDonSynthese,{personne:this.personne.ID});
  
*********** SIGNAL***********
  public personnes = signal<TSQLPersonne[]>([]);
  [...]
  const [titres, liens, data] = await Promise.all([
     await this.DG.BaseCourante.GetFichierTexte$('/PersonneTitre.Txt'),
     await this.DG.BaseCourante.GetFichierTexte$('/PersonneLienFamille.Txt'),
     await this.DG.BaseCourante.chargeFromBDD$(TSQLPersonne)
  ]);
  this.listeTitres = titres.lignes;
  this.listeLiensFamille = liens.lignes;
  this.personnes.set(data);
  </code>
  
=== Enregistrement de données (sauveToBDD$) ===
<code>  async sauveToBDD$<T extends TSQLRecord>(record:T, source: "FICHIER" | "COMPTA" | "SANSOBJET" = "SANSOBJET", forceCreate:boolean=false): Promise<T | null></code>
^Entrée^Fonction^
|**record:T**|Il s'agit de l'objet à sauvegarder. Il doit bien sur être d'un type connu|
|**source: "FICHIER" | "COMPTA" | "SANSOBJET" = "SANSOBJET"**|Paramètre optionnel\\ Utilisé pour la mise à jour des dates de fin de consentement (TSQLPersonne, TSQLFamille)|
|**forceCreate:boolean=false**|Par défaut si ID est différent de zero, la classe considére qu'il s'agit de la modification d'un enregistrement en base. Si ce n'est pas le cas, par exemple lors de la création d'enregistrement dont on veut maitriser l'ID (TSQLExercice par exemple), il convient de basculer à vrai ce paramétre)

^Sortie^Fonction^
|**Promise<T[]>**|Rend l'élement tel qu'enregistré dans la BDD.\\ L'élément doit être typé/traduit correctement au travers de la fonction de la classe **corrigeDataFromBDD** qui est appeler dessus.\\ NB: Celle-ci prends aussi en charge les problématiques de case\\ Si une erreur est détectée, l'utilisateur est informé et null est rendu|

== Exemple d'appel : ==
<code>
const res =await this.DG.BaseCourante.sauveToBDD$(personne,"FICHIER")
</code>

=== Fonction d'effacement (effaceFromBDD$) ===
<code>async effaceFromBDD$<T extends TSQLRecord>(record:T): Promise<boolean></code>
^Entrée^Fonction^
|**record:T**|Il s'agit de l'objet à effacer. Il doit bien sur être d'un type connu|

^Sortie^Fonction^
|**Promise<boolean>**|Indique si Ok|

== Exemple d'appel : ==
<code>
await this.DG.BaseCourante.effaceFromBDD$(famille);
</code>
===== Les fonctions « normées » à définira dans toutes les classes TSQL... =====
^ Fonction ^ Description ^
|<code>static override readonly sqlTableName: string = "personne";</code>|En haut de la classe, doit indiqué (en minuscule) le nom de la table correspondante dans la BDD|
|<code>
constructor(init?: Partial<TSQLPersonne>) {
  super(init);
  if (init) {Object.assign(this, init)}
}</code>|  |
|<code>
override corrigeDataFromBDD(){
  super.corrigeDataFromBDD();
  [...]\\ code spécifique à la classe
}</code>| Cette fonction doit s'assurer que la donnée qu'elle manipule est bien conforme à la classe. Par exemple une date reçu en texte doit être transformer en Date ...\\  **Elle ne doit manipuler que les objets de sa classe, celle des classes mère doivent être faite par la fonction éponyme de la classe mère**|
|<code>
override async prepareDataToBDD( 
        source: "FICHIER" | "COMPTA" | "SANSOBJET" = "SANSOBJET",
        DureeConsentement: number, 
        ReValidationDateConservation_Compta:boolean,  
        ReValidationDateConservation_Modif:boolean){
  super.prepareDataToBDD(source,DureeConsentement,
    ReValidationDateConservation_Compta,
    ReValidationDateConservation_Modif);
  [...]\\ code spécifique à la classe
}</code>| Cette fonction doit s'assurer que la donnée qu'elle manipule est conforme à ce que le back s'attends à recevoir. Par exemple un sous objet doit être transformer en string...\\  Elle peut aussi gérer des champs "calculé" par exemple la date de fin de consentent. **On préfèrera toujours le faire ici afin d'éviter divergence et redondance)** **Elle ne doit manipuler que les objets de sa classe, celle des classes mère doivent être faite par la fonction éponyme de la classe mère**|
|<code>override toGrid():IFamilleGrid</code>|Met à plat la structure parente (champ personnalisé, sous structure...) afin de faciliter leur affichage dans les grilles\\ Peut permettre au passage à ajouter des champs calculé\\ **Attention :** la structure résultante est une Interface elle ne peut/doit pas servir pour interfacer avec le back ou autre|
|<code>static toGrids(liste:TSQLFamille[]):IFamilleGrid[]</code>|Boucle sur les éléments du tableau pour appelé togrid|





==== Les fonctions spécifique à la classe ====
Dépends de chaque classe voir la classe