Revision [7835]

This is an old revision of ActionInfoDE made by YvesFischer on 2005-05-03 13:13:50.

 

Wie Actions aufgebaut sind und eigene geschrieben werden können

ACHTUNG: Diese Seite befindet sich im Aufbau!!!!


Technisch gesehen sind actions nichts anderes als normale php-files, welche durch die wikka-engine eingebunden(included) werden.
Actions liegen im /actions verzeichniss, ausgehend vom Wikka Wurzelverzeichniss.
Actions können einfach in eine Seite eingefügt werden indem ihr name zwischen {{ und }} geschrieben wird.
Der Wikka Formatierer sendet den Text zwischen den Klammern zu dem action (/action/$action.php) in form eines Arrays.


Die Funktionalität von Wikka Wiki kann durch das schreiben von eigenen actions einfach erweitert werden.
Diese Seite ist dazu da hierbei Hilfestellung zu geben.


1. Planung

At first, you should think about what you want to do and if an action is the best choice for it.

Action vs. Handler
Mostly you will have to choose between action and handler. You can easily seperate them with the following question:
Do you add something to a page, or do you want to do something with the page?

- for an addition to a page (the google-form, a weather-forecast, a table), an action should be your choise
- for doing something to a page (like cloning, deleting, editing...), use a handler

Haben andere schon die Arbeit getan?
Bevor du anfängst eine Action komplett selbst zu programmieren solltest du erst schauen ob nicht:
- Die Funktion beim offiziellen Release enthalten ist
- Unter CodeContributions schon jemand etwas ähnliches programmiert hat
- Ob du nicht in der CategoryDevelopment fündig wirst
Es dauert zwar lange gründlich zu suchen, ist aber besser als eine Arbeit zwei mal zu erledigen.
Ziehe auch lieber einen Fork in betracht als eine Action neu zu implementieren.

Helfen lassen
Wenn du angefangen hast eine Action zu programmieren, verkünde dies bitte auf PluginsIn Development weil dir vielleicht einer oder mehrere beim programmieren helfen wollen.
Wenn ein Projekt erfolgreich ist sollte eine Wiki Seite dafür eingerichtet werden.

2. Sicherheit

Du solltest sicherstellen das nur Benutzer das Plugin aktiv beinflussen können, die schreibrecht auf die Seite haben.

Beispiel für einen Code zur zugansbeschränkung
code for restricting access

3. Parameter

Die Action bekommt die Parameter in einem Array.
""{{pluginname testparam1="bla!!" testparam2="foobla"}}""

resultiert in:
$param(['testparam1'] => ''bla!!" ['testparam2'] => "foobla")


Parameter Verarbeitungsbeispiel

code for getting params

4.

Beschriftung einer Action im Quellcode
/*
 * Title:
 * COFFEE
 *
 * Source:
 * actions/coffee.php
 *
 * Description:
 * This action prepares a cup of great coffee every morning at 7:00 am
 *
 * Usage:
 * {{coffee sugar="value"}}
 *
 * Parameters:
 * sugar (int): specifies the number of spoonfuls of sugar. No value produces black coffee without sugar
 */

 // action code follows


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