Tutoriel précédent : Developing Discourse Plugins - Part 4 - Setup git
Parfois, les paramètres du site ne suffisent pas pour que votre plugin fonctionne comme vous le souhaitez via l’interface d’administration. Par exemple, si vous installez le plugin discourse-akismet, vous avez peut-être remarqué qu’il ajoute un élément de navigation dans la section des plugins de l’administration de votre Discourse :
Dans ce tutoriel, nous allons vous montrer comment ajouter une interface d’administration pour votre plugin. Je vais appeler mon plugin purple-tentacle, en l’honneur de l’un de mes jeux vidéo préférés. Sérieusement, j’adore vraiment ce jeu !
Configuration de la route d’administration
Commençons par ajouter un fichier plugin.rb, comme nous l’avons fait dans les parties précédentes du tutoriel.
plugin.rb
# name: purple-tentacle
# about: A sample plugin showing how to add a plugin route
# version: 0.1
# authors: Robin Ward
# url: https://github.com/discourse/purple-tentacle
add_admin_route 'purple_tentacle.title', 'purple-tentacle'
Discourse::Application.routes.append do
get '/admin/plugins/purple-tentacle' => 'admin/plugins#index', constraints: StaffConstraint.new
end
La ligne add_admin_route indique à Discourse que ce plugin nécessitera un lien sur la page /admin/plugins. Son titre sera purple_tentacle.title, issu de notre fichier de traductions i18n, et il pointera vers la route purple-tentacle.
Les lignes suivantes configurent la correspondance côté serveur des routes pour notre plugin. Discourse suppose que presque chaque route côté frontend possède une route côté serveur fournissant des données. Pour ce plugin d’exemple, nous n’avons en réalité besoin d’aucune donnée côté backend, mais nous devons indiquer à Discourse de servir quelque chose au cas où l’utilisateur visiterait directement /admin/plugins/purple-tentacle. Cette ligne lui dit simplement : « Hé, si l’utilisateur visite cette URL directement côté serveur, affiche le contenu par défaut des plugins ! »
(Si cela vous paraît confus, ne vous inquiétez pas trop ; nous y reviendrons dans un prochain tutoriel lorsque nous traiterons des actions côté serveur.)
Ensuite, nous ajouterons un modèle qui sera affiché lorsque l’utilisateur visitera le chemin /admin/plugins/purple-tentacle. Il s’agira simplement d’un bouton qui affiche un gif animé d’un tentacule violet lorsque l’utilisateur clique sur le bouton :
assets/javascripts/discourse/templates/admin/plugins-purple-tentacle.gjs
import DButton from "discourse/components/d-button";
<template>
{{#if @controller.tentacleVisible}}
<div class="tentacle">
<img src="https://eviltrout.com/images/tentacle.gif" />
</div>
{{/if}}
<div class="buttons">
<DButton
@label="purple_tentacle.show"
@action={{@controller.showTentacle}}
@icon="eye"
@id="show-tentacle"
/>
</div>
</template>
Si vous avez appris les bases de Handlebars, ce modèle devrait être assez simple à comprendre. <DButton /> est un composant de Discourse que nous utilisons pour afficher un bouton avec un libellé et une icône.
Pour connecter notre nouveau modèle, nous devons créer une carte de route :
assets/javascripts/discourse/purple-tentacle-route-map.js
export default {
resource: "admin.adminPlugins",
path: "/plugins",
map() {
this.route("purple-tentacle");
},
};
Une carte de route est un élément que nous avons ajouté à Discourse pour permettre aux plugins d’ajouter des routes à l’application Ember. La syntaxe à l’intérieur de map() est très similaire à celle du routeur d’Ember. Dans ce cas, notre carte de route est très simple : elle déclare simplement une route appelée purple-tentacle sous /admin/plugins.
Enfin, ajoutons nos chaînes de traduction :
config/locales/client.en.yml
en:
js:
purple_tentacle:
title: "Purple Tentacle"
show: "Show Purple Tentacle"
Si vous redémarrez votre serveur de développement, vous devriez pouvoir visiter /admin/plugins et voir notre lien ! Si vous cliquez dessus, vous verrez le bouton pour afficher notre tentacule violet :
Malheureusement, lorsque vous cliquez sur le bouton, rien ne se passe 
Si vous regardez votre console de développement, vous devriez voir une erreur qui donne un indice sur la raison :
Uncaught Error: Nothing handled the action 'showTentacle'
Ah oui, la raison est que dans notre modèle, nous dépendons de deux choses :
- Que lorsque l’utilisateur clique sur le bouton,
showTentaclesera appelé sur le contrôleur. - Que
showTentacledéfinisse la propriététentacleVisibleàtrueafin que l’image s’affiche.
Si vous n’avez pas lu les Guides Ember sur les contrôleurs, c’est le moment idéal pour le faire, car nous allons implémenter un contrôleur pour notre modèle purple-tentacle qui gérera cette logique.
Créez le fichier suivant :
assets/javascripts/discourse/controllers/admin-plugins-purple-tentacle.js
import Controller from "@ember/controller";
import { action } from "@ember/object";
import { tracked } from "@glimmer/tracking";
export default class AdminPluginsPurpleTentacleController extends Controller {
@tracked tentacleVisible = false;
@action
showTentacle() {
this.tentacleVisible = true;
}
}
Et maintenant, lorsque nous actualisons notre page, cliquer sur le bouton affiche notre personnage animé !
Je laisse le lecteur se charger de l’exercice supplémentaire consistant à ajouter un bouton qui cache le tentacule lorsqu’il est cliqué 
Si vous avez des difficultés à faire fonctionner votre version de ce plugin, je l’ai poussé sur GitHub.
Suite de la série
Partie 1 : Bases des plugins
Partie 2 : Sorties de plugins
Partie 3 : Paramètres du site
Partie 4 : Configuration git
Partie 5 : Ce sujet
Partie 6 : Tests d’acceptation
Partie 7 : Publiez votre plugin
Ce document est versionné — proposez des modifications sur GitHub.
