Programmer avec SPIP 3.0
Documentation technique sur SPIP 3.0

> > > Définir des boutons

Définir des boutons

Pour ajouter des boutons dans l’espace privé il suffit de renseigner un attribut bouton dans le fichier plugin.xml, de la sorte :

  1. <bouton id="identifiant" parent="nom de l'identifiant parent">
  2. <icone>chemin de l'icone</icone>
  3. <titre>chaine de langue du titre</titre>
  4. <url>nom de l'exec</url>
  5. <args>arguments transmis</args>
  6. </bouton>

Télécharger

Description :

  • id reçoit l’identifiant unique du bouton, qui sert entre autre aux sous-menus à indiquer le nom de leur bouton parent. Souvent, le nom du fichier exec (servant à afficher la page) est le même que le nom de l’identifiant,
  • parent : optionnel, permet d’indiquer que le bouton est un sous élément d’un bouton parent. On renseigne donc l’identifiant du bouton parent. En son absence, c’est un élément de premier niveau qui sera créé (comme les boutons « À suivre, Édition, ... »,
  • icone : optionnel aussi, pour indiquer le chemin de l’icone,
  • titre : texte du bouton qui peut-être une chaîne de langue « plugin:chaine »,
  • url indique le nom du fichier exec qui est chargé si l’on clique sur le bouton. S’il n’est pas indiqué, c’est le nom de l’identifiant qui est utilisé.
  • args, optionnel, permet de passer des arguments à l’url (exemple : <args>critere=debut</args>).

Autorisations

Les boutons sont affichés par défaut pour toutes les personnes connectées à l’interface privée. Pour modifier cette configuration, il faut créer des autorisations spécifiques pour les boutons (et donc utiliser le pipeline d’autorisation pour charger les autorisations nouvelles du plugin) :

  1. function autoriser_identifiant_bouton_dist($faire, $type, $id, $qui, $opt) {
  2. return true; // ou false
  3. }

Télécharger

Exemple

Les statistiques de SPIP 2.3 – en cours de développement – seront dans un plugin séparé. Il reproduit actuellement les boutons comme ceci :

  1.  
  2. <pipeline>
  3. <nom>autoriser</nom>
  4. <inclure>stats_autoriser.php</inclure>
  5. </pipeline>
  6. <bouton id="statistiques_visites">
  7. <icone>images/statistiques-48.png</icone>
  8. <titre>icone_statistiques_visites</titre>
  9. </bouton>
  10. <bouton id='statistiques_repartition' parent='statistiques_visites'>
  11. <icone>images/rubrique-24.gif</icone>
  12. <titre>icone_repartition_visites</titre>
  13. </bouton>
  14. <bouton id='statistiques_lang' parent='statistiques_visites'>
  15. <icone>images/langues-24.gif</icone>
  16. <titre>onglet_repartition_lang</titre>
  17. </bouton>
  18. <bouton id='statistiques_referers' parent='statistiques_visites'>
  19. <icone>images/referers-24.gif</icone>
  20. <titre>titre_liens_entrants</titre>
  21. </bouton>

Télécharger

Les autorisations sont définies dans un fichier spécifique :

  1. <?php
  2. function stats_autoriser(){}
  3.  
  4. // Lire les stats ? = tous les admins
  5. function autoriser_voirstats_dist($faire, $type, $id, $qui, $opt) {
  6. return (($GLOBALS['meta']["activer_statistiques"] != 'non')
  7. AND ($qui['statut'] == '0minirezo'));
  8. }
  9.  
  10. // autorisation des boutons
  11. function autoriser_statistiques_visites_bouton_dist($faire, $type, $id, $qui, $opt) {
  12. return autoriser('voirstats', $type, $id, $qui, $opt);
  13. }
  14.  
  15. function autoriser_statistiques_repartition_bouton_dist($faire, $type, $id, $qui, $opt) {
  16. return autoriser('voirstats', $type, $id, $qui, $opt);
  17. }
  18.  
  19. function autoriser_statistiques_lang_bouton_dist($faire, $type, $id, $qui, $opt) {
  20. return ($GLOBALS['meta']['multi_articles'] == 'oui'
  21. OR $GLOBALS['meta']['multi_rubriques'] == 'oui')
  22. AND autoriser('voirstats', $type, $id, $qui, $opt);
  23. }
  24.  
  25. function autoriser_statistiques_referers_bouton_dist($faire, $type, $id, $qui, $opt) {
  26. return autoriser('voirstats', $type, $id, $qui, $opt);
  27. }
  28.  
  29. ?>

Télécharger