Documentation de Wikka

Le fonctionnement des actions ou "Comment créer facilement son action"


Voir aussi
Utiliser des actions dans Wikka
Cette page est également disponible en Allemand

Techniquement, les actions ne sont rien de plus que des scripts PHP inclus par le moteur wiki lors de l'exécution:

Comme vous l'avez appris avec Utiliser des actions dans Wikka, l'utilisation d'une action se résume à mettre son nom entre {{ et }}. Le moteur wikka transfère le texte contenu entre ces accolades à la fonction Action($action, $forceLinkTracking=0) (située dans le fichier wikka.php). Un coup d'oeil plus appuyé vous fera remarquer que tous les mots, à l'exception du premier, sont traités comme paramètres de cette fonction. Si le fichier associé à l'action est trouvé, les paramètres lui sont transmis sous forme de tableau.

Vous pouvez très facilement augmenter les fonctionnalités de Wikka en ecrivant vos propres actions et en les sauvegardant sous ce nom dans le répertoire /actions/. Cette page a pour but de vous aider lors de la rédaction de vos actions.


1. Planning

La première étape est de savoir ce que devra faire votre plugin et de déterminer le meilleur moyen pour l'intégrer dans Wikka

Action vs. Handler
La plupart du temps, vous aurez à choisir sous quelle forme coder votre idée: action ou handler. Vous pouvez facilement déterminer quel format choisir en vous posant cette question: "Mon code ajoute-t-il une fonctionnalité à la page ou modifie-t-il le contenu de la page?"
  1. Si vous ajoutez une fonctionnalité à la page (le google-form, des prévisions météo, un tableau...), le meilleur format est l'action.
  1. Si vous modifiez le contenu de la page (clonage, suppression, édition...), le meilleur format est le handler.

Laissez les autres travailler pour vous... ;-)
Comme vous n'êtes pas le seul à coder en PHP, il est plus que probable que quelqu'un ait déjà écrit le code dont vous avez besoin. Et comme vous êtes un assidu de WIkkaWiki, vous avez déjà regardé dans les WikkaFeatures (officielles) et Development-Category, ainsi que dans les CodeContributions (non-officielles), non?

Cela peut prendre du temps à rechercher dans toutes ces pages, mais c'est toujours préférable au recodage d'un script déjà existant.

... ou, au moins, vous aider
Quand vous aurez commencé à écrire votre action, n'hésitez pas à l'annoncer sur PluginsInDevelopment, peut-être quelqu'un sera-t-il motivé pour vous aider.


2.Sécurité

gardez toujours à l'esprit que n'importe quel utilisateur ayant les droits d'écriture sur une page peut utiliser votre action. En d'autres termes, si vous voulez restreindre l'usage de votre action aux utilisateurs enregistrés et/ou aux administrateurs, n'oubliez pas d'inclure le code pour le contrôle dans votre action: Wikka ne le fera pas pour vous!

<?php
//* Code pour restreindre l'utilisation d'une action.

?>


Paramètres
Comme dit plus tôt, les paramètres sont passés à la fonction sous la forme d'un tableau. Vous pouvez utiliser le code suivant pour récupérer les valeurs:

<?php
//* Code pour récupérer les paramètres d'une action.

?>


a compléter

CategoryFR
There are no comments on this page.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki