Ajouter des Outils
Les Outils doivent être déclarés dans le fichier de configuration du kit. Le nom doit être valide pour les variables PHP (au moins une lettre suivi de lettres, chiffres et underscores).
La classe de l'outil doit être fournie soit par le kit, et il faut alors la lister dans la section [load_files], soit par un kit tiers qui doit alors être listé dans les dépendances.
Il est possible d'inclure à la racine du kit un fichier de configuration qui sera importé à l'instanciation. Il faut alors le nommer comme l'outil suivi de .tool.ini
.
Ajoutons un outil HttpRealmTool
, nommé realm
au kit example
. Cet outil est fourni par le kit webappkit.httprealm
. On edite le fichier de configuration de example
(c'est à dire example.wak/wak.ini
) :
[load_kits]
10 = "webappkit.httprealm"
[tools]
realm = "HttpRealmTool"
On crée un fichier de configuration (qui en l'occurence liste les utilisateurs) nommé realm.tool.ini
. Le format de ces fichiers est spécifique à chaque classe d'outil. On peut alors utiliser cet outil, avec la configuration propre au kit :
// obtention du kit example
$example=&Webappkit::getkit('example');
// utilisation de l'outil realm
$example->realm->login();
Construire des outils
Les Outils sont des objets d'une classe héritant de WakTool. Ils doivent impérativement implementer la méthode Factory pour l'instanciation :
class ExampleTool extends WakTool {
/**
* a Factory function : every Tool has to declare it
* @static
* @param string $kit kit's id
* @param array $cfg configuration data taken from ini file
* @return object tool's instance
*/
function & Factory($kit,$cfg) {
return new ExampleTool($kit,$cfg);
}
/**
* @var array the default configuration values
*/
var $cfg=array('section'=>array(
'var'=>'value'));
}
Les données du fichier de configuration seront intégrées au sein de $cfg.