Wikka Documentation : ActionInfoDE

HomePage :: Index :: RecentChanges :: Search :: Login/Register

Wie Actions aufgebaut sind und eigene geschrieben werden können

ACHTUNG: Diese Seite ist fast vollständig
Siehe auch
Übersicht über die Deutsche Dokumentation
- Actions in Seiten einbinden (ENG)
- Übersicht über zusätzliche Actions (ENG)
- Wikka Developer Portal(ENG)


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

Als erstes solltest Du dir überlegen was du genau machen willst und ob Du dies mit einer Action verwirklichen kannst.

Action vs. Handler
Eine Action ist nur sinnvoll wen du etwas innerhalb einer Seite machen willst ohne einfluss auf den eigentlichen Inhalt der Seite(googleform, Kalender).
Wenn Du aber Z.b. eine PDF ausgabe, cloning oder ähnliches machen willst solltest du ein handler programmieren.

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 Category_Development 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 PluginsInDevelopment 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
echo "Hier fehlt noch der Beispielcode";



3. Parameter

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

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


Parameter Verarbeitungsbeispiel

echo "Hier fehlt noch der Beispielcode";


4. Dokumentation/Programmierstil

1. 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

2. SQL Abfragen
Viele Actions benötigen eine eigene Tabelle in der SQL Datenbank.
Die SQL-Befehle zum erstellen dieser Tabelle solten im Quelltext-Kopf sichtbar als Kommentar zu sehen sein.

5. Installation

Nachdem der Benutzer die SQL-Befehle ausgführt hat und das php-file ins Action-Verzeicniss kopiert, sollte eine Action funktionieren.

6. Weiter Informationen

Wikka Developer Portal
- Wikka API Beschreibung (ENG)


CategoryDE
There are no comments on this page.
Creative Common Attribution-ShareAlike License
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.0159 seconds