Mise à jour de 'README.md'

README.md

@@ -36,25 +36,189 @@ Puis effectuer les changement suivants
 
 # Description du squelette
 
- ## Asset
+## Bundle
+- DebugBundle
+- DoctrineBundle
+- DoctrineMigrationsBundle
+- FOSCKEditorBundle
+- FOSRestBundle
+- FrameworkBundle
+- KnpSnappyBundle
+- MakerBundle
+- MonologBundle
+- NelmioApiDocBundle
+- OneupUploaderBundle
+- SecurityBundle
+- SensioFrameworkExtraBundle
+- SwiftmailerBundle
+- TetranzSelect2EntityBundle
+- TwigBundle
+- TwigExtraBundle
+- WebProfilerBundle
+- WebpackEncoreBundle
+  
+  
+  
+## Asset
  
- ### Tag App
- - jQuery = https://www.npmjs.com/package/jquery
- - bootstrap = https://www.npmjs.com/package/bootstrap
- - datatables.net-bs4 = https://www.npmjs.com/package/datatables.net-bs4
- - fontawsome-free = https://www.npmjs.com/package/@fortawesome/fontawesome-free
- - moment = https://www.npmjs.com/package/moment
- - select2 = https://www.npmjs.com/package/select2
- - crop-select-js = https://www.npmjs.com/package/crop-select-js
- - tempusdominus-bootstrap-4 = https://www.npmjs.com/package/tempusdominus-bootstrap-4
- - spectrum-colorpicker2 = https://www.npmjs.com/package/spectrum-colorpicker2
- - jspdf = https://www.npmjs.com/package/jspdf
- - html2canvas = https://www.npmjs.com/package/html2canvas
+### Tag app
+- jQuery = https://www.npmjs.com/package/jquery
+- bootstrap = https://www.npmjs.com/package/bootstrap
+- datatables.net-bs4 = https://www.npmjs.com/package/datatables.net-bs4
+- fontawsome-free = https://www.npmjs.com/package/@fortawesome/fontawesome-free
+- moment = https://www.npmjs.com/package/moment
+- select2 = https://www.npmjs.com/package/select2
+- crop-select-js = https://www.npmjs.com/package/crop-select-js
+- tempusdominus-bootstrap-4 = https://www.npmjs.com/package/tempusdominus-bootstrap-4
+- spectrum-colorpicker2 = https://www.npmjs.com/package/spectrum-colorpicker2
+- jspdf = https://www.npmjs.com/package/jspdf
+
+### Tag morris
+- raphael = https://www.npmjs.com/package/raphael
+- morris.js = https://www.npmjs.com/package/morris.js
+
+### Tag fullcalendar
+- @fullcalendar/core = https://www.npmjs.com/package/@fullcalendar/core
+- @fullcalendar/interaction = https://www.npmjs.com/package/@fullcalendar/interaction
+- @fullcalendar/daygrid = https://www.npmjs.com/package/@fullcalendar/daygrid
+
+### Tag dropzone
+- dropzone = https://www.npmjs.com/package/dropzone
 
 
 
