DokuWiki

It's better when it's simple

Outils pour utilisateurs

Outils du site


fr:devel:plugin_programming_tips

Astuce de programmation sur les plugins en général

Prenez la peine d'ajouter les astuces que vous utilisez et qui peuvent faciliter la création de plugins aux autres. J'ai dû fouiller mes souvenirs pour obtenir ces infos, et j'espère qu'elles seront utiles aux autres ;-)

  • Si vous avez besoin d'accéder à une valeur de configuration pour votre plugin, utilisez la fonction getConf(<config option>);
    • Ex: si mon plugin a une option pour donner une valeur à 'namespace', j'aurai sa valeur en appelant
      $this->getConf('namespace');
    • la config doit être stockée dans <votre répertoire plugin>/conf/default.php
    • si vous voulez que votre configuration soit accessible par l'interface du Gestionnaire de configuration, vous devez créer un fichier de métadonnées avec la description des champs. Voir plugin configuration_metadata pour plus d'informations.
  • Vous pouvez accéder à user-lists/info et plus pour un usage interne en déclarant ce qui suit dans la fonction qui en a besoin :
    global $auth;
    $auth->retrieveUsers(0,0,$filter);
    
  • Où $filter est un tableau avec une, deux ou plus des clés suivantes: 'user', 'name', 'mail', ou 'grps'. Plusieurs valeurs dans chaque en les séparant par '|'
  • Ex: pour retrouver tous les utilisateurs du groupe 'admin', on utilisera
        $filter['grps']="admin";
        $array_of_matches = retrieveUsers(0,0,$filter);
        

Variables globales de DokuWiki

DokuWiki fournit un certain nombre de variables globales qui donnent de l'information sur la page courante, l'utilisateur courant et les actions en cours. On peut trouver des détails là-dessus dans template development information.

fr/devel/plugin_programming_tips.txt · Dernière modification : 2013-03-29 09:22 de 195.221.61.29

Sauf mention contraire, le contenu de ce wiki est placé sous les termes de la licence suivante : CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki