Préambule
Cet article a pour but d’expliquer comment intervenir sur le code afin d’ajouter un nouveau serveur de vignettes ainsi que sa configuration avec CFG.
Organisation du code
Le plugin est entièrement éditable sur la zone. L’ajout d’un nouveau serveur se fait en 2 étapes :
- ajout des options de configuration (page CFG du plugin)
- la surcharge du filtre de création de la requête serveur
Tout le code PHP est à commenter selon la norme de documentation doxygen.
La page de configuration CFG
Pour ajouter un nouveau serveur, il vous faut éditer le fichier fonds/cfg_thumbsites.html.
- Ajout de l’option dans la liste des serveurs
La première étape consiste à ajouter le serveur comme une option supplémentaire du select. En supposant que le nom du serveur soit serveur_x, et que ce soit le cinquième serveur dans la liste, cela donnerait :
- <select name="serveur" id="serveur">
- <option value="thumbshots"[ (#ENV{serveur}|=={thumbshots}|?{selected="selected"})]><:thumbsites:cfg_itm_serveur_1:></option>
- .../...
- <option value="serveur_x"[ (#ENV{serveur}|=={serveur_x}|?{selected="selected"})]><:thumbsites:cfg_itm_serveur_5:></option>
- </select>
Il est important de bien définir serveur_x car c’est grâce à ce nom que le bon filtre de création de la requête serveur sera chargé.
- Ajout de la zone spécifique de configuration du serveur
La deuxième étape consiste à rajouter le fieldset qui contient la configuration spécifique du serveur (explications, taille des vignettes, identifiant de connexion...).
Il est essentiel de positionner le nom serveur_x en id de la balise fieldset ainsi que la classe de façon à assurer le fonctionnement du script jQuery. En outre, le nom des paramètres doivent être de la forme serveur_x_parametre. Enfin, tous les textes doivent être sous forme d’items de langue (voir les serveurs existant).
- <fieldset id="serveur_x" class="conf_serveur [(#ENV{serveur}|=={'serveur_x'}|?{'actif'})]">
- <legend><:thumbsites:cfg_itm_serveur_5:></legend>
- <p>Explication du serveur et de sa configuration sous forme d'item de langue</p>
- <p>Précisions sur la taille des vignettes sous forme d'item de langue</p>
- <p>
- <label for="serveur_x_parametre1">Label du paramètre sous forme d'item de langue</label>
- <input type="text" name="serveur_x_parametre1" id="serveur_x_parametre1" [value="(#ENV{serveur_x_parametre1})"]>
- </p>
- <p>
- [...] On ajouter les autres paramètres [...]
- </p>
- </fieldset>
Le script jQuery ne doit jamais être modifié.
La surcharge du filtre de création de la requête serveur
La surcharge consiste à créer un nouveau fichier dans le répertoire serveurs/. En considérant que notre nouveau serveur a pour nom serveur_x, ce fichier sera nommé serveur_x.php
Le code PHP qu’il contiendra sera de la forme :
- function url_thumbsite_serveur ($url_site) {
- // on lit les paramètres si besoin
- $param1 = lire_config('thumbsites/serveur_x_parametre1');
- // .../... les autres paramètres
- // on construit l'url
- // .../...
- // on retourne l'url de la requête serveur
- return "url de l'image générée";
- }
Répondre à cet article