Référence technique
Personnalisation de l'application

Personnalisation de l'application

Sont décrites ici les étapes pour personnaliser l’application.

Cette personnalisation vous permettra de modifier tous les “templates” de l’application (y compris les emails et les pdfs).

Créer un nouveau template

A la racine de l’application, dans le répertoire templates, créer un nouveau dossier, par exemple montemplate

Copier à l’intérieur l’intégralité du dossier templates/default (ou uniquement le ou les fichiers templates que vous souhaitez modifier)

Vous êtes maintenant libre de modifier complétement les templates du dossier templates/montemplate

Important

Après chaque modification effectuée dans les nouveaux templates, il est nécessaire de vider les caches de l’application pour la voir apparaître sur le site en utilisant la commande :

./bin/console cache:clear

Associer le template créé à l’application

Il ne reste plus qu’a configurer l’application pour lui dire d’utiliser le nouveau template créé.

Pour cela il faut modifier le fichier .env à la racine de l’application.

Il suffit de remplacer la valeur de la variable APP_THEME, par exemple APP_THEME=montemplate

Si aucune valeur n’est renseigné pour APP_THEME, l’application utilise par défaut les templates du dossier templates/default

Arborescence du dossier template

  • account : templates des informations utiliateurs (pages “mon compte” et “réinitialisation du mot de passe”)
  • admin : templates des pages l’administration (instructeurs, utilisateurs, logs et paramètres)
  • emails : templates des emails
  • form et macro : templates servant à l’affichage des champs des formulaires
  • pdf : templates des pdf
  • search : templates des pages recherche et historique des recherches
  • security : templates liés au système de connexion (mot de passe, connexion, ….)
  • stats : templates des pages statistiques
  • utils : templates des entetes et pieds de pages

Ajout de classes CSS personnalisées pour modifier l’apparence graphique de l’application

Il est possible de modifier ou de surcharger les classes CSS utilisées par l’application.

Pour cela il suffit d’intégrer le code CSS souhaité dans le fichier à la racine de l’application public/styles.css

Variables utilisables dans les modèles (templates)

Points d’attention

Tous les modèles (templates twig) situés dans les répertoires “pdf” et “emails”, ainsi que les fichiers help.html.twig et terms_of_use.html.twig peuvent être modifiés sans risque particulier, dans la mesure où :

  • la syntaxe twig est respectée,
  • les variables utilisées existent bien.

Concernant les autres modèles (comme les listes de résultats - logs-results.html.twig par exemple), il faut être plus prudent car cela peut avoir un impact sur le javascript et compromettre le fonctionnement de l’application.

La disponibilité des champs en provenance de la base de données est assurée uniquement dans les templates où une personne a été trouvée, soit search_found.html.twig et search_found_rec.html.twig.

Liste des variables

addressBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : adresse | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

appName

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : subject

appTerritoryInstructor

Provenance : code PHP | Valeur possible : boolean | Entité : - | Colonne : - | Traitement : - | Type de template : pdf, mail

Template(s) : base, search_found

birthDate

Provenance : formulaire | Valeur possible : DateTime | Entité : Person/SearchLog | Colonne : date_naissance Traitement : Transformation en type string au format d/m/Y | Type de template : mail, pdf

Template(s) : search_found, search_found_rec, search_found_notrec, pdf/search_notfound, search_ambiguous, death_alert

birthDateBdd

Provenance : base de données | Valeur possible : date | Entité : Person | Colonne : date_naissance | Traitement : Transformation en type string au format d/m/Y | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

civilName

Provenance : formulaire | Valeur possible : string(255) | Entité : Person | Colonne : nom_civil | Traitement : - | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest, death_alert

civilNameBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : nom_civil | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

claims

Provenance : code PHP | Valeur possible : array | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : claims

dateSearch

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

deathDate

Provenance : formulaire | Valeur possible : DateTime | Entité : Person | Colonne : date_deces | Traitement : Transformation en type string au format d/m/Y | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest, death_alert

deathDateBdd

Provenance : base de données | Valeur possible : date | Entité : Person | Colonne : date_deces | Traitement : Transformation en type string au format d/m/Y | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

deathLocation

Provenance : formulaire | Valeur possible : string(255) | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest, death_alert

firstName

Provenance : formulaire | Valeur possible : string(255) | Entité : Person | Colonne : prenom | Traitement : - | Type de template : mail, pdf

Template(s) : death_alert, has_document, search_ambiguous, search_found, search_found_notrec, search_found_rec, search_hasrequest, search_notfound, subject

firstNameBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : prenom | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

gender

Provenance : base de données | Valeur possible : varchar(1) | Entité : Person | Colonne : sexe | Traitement : - | Type de template : mail, pdf

Template(s) : death_alert, search_found_notrec, search_found_rec

genderBdd

Provenance : base de données | Valeur possible : varchar(1) | Entité : Person | Colonne : sexe | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

hasPDF

Provenance : code PHP | Valeur possible : boolean | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : search_found

helpCodeBdd

Provenance : base de données | Valeur possible : varchar(50) | Entité : Person | Colonne : code_aide | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

helpCodeLabels

Provenance : code PHP | Valeur possible : array | Entité : - | Colonne : - | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

initUrl

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : add_user

labelBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : libelle | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

libelle_notaire

Provenance : formulaire | Valeur possible : string(255) | Entité : User | Colonne : nom | Traitement : - | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest

mail_notaire

Provenance : formulaire | Valeur possible : string(255) | Entité : User | Colonne : mail | Traitement : - | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest

mdt

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf, mail

Template(s) : base, search_found

mdtAdresse

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf, mail

Template(s) : base, search_found

mdtAddressBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : mdt_adresse | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

mdtBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : mdt | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

mdtCourriel

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf, mail

Template(s) : base, search_found

mdtMailBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : mdt_courriel |Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

mdtPhoneBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : mdt_telephone | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

mdtTelephone

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf, mail

Template(s) : base, search_found

middleName

Provenance : formulaire | Valeur possible : string(255) | Entité : Person | Colonne : prenomd | Traitement : - | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest

middleNameBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : prenomd | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

name

Provenance : formulaire | Valeur possible : string(255) | Entité : AbstractPerson | Colonne : civilName ou useName selon paramétrage | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest

nameBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : AbstractPerson | Colonne : civilName ou useName selon paramétrage | Traitement : Transformation en majuscule | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

nbLoginAttempts

Provenance : code PHP | Valeur possible : integer | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : unlock_user

officeAddress

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

officeAdditionalAddress

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

officeName

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

officePostalCode

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

officeTown

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

person.birth

Provenance : fichier de traduction | Valeur possible : .H : né, .F : née | Entité : - | Colonne : - | Traitement : Appel de la fonction trans | Type de template : mail, pdf

Template(s) : *

person.title

Provenance : fichier de traduction | Valeur possible : .H : Monsieur, .F : Madame | Entité : - | Colonne : - | Traitement : Appel de la fonction trans | Type de template : mail, pdf

Template(s) : *

personNumBdd

Provenance : base de données | Valeur possible : integer | Entité : Person | Colonne : num_ind | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

reference

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : pdf

Template(s) : base

resetUrl

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : reset_password

responseType

Provenance : formulaire | Valeur possible : DateTime | Entité : SearchLog | Colonne : type_reponse | Traitement : - | Type de template : pdf

Template(s) : search_found_notrec, search_found_rec, search_notfound, base

rows_person

Provenance : code PHP | Valeur possible : array | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : search_found

showIDT

Provenance : code PHP | Valeur possible : boolean | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : search_found

status

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : has_document, subject

thirdName

Provenance : formulaire | Valeur possible : string(255) | Entité : Person | Colonne : prenomt | Traitement : - | Type de template : mail

Template(s) : search_found, search_notfound, search_ambiguous, search_hasrequest, subject, has_document

thirdNameBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : prenomt | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

unlockKey

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : unlock_user

url

Provenance : code PHP | Valeur possible : string | Entité : - | Colonne : - | Traitement : - | Type de template : mail

Template(s) : has_document

useName

Provenance : formulaire | Valeur possible : string(255) | Entité : Person | Colonne : nom_usage | Traitement : - | Type de template : mail

Template(s) : death_alert, has_document, search_found, search_notfound, search_ambiguous, search_hasrequest, subject

useNameBdd

Provenance : base de données | Valeur possible : varchar(255) | Entité : Person | Colonne : nom_usage | Traitement : - | Type de template : mail, pdf

Template(s) : search_found, search_found_rec

userEmail

Provenance : base de données | Valeur possible : varchar(255) | Entité : User | Colonne : mail | Traitement : - | Type de template : mail

Template(s) : death_alert

userName

Provenance : base de données | Valeur possible : varchar(255) | Entité : User | Colonne : nom | Traitement : - | Type de template : mail

Template(s) : death_alert, subject

Paramètres disponibles dans le template

Dans tous les templates d’email il est possible d’utiliser les données définies dans activation parameter les paramètres de l’application, tel que :

  • settings.data.appName : le nom de l’application
  • settings.data.appUrl : l’url de l’application
  • settings.data.appLogo : le logo de l’application
  • settings.data.appFavicon : le favicon du site
  • settings.data.departmentName : le nom du département
  • settings.data.departmentSite : le site web du département
  • settings.data.departmentCilSite : le site CIL du département
  • settings.data.connectionAttempts : le nombre de tentatives de connexion avant blocage
  • settings.data.soundexSearch : la valeur de la recherche soundex
  • settings.data.acceptErrorInBirthDate : la précision de la date de naissance
  • settings.data.ignoreDifferentFirstNameSearch : la valeur du prénom est différent alors il donne ambigu et non connu
  • settings.data.searchByName : la valeur de la recherche par le nom
  • settings.data.deathAlert : la valeur de l’alerte décès
  • settings.data.deathAlertMail : le mail de destination des alertes décès
  • settings.data.mailSignature : la signature des mails système
  • settings.data.mailIntroduction : l’introduction des mails système
  • settings.data.mailNotaBene : le notabene des mails système
  • settings.data.claims : l’activation des créances
  • settings.data.claimsRecoverableStep : le seuil des créances récupérables
  • settings.data.claimsNonRecoverableStep : le seuil des créances non récupérables
  • settings.data.claimsMail : le mail du service des créances
  • settings.data.claimsMailManagement : le mail du service de gestion
  • settings.data.mailBusinessSignature : la signature des mails métier
  • settings.data.pdfDestinationCity : la ville destinataire des lettres PDF
  • settings.data.pdfLogo1 : le logo en entête des lettres PDF
  • settings.data.pdfLogo2 : le logo en pied de page des lettres PDF
  • settings.data.pdfServiceLogo : le logo de service des lettres PDF
  • settings.data.pdfSuccessionMail : le mail de succession des lettres PDF
  • settings.data.pdfSignature : la signature des lettres PDF
  • settings.data.pdfDepartmentalHouseName : la maison départementale des lettres PDF
  • settings.data.pdfDepartmentalHousePhone : le téléphone de la maison départementale des lettres PDF
  • settings.data.pdfCSS : le fichier CSS personnalisé
Mise à jour de l'applicationPersonnalisation des courriels