Skip to content

Commit 67dec5d

Browse files
papacpapac
authored
Merge pull request #41 from bowphp/update-config
Add the version 5.x
2 parents 49e11b4 + 0bc631b commit 67dec5d

35 files changed

+5753
-0
lines changed

‎versioned_docs/version-5.x/auth.mdx

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
id: auth
3+
title: "👮🏽 Authentification"
4+
---
5+
6+
import SuggestionFeature from "@site/src/components/Partials/SuggestionFeature";
7+
8+
# Introduction
9+
10+
Bow Framework intègre un système d'authentification native. Cela vous permettra de faire une authentification très simple qui sera accessible directement dans toute votre application.
11+
12+
<SuggestionFeature />

‎versioned_docs/version-5.x/concept.mdx

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
id: concept
3+
title: "👨🏽‍💻 Concept et Architecture"
4+
---
5+
6+
import SuggestionFeature from "@site/src/components/Partials/SuggestionFeature";
7+
import BugReportFeature from "@site/src/components/Partials/BugReportFeature";
8+
9+
# Bow Framework
10+
11+
<a href="https://bowphp.com" title="docs"><img src="https://img.shields.io/badge/docs-read%20docs-blue.svg?style=flat-square"/></a>
12+
<a href="https://packagist.org/packages/bowphp/app" title="version"><img src="https://img.shields.io/packagist/v/bowphp/app.svg?style=flat-square"/></a>
13+
<a href="https://github.com/bowphp/app/blob/master/LICENSE" title="license"><img src="https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square"/></a>
14+
<a href="https://travis-ci.org/bowphp/app" title="Travis branch"><img src="https://img.shields.io/travis/bowphp/app/master.svg?style=flat-square"/></a>
15+
16+
Bow est un framework PHP, écrit par **[Franck DAKIA](https://github.com/papac)** et autres contributeurs.
17+
18+
L'objectif est de permettre aux débutants qui souhaitent travailler sur un plus large projet et comprendre le fonctionnement du **développement collaboratif** de s'y mettre avec aisance et faire de ce framework une référence dans la communauté PHP.
19+
20+
**Faites-vous une idée en commençant par la [documentation](https://bowphp.com).**
21+
22+
## Contributing
23+
24+
Merci d'avoir envisagé de contribuer à Bow Framework! Le guide de contribution se trouve dans la documentation.
25+
26+
- [Franck DAKIA](https://github.com/papac)
27+
- [Merci aux collaborateurs](https://github.com/bowphp/app/graphs/contributors)
28+
29+
## Contact
30+
31+
- [Franck DAKIA](https://github.com/papac)
32+
- [Thank's collaborators](https://github.com/bowphp/docs/graphs/contributors)
33+
34+
<BugReportFeature />
35+
<SuggestionFeature />

‎versioned_docs/version-5.x/configuration.mdx

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
id: configuration
3+
title: "👨🏽‍🔧 App Configuration"
4+
---
5+
6+
import SuggestionFeature from "@site/src/components/Partials/SuggestionFeature";
7+
8+
- [Introduction](#introduction)
9+
- [Configuration](#configuration)
10+
- [Explication de la notation à point](#explication-de-la-notation-à-point)
11+
- [Fichier .env.json](#fichier-envjson)
12+
- [Récupération des informations](#récupération-des-informations)
13+
- [Helpers](#helpers)
14+
- [Il manque quelque chose ?](#il-manque-quelque-chose-)
15+
16+
## Introduction
17+
18+
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.
19+
20+
## Configuration
21+
22+
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](#explication-de-la-notation-a-point) (Dot notation).
23+
24+
Récupération d'une valeur:
25+
26+
```php
27+
echo config('app.public_path')
28+
```
29+
30+
Modification d'une valeur:
31+
32+
```php
33+
config('view.engine', 'twig');
34+
config('view.extension', '.twig');
35+
```
36+
37+
### Explication de la notation à point
38+
39+
Dans une notation à point, la partie avant le premier point représente le nom du fichier et toutes les valeurs suivantes
40+
représentent des clés ou valeurs du tableau de configuration.
41+
42+
Imaginez qu'on a un tableau défini comme suit et qui est dans un fichier dont le nom est `bow.php`:
43+
44+
```php
45+
return [
46+
'name' => 'Bow',
47+
'skill' => [
48+
'level' => 'easiest',
49+
'orm' => true,
50+
'preset' => [
51+
'reactjs', 'vue'
52+
]
53+
]
54+
];
55+
```
56+
57+
Avec `config` nous allons voir comment avoir accès à ces valeurs.
58+
59+
```php
60+
config('bow.name'); // Bow
61+
config('bow'); // Retourne le tableau entier
62+
config('bow.skill.orm') // true
63+
config('bow.skill.preset.0') // reactjs
64+
```
65+
66+
> Remarquez qu'en premier c'est le nom du fichier qui contient la configuration, ici `bow.`
67+
68+
### Fichier .env.json
69+
70+
Il est souvent souhaitable d'avoir différentes valeurs de configuration selon l'environnement ou notre application est lancée. Par exemple, l'on
71+
peut vouloir activer des logs de débogage en développement mais pas en production.
72+
73+
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.
74+
75+
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.
76+
77+
> Le fichier `.env.example.json` sert de base pour la création du fichier `.env.json`.
78+
79+
### Récupération des informations
80+
81+
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:
82+
83+
```php
84+
'database' => app_env('DB_HOSTNAME'),
85+
```
86+
87+
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é.
88+
89+
```php
90+
'database' => app_env('DB_HOSTNAME', 'localhost'),
91+
```
92+
93+
## Helpers
94+
95+
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.
96+
97+
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.
98+
99+
<SuggestionFeature />

‎versioned_docs/version-5.x/console.mdx

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: console
3+
title: "👨🏾‍💻 Bow Console"
4+
---
5+
6+
import SuggestionFeature from "@site/src/components/Partials/SuggestionFeature";
7+
8+
COMMAND:
9+
10+
help display command helper
11+
12+
### GENERATE create a new app key and resources
13+
14+
generate:resource Create new REST controller
15+
generate:session For generate session table
16+
generate:key Create new app key
17+
18+
### ADD Create a user class
19+
20+
| Commandee | Description |
21+
|----------|------|
22+
| add:middleware | Create new middleware |
23+
| add:configuration | Create new configuration |
24+
| add:service | Create new service |
25+
| add:exception | Create new exception |
26+
| add:controller | Create new controller |
27+
| add:model | Create new model |
28+
| add:validator | Create new validator |
29+
| add:seeder | Create new table fake seeder |
30+
| add:migration | Create a new migration |
31+
| add:event | Create a new event listener |
32+
33+
### MIGRATION apply a migration in user model
34+
35+
| Commandee | Description |
36+
|----------|------|
37+
| migration:migrate | Make migration |
38+
| migration:reset | Reset all migration |
39+
| migration:rollback | Rollback to previous migration |
40+
| migrate | Alias of migration:migrate |
41+
42+
### CLEAR for clear cache information
43+
44+
clear:view Clear view cached information
45+
clear:cache Clear cache information
46+
clear:session Clear session cache information
47+
clear:log Clear logs cache information
48+
clear:all Clear all cache information
49+
50+
### SEED Make seeding
51+
52+
seed:table [name] Make seeding for one table
53+
seed:all Make seeding for all
54+
55+
### RUN Launch process
56+
57+
run:console show psysh php REPL for debug you code.
58+
run:server run a local web server.
59+
60+
<SuggestionFeature />

‎versioned_docs/version-5.x/container.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
id: container
3+
title: Capsule
4+
---
5+
6+
import SuggestionFeature from "@site/src/components/Partials/SuggestionFeature";
7+
8+
<SuggestionFeature />

‎versioned_docs/version-5.x/contribution.mdx

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: contribution
3+
title: "👩🏽‍🍳 Guide de Contribution"
4+
---
5+
6+
import SuggestionFeature from "@site/src/components/Partials/SuggestionFeature";
7+
8+
- [Introduction](#introduction)
9+
- [Processus de contribution](#processus-de-contribution)
10+
- [Format des messages de commit](#format-des-messages-de-commit)
11+
- [Il manque quelque chose ?](#il-manque-quelque-chose-)
12+
13+
## Introduction
14+
15+
Les contributions sont les bienvenues et seront entièrement créditées. Si vous voulez contribuer au projet, veuillez d'abord discuter
16+
des changements que vous voulez apporter via email, en créant une issue sur github, avec les responsables du dépôt avant
17+
de coder votre solution.
18+
19+
Veuillez s'il vous plaît vous conformer au code de conduite lors de vos interactions sur ce projet.
20+
21+
Nous acceptons les contributions via Pull Request sur [GitHub](https://github.com).
22+
23+
## Processus de contribution
24+
25+
- Fork le projet
26+
- Créez une branche avec un nom descriptif de vos modifications
27+
- Utilisez des messages de commits descriptifs
28+
- Ajoutez des test unitaires
29+
- Documentez vos modifications - Assurez vous que la documentation est mise à jour selon vos modifications
30+
- Un pull request par fonctionnalité - Si vous voulez faire plus d'une chose, faites plusieurs pull requests
31+
- Mettez à jour la version - Nous suivons le schema SemVer
32+
33+
## Format des messages de commit
34+
35+
Pour faciliter la maintenance du dépôt, Bow utilise un format pour les messages de commits.
36+
37+
- `change` pour ajouter un changement sur un functionnement
38+
- `fix` pour fixer une bug
39+
- `feat` pour ajouter une nouvelle fonctionnalité
40+
41+
Veuillez vous référer à l'exemple suivant:
42+
43+
```sh
44+
git commit
45+
```
46+
47+
Dans votre éditeur
48+
49+
```txt
50+
change(module_name): your commit message
51+
52+
Description
53+
```
54+
55+
Si la modification affecte une section:
56+
57+
```bash
58+
git commit -m "change(session): rename init variable"
59+
```
60+
61+
Si la modification affecte un élément dans une section:
62+
63+
```bash
64+
git commit -m "fix(http:request): bug fix #40"
65+
```
66+
67+
Dans le cas où vos modifications affectent plusieurs sections, ajoutez une description avec votre commit sous forme de liste à puce.
68+
69+
> Notez que les messages de commit doivent être en anglais.
70+
71+
<SuggestionFeature />

0 commit comments

Comments
 (0)