Développeurs
Cher·e·s développeur·se·s
Vous trouverez sur cette page, toutes les informations utiles pour comprendre le fonctionnement du logiciel. Ces informations vous permettront notamment de maintenir le logiciel à jour et de proposer des améliorations.
Chacune des fonctionnalités du logiciel seront détaillées ci-dessous. De manière globale, nous énumérerons ce que chacune des procédures réalise.
caporalCli.js
-
Contient l'ensemble des fonctionnalités que l'on peut lancer (composés d'arguments obligatoires lors de la saisie et d'options). Pour récupérer les arguments : args.<nom de="" l'argument="">.
CONTACT.js
Contient un prototype d'objet CONTACT. Il est composé des méthodes suivantes pour construire un objet:
.addTel, .setMail, .setNote, .setDomain, .getTel, .getMail, .getNote qui peuvent notamment être utilisé lors de la consutrction d'un objet contact lorsque un fichier vCard est parsé.
Ce prototype contient une méthode .toDBstring dont le rôle est de convertir au format "Database" (c'est-à-dire dans l'ancien format qui était utilisé auparavant, des samples sont présents dans le dossier extractable).
database.txt
Fichier d'origine qui est censé servir de support pour recenser tous les contacts déjà enregistrés. Ce fichier dispose d'une grammaire spécifique.
DatabaseParser.js
Toutes les méthodes sont formulées en tant que prototype.
Nous détaillerons ci-dessous ce que réalise chacune des méthodes:
tokenize : les lignes sont transformées en liste
parse : parse la première ligne du fichier Database (le "###")
database : s'attend à recevoir "###" en donnée et transforme les éléments de la ligne en contact et domaine
contact : crée un objet contact (avec prénom, nom, entreprise, fonction mail, tél1, tél2, remarque)
getExpectedContent : prend le premier élément d'un objet et le retire de l'objet
Chacune des méthodes suivantes s'attend à parser une ligne de contact : name, firstname, entreprise, fonction, email, telephone1, telephone2, remarque.
next : supprime le premier élément du paramètre
accept : si le paramètre parsé ne contient aucun des symbole attendu, il reporte une erreur
check : si accept a été vérifié, il retourne vrai
errMsg : est chargé d'émettre un message d'erreur
isInDatabase : si le mail du contact vcf correspond à celui qui est dans le fichier database, renvoie true sinon false
googlechart.js
Est chargé de rédiger la vue googlechart en générant un fichier googleChart.html
VcfParser.js
La fonction VcfParser contient les symboles à reconnaître pour parser un fichier.
Crée un prototype VcfParser qui disposent des méthodes suivantes :
tokenize : les lignes sont transformées en liste
parse : parse la première ligne du fichier Database (le "BEGIN:VCARD")
vcard : parse l'entiéreté des fichiers en faisant appel à chacune des fonctions qui pemet de reconnaître chacun des champs du fichier
Chacune des méthodes suivantes s'attend à parser une ligne de contact : contact, nameM, nameFN, entrepriseORG, entrepriseTITLE, telephone, mail, note.