- Class PascalCase
- Variables camelCase
- Classes functions camelCase
- Lib Functions snake_case
- Object attributes snake_case
- Actions snake_case
- Filenames snake_case
- Création d'un fichier fonction pour l'objet
- Les fonctions doivent être appelées saturne_name_of_function
- Ajouter la documentation de la fonction
Pour faire un commit sur les repositories d'Evarisk il faut respecter la convention suivante :
- #NuméroIssue [Object/Element] add/fix: commit message
- Exemple 1 : #100 [Signature] add: signature update action
- Exemple 2 : #101 [Lib] fix: wrong method call
Pour simplifier l'utilisation et la compréhension du CSS/JS, nous avons utilisé un minifier avec la librairie npm Gulpfile. Par conséquent, il ne faut pas oublier de lancer le terminal et d'exécuter la commande npm i (si c'est la première utilisation) ou npm start.
- Exemple : C:\wamp64\www\dolibarr\htdocs\custom\saturne> npm start
Pour implémenter un objet sur un module il faut se référer à la classe SaturneObject. Cette dernière dispose d'un CRUD générique étendu de CommonObject + les fonctions utilitaires
- getNomUrl
- fetchAll
- etc
Pour implémenter un objet document sur un module il faut se référer à la classe SaturneDocuments. Cette dernière dispose d'un CRUD générique étendu de CommonObject + les fonctions utilitaires suivantes :
- generateDocument
Pour implémenter un objet signature sur un module il faut se référer à la classe SaturneSignature. Cette dernière dispose d'un CRUD générique étendu de CommonObject + les fonctions utilitaires suivantes :
- setSignatory
- fetchSignatory
- fetchSignatories
- checkSignatoriesSignatures
- deleteSignatoriesSignatures
- deletePreviousSignatories
Pour implémenter un objet horaires sur un module il faut se référer à la classe SaturneSchedules. Cette dernière dispose d'un CRUD générique étendu de CommonObject
Pour implémenter un objet tableau de bord sur un module il faut se référer à la classe SaturneDashboard. Cette dernière dispose des fonctions utilitaires suivantes :
- load_dashboard - Charger les infos du tableau de bord
- show_dashboard - Afficher le tableau de bord