Commencer avec le Toolkit
Nous allons voir comment utiliser le Toolkit de façon très basique. Pour avoir plus d'informations sur les fonctionnalités, referez-vous aux pages dédiés à ces fonctionnalités.
Pour utiliser Web Toolkit, il faut tout d'abord télécharger la dernière version disponible, atuellement la version 1.0. Pour cela, Allez dans l'onglet Tags :
Et choisissez la dernière version, puis télécharger l'archive zip :
Décompressez l'archive, et récupérez le dossier lib, que vous mettrez à la racine de votre site web.
Si vous avez gardé le dossier lib d'origine, la fichier principal du toolkit devrais se trouver à lib/toolkit/toolkit.php.
Pour l'utiliser, vous n'avez juste qu'à inclure ce fichier !
<?php
require 'lib/toolkit/toolkit.php';
/*
* Le code ici !
*/Si vous avez modifié l'emplacement du Toolkit, modifiez le require comme il faut.
Et voilà, le Toolkit démarre tout seul, après l'inclusion du fichier, vous pouvez maintenant l'utiliser pleinement !
Un élément important d'un site (et surtout d'un CMS) est la configuration. Ce Toolkit permet de gérer un système de configuration facilement.
Le moyen le plus basique (mais le moins pratique) est de directement mettre le tableau de configuration dans la variable de configuration du Toolkit.
Pour cela, on utilise deux méthodes :
set_config($config) ou Toolkit::instance()->config = $config avec $config, le tableau de configuration.
Comme on peut le voir, et ce qui fait la particularité de ce toolkit, c'est que l'on peut aussi bien l'utiliser en tant que POO ou procedurial !
NB : le style procedurial permet en faite d'utiliser de façon implicite la POO. Les performances sont donc un peu moins bonne que si l'on utilise la POO.
<?php
require 'lib/toolkit/toolkit.php';
//définie la configuration
$config = array(
'output' => array(
'default_layout' => null,
'views_path' => __DIR__.DS.'views'.DS,
'xss_clean' => true
),
'database' => array(
'default' => array(
'host' => '127.0.0.1',
'username' => 'root',
'pass' => '',
'dbname' => 'test'
)
),
);
// style procedurial :
set_config($config);
// style POO
Toolkit::instance()->config = $config;Mais ce système est limité, car des items de configuration sont obligatoire (par exemple l'output), et il est obligatoire de le définir. De plus, il est plus pratique de configurer l'application via un fichier indépendant.
Un fichier de configuration est un fichier qui doit retourner obligatoirement un tableau de configuration.
<?php
// sécurité : pas d'accès directe à la configuration
if(!defined('TOOLKIT_VERSION'))
exit("Accès direct à la configuration non autorisé !");
//retourne le tableau de configuration
return array(
'output' => array(
'default_layout' => null,
'views_path' => __DIR__.DS.'views'.DS,
'xss_clean' => false
),
'database' => array(
'default' => array(
'host' => '127.0.0.1',
'username' => 'root',
'pass' => '',
'dbname' => 'test'
)
),
'input' => array(
'GET_object' => true,
'POST_object' => true
)
);La fonction à utiliser est set_config_file($file).
Il est conseillé d'utiliser plutôt la constante CONFIG_FILE avant l'inclusion du toolit.
Cette constante rend donc obsolète la fonction set_config_file($file).
Utiliser CONFIG_FILE permet à la configuration d'être utilisé directement au chargement du Toolkit, ce qui permet donc de totalement configurer le Toolkit. La version 1.0 ne permettant pas une telle fonctionnalité !
<?php
//définie le fichier de configuration
$config_file = 'inc/config.inc';
//depuis la version 1.1
define('CONFIG_FILE', $config_file);
require 'lib/toolkit/toolkit.php';
//pour la version 1.0
set_config_file($config_file);Et voilà, le Toolkit est enfin prêt à être utilisé !