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.
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
- la surcharge du filtre de création de la requête serveur
Tout le code PHP est à commenter selon la norme de documentation phpDoc.
La page de configuration
Pour ajouter un nouveau serveur, il vous faut éditer :
- soit le fichier
fonds/cfg_thumbsites.html
pour la branche v0 compatible SPIP 2. La configuration utilise encore CFG. - soit le fichier
formulaires/configurer_thumbsites.html
pour la branche v1 compatible SPIP 3. la configuration n’utilise plus CFG.
- Ajout de l’option dans la liste des serveurs
La première étape consiste à ajouter le serveur comme une option supplémentaire du select. Il est important de bien définir nom_du_serveur
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, conditions d’utilisation...).
Il est essentiel de positionner le nom nom_du_serveur
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 nom_du_serveur_parametre
. Enfin, tous les textes doivent être sous forme d’items de langue (voir les serveurs existant).
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 nom_du_serveur, ce fichier sera nommé nom_du_serveur.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";
}
Aucune discussion
Ajouter un commentaire
Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :
Merci d’avance pour les personnes qui vous aideront !
Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.
Suivre les commentaires : |