👨🏽🔧 App Configuration
Introduction
Tous les fichiers de configuration de Bow Framework sont stockés dans le dossier config
. Chaque option est documentée, alors n'hésitez pas à parcourir les fichiers et à vous familiariser avec les options à votre disposition.
Configuration
Vous pouvez accéder et modifier la configuration avec le helper config
. L'accès aux valeurs se fait via un système de notation à point (Dot notation).
Récupération d'une valeur:
echo config('app.public_path')
Modification d'une valeur:
config('view.engine', 'twig');
config('view.extension', '.twig');
Explication de la notation à point
Dans une notation à point, la partie avant le premier point représente le nom du fichier et toutes les valeurs suivantes représentent des clés ou valeurs du tableau de configuration.
Imaginez qu'on a un tableau défini comme suit et qui est dans un fichier dont le nom est bow.php
:
return [
'name' => 'Bow',
'skill' => [
'level' => 'easiest',
'orm' => true,
'preset' => [
'reactjs', 'vue'
]
]
];
Avec config
nous allons voir comment avoir accès à ces valeurs.
config('bow.name'); // Bow
config('bow'); // Retourne le tableau entier
config('bow.skill.orm') // true
config('bow.skill.preset.0') // reactjs
Remarquez qu'en premier c'est le nom du fichier qui contient la configuration, ici
bow.
Fichier .env.json
Il est souvent souhaitable d'avoir différentes valeurs de configuration selon l'environnement ou notre application est lancée. Par exemple, l'on peut vouloir activer des logs de débogage en développement mais pas en production.
Pour cela Bow utilise le fichier .env.json
fichier dans lequel sont définis les informations concernant la configuration de votre application au format JSON. C'est aussi l'endroit idéal pour définir les informations sensibles comme une clé d'accès à un service.
Votre fichier .env.json
ne doit pas sous contrôle de version, parce que chaque développeur/serveur utilisant votre application peut nécessiter une configuration d'environnement différente. De plus cela constituerait aussi un risque de sécurité dans le cas où un intrus aurait accès à votre depot de code source, parce que toutes les informations d'identification sensibles seraient exposées.
Le fichier
.env.example.json
sert de base pour la création du fichier.env.json
.
Récupération des informations
Toutes les variables répertoriées dans le fichier .env.json
seront chargées lorsque votre application recevra une requête. Cependant, vous pouvez utiliser le helper app_env
pour récupérer les valeurs de ces variables dans les fichiers de configuration. En fait, si vous examinez les fichiers de configuration de Bow, vous remarquerez plusieurs des options utilisant déjà cet helper:
'database' => app_env('DB_HOSTNAME'),
Dans le cas où la variable n'est pas définie app_env
retournera null
, ou bien vous pouvez passer un deuxième paramètre à app_env
qui sera la valeur par défaut si la valeur n'est pas trouvé.
'database' => app_env('DB_HOSTNAME', 'localhost'),
Helpers
Bow inclut une variété de fonctions PHP "d'assistance" globales. Beaucoup de ces fonctions sont utilisées par le Framework lui-même; Cependant, vous êtes libre de les utiliser dans vos propres applications si vous les trouvez pratiques.
Notez que dans le fichier config/helpers.php
il y a aussi des helpers, mais cela ne sont pas utiliser dans le Framework. Vous pouvez définir aussi vos helpers dans ce fichier.
Il manque quelque chose ?
Si vous rencontrez des problèmes avec la documentation ou si vous avez des suggestions pour améliorer la documentation ou le projet en général, veuillez déposer une issue pour nous, ou envoyer un tweet mentionnant le compte Twitter @bowframework ou sur directement sur le github.