Framework W :: Documentation

Light & powerful PHP framework

Configurations

Par sa simplicité, W ne requière pas tellement de configuration pour fonctionner. Le fait d'imposer certaines conventions aide également à limiter le nombre de réglages à réaliser.

Le fichier de configuration

W est livré avec un fichier nommé app/config.dist.php. Ce fichier est destiné à être versionné, et ne doit pas contenir d'informations personnelles ou sensibles. Le fichier lu par défaut par le framework est app/config.php, qui lui, ne doit pas être versionné, il vous est personnel.

Pour démarrer copier-coller y le contenu du fichier app/config.dist.php.

/* app/config.php */

$w_config = [
	//information de connexion à la bdd
	'db_charset'			=> 'utf8mb4', 				//type d'encodage, devrait être utf8 où utf8mb4
	'db_host'				=> 'localhost',				//hôte (ip, domaine) de la bdd
	'db_port'				=> 3306,					//port de connexion de la bdd
	'db_user'				=> 'root',					//nom d'utilisateur pour la bdd
	'db_pass'				=> '',						//mot de passe de la bdd
	'db_name'				=> '',						//nom de la bdd
	'db_table_prefix' 		=> '',						//préfixe ajouté aux noms de table

	//authentification, autorisation
	'security_user_table' => 'users',				//nom de la table contenant les infos des utilisateurs
	'security_id_property' => 'id',					//nom de la colonne pour la clé primaire
	'security_username_property' => 'username',		//nom de la colonne pour le "pseudo"
	'security_email_property' => 'email',			//nom de la colonne pour l'"email"
	'security_password_property' => 'password',		//nom de la colonne pour le "mot de passe"
	'security_role_property' => 'role',				//nom de la colonne pour le "role"

	'security_login_route_name' => 'login',			//nom de la route affichant le formulaire de connexion
];

Valeurs par défaut

Toutes les valeurs inscrites dans le fichier de base sont les valeurs par défaut. Vous pouvez si vous préférez retirer les clés de configuration pour lesquelles vous utilisez cette valeur par défaut.

Au besoin, vous pouvez retrouver les valeurs par défaut dans le fichier W/App.php

Les clés de configuration en détails

db_host, db_port, db_user, dp_pass et db_name

Les informations de connexion à votre base de données.

db_charset

L'encodage de la table, devrait être utf8 ou utf8mb4

db_table_prefix

Si vous utilisez le même préfixe pour le nom de toutes vos tables, vous pouvez le spécifier dans db_table_prefix. Le préfixe sera ajouté automatiquement lorsque vous réaliserez des requêtes avec vos modèles.

security_user_table

Le nom de la table contenant vos utilisateurs.

security_*_property (id, username, email, password, role)

Le nom des colonnes de votre utilisateur pour les champs qui intéressent le framwork W, respectivement : clé primaire, pseudo, email, mot de passe et role.

security_login_route_name

Le nom de la route menant à votre page affichant le formulaire de connexion. W redirigera effectivement les utilisateurs non-connectés tentant d'accéder à une ressource protégée vers cette page.