+## Parameters
+
+Provient du template env.local
+- appEnv = PROD
+- appSecret = valeur du fichier .key autogénéré au premier reconfigure
+- appWeburl = Valeur du dicos web_url
+- appAuth = Valeur du dicos CAS
+- appAlias = En dur l'alias web
+- appName = Nom de l'application
+- appCron = En dur à true pour activer le système de cron
+- appMasteridentity = Valeur du dicos soit Ninegate soit LDAP
+- appMasterurl = Si appMasteridentity la valeur du dicos correspondant à l'url du Ninegate maître
+- appMasterkey = Si appMasteridentity la valeur du dicos correspondant à la clé d'API du Ninegate maître
+- databaseName = En dur le nom de la base
+- databaseUser = En dur le user de la base
+- databasePassword = Autogénéré par le reconfigure
+- databaseHost = Valeur du dicos pour le host de la base
+- appMailmethod = Valeur du dicos soit sendmail soit smtp. sendmail par défaut si exim est activé sur le serveur
+- appMailurl = Si smtp url calculé combinant smtphost smtpport smtpencryption smtpauthmode smtpuser smtppwd
+- appMailnoreply = Valeur du dicos du noreplay
+- ldapModel = si masteridentity à LDAP soit open soit scribe
+- ldapHost = Valeur dicos Host LDAP
+- ldapPort = Valeur dicos Port LDAP
+- ldapUser = Valeur dicos User LDAP
+- ldapPassword = Valeur dicos Password LDAP
+- ldapBasedn = Valeur dicos Basedn LDAP
+- ldapUsername = si Scribe en dur sinon valeur du dicos champs annuaire utilisé comme username
+- ldapFirstname = si Scribe en dur sinon valeur du dicos champs annuaire utilisé comme firstname
+- ldapLastname = si Scribe en dur sinon valeur du dicos champs annuaire utilisé comme lastname
+- ldapEmail = si Scribe en dur sinon valeur du dicos champs annuaire utilisé comme email
+- ldapFiltergroup = si Scribe en dur sinon valeur du dicos filtre ldap de recherche des groupes
+- ldapFilteruser = si Scribe en dur sinon valeur du  dicos filtre ldap des groupes
+/
+- ldapAdmins = Liste des admins obligatoire = Admin + valeur dicos
+- casHost = Valeur dicos du host SSO
+- casPort = Valeur dicos du Porst SSO
+- casPath = Valeur dicos du Path SSO
+- casUsername = Valeur en dur correspondant au filtre sso du username
+- casEmail = Valeur en dur correspondant au filtre sso du email
+- casLastname = Valeur en dur correspondant au filtre sso du lastname
+- casFirstname = Valeur en dur correspondant au filtre sso du fistname
+- proxyUse = Valeur dicos utiliser oui/non un proxy
+- proxyHost = Si oui valeurs du dicos du host proxy
+- proxyPort = Si oui valeurs du dicos du post proxy
+- sondeUse = Valeur dicos utiliser oui/non une sonde statistique 
+- sondeUrl = Si oui url de la sonde statistique
+
+## Sécurité
+
+4 rôles possibles 
+- ROLE_ADMIN
+- ROLE_MODO
+- ROLE_MASTER
+- ROLE_USER
+
+4 routes protégés
+- /user = accèssible à ROLE_USER / ROLE_MASTER / ROLE_MODO / ROLE_ADMIN
+- /master = accèssible à ROLE_MASTER / ROLE_MODO / ROLE_ADMIN
+- /modo = = accèssible à ROLE_MODO / ROLE_ADMIN
+- /admin = = accèssible à ROLE_ADMIN
+
+## Job
+
+Nineskeletor intègre un système de job.  
+Ce système va exécuter des commandes symfony à interval régulier.  
+De base les jobs suivants sont livrés :
+- app:sendMail = toutes les minutes = Execution du spool de mail en attente
+- app:dumpBdd = toutes les nuits à 2h00 = Dump de la base
+- app:purgeFile = toutes les nuits à 3h00 = Suppresion des fichiers obsolètes
+- app:synchroUsers = toutes les nuites à 3h00 = Synchronisation des comptes utilisateurs soit via LDAP soit via Ninegate
+
+Pour ajouter un job à la listes, modifier la commande app:initCron qui sera exécutée à chaque reconfigure
+
+## Service
+
+- app.password.encoder = encodage password sur la methode que l'annuaire
+- app.upload.listener = action à réaliser sur upload via oneupload
+- app.upload.samename = permet d'uploader un fichier et préserver le nom de fichier via oneupload
+- app.ldap.service = fonction ldap
+- app.sendmail.transport = executuion du spool de mail via sendmail    
+- app.mail.service = fonction envoit de mail
+- app.twig.extension = extention twig
 
 
+## Twig
 
+### Twig Constantes
 
+Variables globales twig reprises des parametres symfony
+- appAlias
+- appAuth
+- appName
+- appCron
+- appMasteridentity
+- sondeUse
+- sondeUrl
 
+### Twig Extention
+
+App\Twig\AppExtension
+- filtre = urlAvatar à placer avec user.avatar afin de définir l'url complète de l'avatar du user
+
+### Twig Template de base
+
+#### templates/base.html.twig
+
+Deux paramétres non obligatoire
+- useheader = permet d'afficher ou non la bannière dans la page = false par défaut
+- usesidebar = permet d'afficher oun non la sidebar dans la page = false par défaut
+
+Block
+- block encorelinktags = pour déclarer des encore_link_tags spécifique à la page (encorelinktags app est intégré de base)
+- block localstyle = pour déclarer des propriétés css spécifique à page (Include/style.css.twig est intégré de base)
+- block body = le corps de la page
+- block encorescripttags pour déclarer des encore_script_tags spécifique à la page (encorescripttags app est intégré de base)
+- block localjavascript = pour déclarer du js spécifique à la page (Include/javascript.js.twig est intégré de base)
+
+#### templates/Include/style.css.twig
+
+Style de l'applicaiton en surcouche de bootstrap
+
+#### templates/Include/sidebar.html.twig
+
+La sidebar de l'application quand elle est affichée
+
+#### templates/Include/javascript.js.twig
+
+Librairie js de l'application
+
+- object a et button s'ils ont un attribut data-method et data_confirm proposeront une confirmation à l'utilisateur avant de poursuivre l'action
+- ModalLoad(idmodal,titre,url) = permet d'afficher en modal l'url indiqué en parametre. Par défaut on dispose de la modal #mymodal
+
+#### templates/Form/fields.htms.twig
+
+Mise en forme de champs de formulaire