Programmer avec SPIP 3.0
Documentation technique sur SPIP 3.0

> > > > autoriser

autoriser

Le pipeline « autoriser » est particulier. Il permet simplement de charger des fonctions d’autorisations au tout premier appel de la fonction autoriser(). Ce pipeline ne transmet rien et ne reçoit rien.

  1. pipeline('autoriser');

Grâce à lui, un plugin peut déclarer des autorisations spécifiques, regroupées dans un fichier « prefixePlugin_autorisations.php » et les déclarer, dans plugin.xml comme ceci :

  1. <pipeline>
  2. <nom>autoriser</nom>
  3. <inclure>prefixePlugin_autorisations.php</inclure>
  4. </pipeline>

Télécharger

Outre les fonctions d’autorisations, le fichier doit contenir la fonction appelée par tous les pipelines (« prefixePlugin_nomDuPipeline() ») mais elle n’a rien a effectuer. Un exemple :

  1. function prefixePlugin_autoriser(){}

Attention ! l’exemple donné ci-dessous comporte un piège : le forum dans le nom des fonctions d’autorisation est le type d’objet concerné. Il se trouve que le type forum s’appelle pareil que le préfixe du plugin forum, mais c’est un cas particulier. Utilisez le type ! [1]

On peut aussi avoir simplement besoin de Donner une autorisation exceptionnelle.

Exemple

Le plugin « forum » déclare quelques autorisations. Son fichier plugin.xml contient :

  1. <pipeline>
  2. <nom>autoriser</nom>
  3. <inclure>forum_autoriser.php</inclure>
  4. </pipeline>

Télécharger

Et le fichier appelé, « forum_autoriser.php » contient :

  1. // declarer la fonction du pipeline
  2. function forum_autoriser(){}
  3.  
  4. function autoriser_forum_interne_suivi_bouton_dist($faire, $type, $id, $qui, $opt) {
  5. return true;
  6. }
  7.  
  8. function autoriser_forum_reactions_bouton_dist(($faire, $type, $id, $qui, $opt) {
  9. return autoriser('publierdans', 'rubrique', _request('id_rubrique'));
  10. }
  11.  
  12. // Moderer le forum ?
  13. // = modifier l'objet correspondant (si forum attache a un objet)
  14. // = droits par defaut sinon (admin complet pour moderation complete)
  15. function autoriser_modererforum_dist($faire, $type, $id, $qui, $opt) {
  16. return autoriser('modifier', $type, $id, $qui, $opt);
  17. }
  18.  
  19. // Modifier un forum ? jamais !
  20. function autoriser_forum_modifier_dist($faire, $type, $id, $qui, $opt) {
  21. return false;
  22. }
  23. ...

Télécharger

Notes

[1Voir le code source de inc/autoriser.php.