Annexes
Structure du fichier de configuration
Ce fichier est créé automatiquement par l'assistant d'installation, mais en cas de modification il est bon de savoir à quoi servent ses composantes.
Voici donc un exemple de contenu du fichier de configuration principal, expliqué ligne par ligne en dessous :
{
"apiUrl": "https://example-robert2.net",
"basename": "Robert2",
"enableCORS": true,
"displayErrorDetails": false,
"useRouterCache": false,
"useHTTPS": true,
"maxItemsPerPage": 100,
"JWTSecret": "super_long_secret_string_to_never_commit",
"httpAuthHeader": "Authorization",
"sessionExpireHours": 12,
"defaultLang": "fr",
"currency": {
"symbol": "€",
"name": "Euro",
"iso": "EUR",
"symbol_intl": "€",
"decimal_digits": 2,
"rounding": 0
},
"defaultTags": {
"beneficiary": "Bénéficiaire",
"technician": "Technicien"
},
"billingMode": "partial",
"defaultParkName": "Interne",
"degressiveRateFunction": "((daysCount - 1) * 0.75) + 1",
"db": {
"host": "localhost",
"username": "myuser",
"password": "mypassword",
"database": "robert2",
"prefix": ""
},
"companyData": {
"name": "Votre société",
"street": "32, rue du matoss",
"zipCode": "75000",
"locality": "Paris",
"country": "France",
"phone": "+33 (0)1 23 45 67 89",
"email": "contact@your-company.com",
"vatNumber": "FR78945612300",
"vatRate": 20.0,
"legalNumbers": [
{
"name": "SIRET",
"value": "543 210 080 20145"
},
{
"name": "APE",
"value": "947A"
}
]
}
}
Clé | Description | Type de valeur | Valeur par défaut |
---|---|---|---|
apiUrl | Adresse web de l'application | string | [URL actuel] |
basename | Nom de l'application | string | "Robert2" |
enableCORS | Activer le "Cross Origin Resource Sharing" | boolean | false |
displayErrorDetails | Afficher le détail des erreurs (stack trace) | boolean | false |
useRouterCache | Utiliser le cache du rounter de Slim3 | boolean | true |
useHTTPS | Utiliser SSL | boolean | [Détection auto] |
maxItemsPerPage | Nombre d'enregistrements retournés par pages pour la pagination | integer | 100 |
JWTSecret | Passphrase utilisée pour la création du JWT (Json Web Token) | string | [Valeur aléatoire] |
httpAuthHeader | Nom du header utilisé pour l'authentification des requêtes | string | "Authorization" |
sessionExpireHours | Nombre d'heures avant expiration d'une session utilisateur | integer | 12 |
defaultLang | Langue de l'interface par défaut (en étant non connecté) | "fr" ou "en" | "fr" |
currency | Devise utilisée pour les montants : un tableau décrivant la devise | array | [Euro] |
defaultTags | Tags utilisés par le système pour les entités spéciales | array | ["Bénéficiaire", "Technicien"] |
defaultParkName | Nom du parc principal utilisé au départ pour le matériel | string | "Interne" |
billingMode | Le mode d'utilisation de la facturation. Trois valeurs possibles : - "all" : facturation de tous les événements, - "partial" : facturation des événements facturables uniquement, - "none" : pas de facturation du tout (mode prêt) |
string | "partial" |
degressiveRateFunction | Fonction (javascript) permettant d'appliquer un tarif dégressif | string | ((daysCount - 1) * 0.75) + 1 |
db | Informations de connection à la base de données MySQL | array | |
→ db.host | Le nom du serveur hôte à utiliser pour la connexion MySQL | string | "localhost" |
→ db.username | Le nom de l'utilisateur MySQL à utiliser pour la connexion à la base de données | string | "root" |
→ db.password | Le mot de passe de l'utilisateur MySQL | string | "" |
→ db.database | Le nom de la base de données | string | "robert2" |
→ db.prefix | Un préfixe éventuel à ajouter devant chaque nom de table de la base de données | string | "" |
companyData | Informations de la société pour la création des documents (devis, factures...) | array | |
→ companyData.name | Raison sociale (nom) de la société | string | "" |
→ companyData.street | Adresse postale (rue et numéro) de la société | string | "" |
→ companyData.zipCode | Code postal de la société | string | "" |
→ companyData.locality | Localité (ville ou village) de la société | string | "" |
→ companyData.country | Pays de la société | string | "" |
→ companyData.phone | Numéro de téléphone de la société | string | "" |
→ companyData.email | Adresse email de contact de la société | string | "" |
→ companyData.vatNumber | Numéro de TVA intracommunautaire de la société | string | "" |
→ companyData.vatRate | Taux de TVA applicable dans les factures | float | 0.0 |
→ companyData.legalNumbers | Numéros légaux supplémentaires pour affichage sur les documents (devis et factures) | array | |
→ companyData.legalNumbers.0.name | Type du premier numéro légal (nom ou acronyme) | string | "SIRET" |
→ companyData.legalNumbers.0.value | Valeur du premier numéro légal | string | "" |
→ companyData.legalNumbers.1.name | Type du second numéro légal (nom ou acronyme) | string | "APE" |
→ companyData.legalNumbers.1.value | Valeur du second numéro légal | string | "" |
Important
Veillez bien à ne pas casser la structure du fichier de configuration, car cela pourrait rendre Robert2 complètement inutilisable.
Coefficient de tarif dégressif
Lors de l'étape 2 de l'assistant d'installation, une formule a été définie pour appliquer un tarif dégressif aux événements.
Par défaut, cette formule est la suivante : ((daysCount - 1) * 0.75) + 1
. On peut traduire ceci par la phrase :
« Le premier jour est à plein tarif, et les jours supplémentaires sont à 3/4 du tarif »
Vous pouvez modifier cette formule en modifiant le fichier de configuration pour qu'elle corresponde à vos besoins.
Il s'agit du contenu d'une fonction javascript. Cette fonction n'accepte qu'une seule variable, daysCount
qui correspond au nombre de jours d'un événement.
Vous êtes libre de composer votre formule comme vous le voulez. Si vous souhaitez ne pas appliquer de tarif dégressif, il suffit d'inscrire daysCount
(ce qui veut dire que le tarif sera toujours exactement proportionnel au nombre de jours de l'événement).
Personnaliser les factures
Il est possible de personnaliser la présentation des factures, en modifiant le fichier src/views/pdf/bill-default.twig
. Il s'agit d'un fichier écrit en HTML, il faut donc maîtriser ce langage. Le système de template utilisé est Twig 3. Le système fourni des variables permettant d'afficher les diverses données de la facture. Pour utiliser une variable, il suffit d'écrire son nom entre double-accolades, comme ceci : {{ variable }}
, ou {{ variable['name'] }}
.
Voici la liste des variables disponibles :
Variable | Description | Type |
---|---|---|
number |
Numéro de la facture. | string |
date |
Date de la facture. | DateTime* |
currency |
Devise de la facture (code ISO, par ex. EUR ). |
string |
currencyName |
Nom de la devise de la facture (p. ex. Euro ). |
string |
dailyAmount |
Montant total par jour. | float** |
degressiveRate |
Coefficient du tarif dégressif (voir fichier de config). | float** |
daysCount |
Nombre de jours (durée) de l'événement. | integer |
discountableDailyAmount |
Montant remisable total par jour. | float** |
discountRate |
Taux de remise appliqué (voir fichier de config). | float** |
discountAmount |
Montant total de la remise. | float** |
vatRate |
Taux de T.V.A. applicable | float** |
vatAmount |
Montant de la T.V.A. | float** |
totalDailyExclVat |
Montant total par jour H.T. (hors taxes). | float** |
totalDailyInclVat |
Montant total par jour T.T.C. (toutes taxes comprises) | float** |
totalExclVat |
Montant total de la facture H.T. (hors taxes). | float** |
totalInclVat |
Montant total de la facture T.T.C. (toutes taxes comprises). | float** |
totalReplacement |
Valeur de remplacement totale. | float** |
locale |
Langue utilisée pour les traductions (fr , ou en ). |
string |
company |
Informations de votre société (voir ci-dessous). |
Array |
company[name] |
Nom de votre société. | string |
company[street] |
Adresse de votre société (rue et n°). | string |
company[zipCode] |
Code postal de votre société. | string |
company[locality] |
Ville de votre société. | string |
company[country] |
Pays de votre société. | string |
company[phone] |
Numéro de téléphone de votre société. | string |
company[email] |
Adresse e-mail de contact de votre société. | string |
company[vatNumber] |
Le numéro de T.V.A. de votre société. | string |
company[legalNumbers] |
Numéros spéciaux de votre société. (Par exemple, n° SIRET ou code APE, voir fichier de config). Pour chaque numéro, les clés name et value sont disponibles. |
Array |
event |
Informations de l'événement à facturer (voir ci-dessous). |
Array |
event[title] |
Titre (nom) de l'événement. | string |
event[start_date] |
Date de début de l'événement. | DateTime* |
event[end_date] |
Date de fin de l'événement. | DateTime* |
event[location] |
Localisation (lieu) de l'événement. | string |
event[beneficiaries] |
La liste des bénéficiaires de l'événement. Dans la vue par défaut, seul le 1er bénéficiaire de la liste (le 0 ) est utilisé. |
Array |
event[beneficiaries][0][full_name] |
Nom complet du bénéficiaire. | string |
event[beneficiaries][0][street] |
Adresse (rue et numéro) du bénéficiaire. | string |
event[beneficiaries][0][postal_code] |
Code postal du bénéficiaire. | string |
event[beneficiaries][0][locality] |
Ville du bénéficiaire. | string |
categoriesSubTotals |
Sous-totaux par catégories (voir ci-dessous). |
Array |
categoriesSubTotals[x][name] |
Nom de la catégorie. | string |
categoriesSubTotals[x][quantity] |
Quantité de matériel dans la catégorie. | integer |
categoriesSubTotals[x][subTotal] |
Montant total pour la catégorie. | float** |
materialBySubCategories |
Détail du matériel, trié par catégories et sous-catégories (voir ci-dessous). |
Array |
materialBySubCategories[x][name] |
Nom de la sous-catégorie. | string |
materialBySubCategories[x][materials] |
Liste du matériel de la sous-catégorie (voir ci-dessous). | Array |
materialBySubCategories[x][materials][x][reference] |
Référence du matériel. | string |
materialBySubCategories[x][materials][x][name] |
Nom du matériel. | string |
materialBySubCategories[x][materials][x][quantity] |
Quantité du matériel alloué. | integer |
materialBySubCategories[x][materials][x][rentalPrice] |
Tarif de location (unité). | float** |
materialBySubCategories[x][materials][x][replacementPrice] |
Prix de remplacement total du matériel. | float** |
materialBySubCategories[x][materials][x][total] |
Montant total pour le matériel. | float** |
*
Les variables du type DateTime
peuvent être formatées avec le filtre format_date()
de Twig.
**
Les variables du type float
peuvent être formatées avec le filtre format_currency()
de Twig si on veut un montant en devise, ou bien le filtre format_percent_number()
si on veut un nombre en %.