Über die Seite Module im Administrationsinterface kann das Modulverzeichnis nach neuen Modulen durchsucht werden.

Transkript

1 papaya-version: 4.x Seite: 1 / 9 Zusatzmodule für papaya CMS schreiben In papaya CMS gibt es verschiedene Stellen, an welchen Zusatzmodule einklinkt werden können. Diese Zusatzmodule müssen von bestimmten Superklassen abgeleitet werden. Sie werden zu einem Modulgruppe zusammengefaßt und in einem eigenen Verzeichnis unterhalb von ~/papaya-lib/modules/ abgelegt. Typ Superklasse Datei Modul page base_content base_content.php Inhaltsmodul Seite box base_actionbox base_actionbox.php Inhaltsmodul Box admin base_module base_module.php Administrationsseite cron base_cronjob base_cronjob.php Cronjob-Aktion time base_crontime base_crontime.php Zeitberechnung event base_eventbox base_eventbox.php Inhaltsmodul Veranstalungskalender Über die Seite Module im Administrationsinterface kann das Modulverzeichnis nach neuen Modulen durchsucht werden. modules.xml In jeder Modulgruppe muss eine Datei modules.xml enthalten sein. Sie definiert die enthaltenen Module und benötigten Tabellen. <?xml version="1.0"?> <modulegroup> <name>modulegruppe</name> <description>beispiel für eine Modulgruppe</description> <modules> <module type="box" guid="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" name="name des Boxmodules" class="actionbox_boxmodul" file="actbox_boxmodul.php">beispielmodul für eine Box</module> <module type="page" guid="yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy" name="name des Seitenmodules" class="content_seitenmodul" file="content_seitenmodul.php">beispielmodul für eine Box</module> <module type="admin" guid="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" name="name der Administrationsseite" class="edmodule_adminseite" file="edmodule_adminseite.php" glyph="icon.gif">beispielmodul für eine Administrationsseite</module> </modules> <tables> <table name="tabelle1"/> <table name="tabelle2"/> </tables> </modulegroup>

2 papaya-version: 4.x Seite: 2 / 9 Attribute des module-tags type Der Modultyp wird mit dem Attribut type angegeben. guid Über die guid wird das Modul im System verwaltet. Dies ermöglicht später ein Verschieben und Umbenennen der Klasse und vermeidet Konflikte. Als Wert wird eine 32stellige Folge von Buchstaben und Ziffern erwartet. Sie können beispielsweise einen mit md5() verschlüsselten Zufallswert verwenden, wie er auch als Session-Id bei PHP zum Einsatz kommt. name Unter dem name wird das Modul im Administrationsoberfläche angezeigt. Dieser Wert kann dort auch geändert werden. class und file Geben an welche Klasse genutzt werden soll und welche Datei dafür geladen werden muss. glyph Ein Icon für den Button des Administrationsoberfläche können sie mit dem Attribut glyph festlegen. Die Angabe ist jedoch optional. Tabellen für Zusatzmodule Über den Tag tables können Sie auch Tabellen angeben, welche in den Modulen benötigt werden. Die einzelnen Tabellenstukturen werden im Unterverzeichnis DATA als XML-Dateien abgelegt.

3 papaya-version: 4.x Seite: 3 / 9 Zusatzmodule erstellen Um ein Zusatzmodul zu erstellen, müssen sie zuerst die Datei mit der Superklasse einbinden. Dann leiten Sie von der entsprechenden Superklasse das neue Modul ab. <?php require_once(papaya_include_path.'system/base_content.php'); class content_seitenmodul extends base_content { var $editfields = array( 'title'=>array ('Title', 'isnohtml', true, 'input', 200, ''), 'text', 'nl2br'=>array ('Automatic linebreaks', 'isnum', true, 'combo', array(0=>'yes', 1=>'No'), 'Apply linebreaks from input to the HTML output.'), 'teaser'=>array ('Teaser', 'issometext', false, 'simplerichtext', 6), 'text'=>array ('Text', 'issometext', false, 'richtext', 10), ); function getparseddata() { $result = sprintf('<title>%s</title>'."\n", $this->getxhtmlstring(@$this->data['title'])); $result.= sprintf("<text>%s</text>", $this->getxhtmlstring(@$this->data['text'],!((bool)@$this->data['nl2br']))); return $result; function getparsedteaser() { $result = sprintf('<subtopic no="%s" href="%s" module="%s" guid="%s" printhref="%s" author="%s">'."\r\n", $this->topic_obj->topic_id, $this->getweblink((int)$this->topic_obj->topic_id, 'page', NULL, NULL, $this->topic_obj->topic_title), get_class($this), $this->guid, $this->topic_obj->getprintviewurl(), htmlspecialchars($this->topic_obj->author_name)); $result.= sprintf('<title>%s</title>'."\n", $this->getxhtmlstring(@$this->data['title'])); $result.= sprintf('<subtitle>%s</subtitle>'."\n", $this->getxhtmlstring(@$this->data['subtitle'])); $result.= sprintf('<text>%s</text>'."\n", $this->getxhtmlstring(@$this->data['teaser'], true)); $result.= '</subtopic>'."\r\n"; return $result;?>

4 papaya-version: 4.x Seite: 4 / 9 Das Array $editfields Über die Klassenvariable $editfields können Sie recht einfach die notwendigen Datenfelder für das Eingabeformular definieren. Alternativ ist es möglich die entsprechenden Funktionen der Basisklasse zu überschreiben, um ein eigenes Eingabeformular zu erstellen. Der Schlüssel definiert den Namen des Feldes. Unter diesem ist das Feld dann in $this->data zu finden. Die einzelnen Eigenschaften der Feldes werden als einfache Liste angegeben. Elemente der Eingabefelddefinition: Index Optional Standardwert Typ Beschreibung 0 nein string Titel / Aufschrift 1 nein string Prüffunktion aus sys_checkit.php oder PCRE- Pattern 2 nein boolean Eingabe ist Pflichfeld 3 nein string Typ des Eingabefeldes 4 ja null mixed Parameter für Eingabeld (Maximale Länge, Werte-Hash, Zeilen) 5 ja string Quickinfo 6 ja mixed Vorgabewert 7 Ja right string Ausrichtung

5 papaya-version: 4.x Seite: 5 / 9 Mögliche Eingabefelder: Typ Beschreibung Parameter Parametertyp info Informationstext input Einzeilige Texteingabe Maximale Zeichenanzahl integer password Einzeilige Texteingabe (maskiert) Maximale Zeichenanzahl integer textarea Mehrzeilige Texteingabe Zeilenanzahl integer richtext Richtext-Eingabe Zeilenanzahl integer simplerichtext Richtext-Eingabe mit vereinfachten Toolbars file Dateiauswahl für Upload checkbox Checkbox yesno Ja/Nein Radiobuttons combo Auswahlbox Elemente array filecombo Auswahlbox für Dateien in einem Verezeichnis Pfad und Filter (PCRE- Pattern) array(path, filter) dircombo function Deaktivierte Eingabefelder Auswahlbox für Unterverzeichnisse in einem Verezeichnis Eingabefeld wird über eine Callback- Funktion erzeugt. Pfad und Filter (PCRE- Pattern) Methodenname array(path, filter) string Stellt man dem Typ den Prefix disabled_ vorhanden, wird das Eingabefeld für den Browser deaktiviert. Es bleibt dem Browser überlassen, dieses Attribut zu beachten. Der Richtext-Editor Die beiden Richtext-Eingabefelder unterscheiden sich nur in den Toolbars. Wenn der Editor deaktiviert wurde oder nicht im Brower des Benutzers verwendet werden kann, tritt ein Textarea an seine Stelle. Beim Aktivieren des Richtext-Editors sucht das System nach dem Eingabefeld nl2br dieses wird auf FALSE gestellt und ausgeblendet, da der Editor diese Aufgabe übernimmt.

6 papaya-version: 4.x Seite: 6 / 9 Individuelle Eingabefelder function Über den Eingabetyp function können Sie komplett eigene Eingabefelder definieren. Das Dialogobjekt ruft dazu eine Methode in dem Objekt auf, welches es instanziert hat. <?php function getpermscombo($name, $field, $data) { //code?> Die Auswahl eines Surferrechtes ist auf diese Weise gelöst. Sie ist als Methode getpermscombo in der Klasse base_plugin implementiert. Daher können alle Module direkt darauf zugreifen. In Klassen, welche von base_db abgeleitet wurden, ist sie jedoch nicht direkt verfügbar. Die Funktion muss drei Parameter entgegennehmen. $name ist der Name des Feldes, $field entspricht dem Definitionsarray und $data enthält den aktuellen Wert. Als Rückgabe wird ein XML- String erwartet. Inhaltsmodul Seite getparseddata() Die Methode getparseddata() erzeugt die Hauptausgabe des Moduls als XML. Das XML muss nur gültig sein (Root-Tag wird durch das System hinzugefügt). Wenn man sich bei der Struktur am XML bestehender Moduleorientiert, erleichtert dies die Wiederverwendung von XSLT-Templates. getparsedteaser() Einige Module wie zb die Kategorie instanzieren Seiten und rufen die Methode getparsedteaser() auf, um einen Kurztext anzuzeigen.damit diese Module die Daten auch verarbeiten können, muss das zurückgegebene XML einer bestimmten Struktur entsprechen: <subtopic no="seiten-id" href="link" module="modulklasse" guid="guid der Moduleklasse" printhref="drucklink" author="author"> <title>titel</title> <subtitle>untertitel</subtitle> <text>kurztext</text> </subtopic> Sie können dieses XML erweitern, müssen dann jedoch die XSLT-Templates entsprechend anpassen.

7 papaya-version: 4.x Seite: 7 / 9 Inhaltsmodul Box $preview Mit der Eigenschaft $preview geben Sie an, ob für die Box eine Vorschau ohne Seite möglich ist. In diesem Fall kann getparseddata() nicht auf die Variable $this->topic_obj (die aktuelle Seite) zugreifen. getparseddata() Im Gegensatz zu Inhaltsmodulen für Seiten gibt diese Funktion bei Boxen im Normalfall fertiges (X)HTML für die Ausgabe zurück. Boxen werden separat von den Seiten mit eigenen Templates geparst, damit die Seitenvorlagen nicht die Regeln für alle Boxen laden müssen und es möglich ist die Ausgaben der Boxen separat zwichenzuspeichern. parsexml($xslfile, $xml) Die Methode parsexml() kann innerhalb von getparseddata() aufgerufen werden um ein XML mit einer XSL-Datei zu transformieren.die Methode reagiert auf die Anforderung der XML-Ausgabe durch den Benutzer. Als Parameter wird die XSL-Datei erwartet, welche im Unterverzeichnis boxes des Ausgewählten Template-Sets liegen muss und das XML als String. Administrationsseite Module für Administrationsseiten verfügen nicht über die Fähigkeit aus dem Array $editfields direkt ein Formular zu erzeugen, da sie eine komplette Seite im Administrationsinterface darstellen. Sie erhalten über Variablen direkten Zugriff auf das System. Variable $this->images $this->msgs $this->auth_user $this->layout Beschreibung Array mit Bildnamen aus inc.glyph.php Nachrichten für den Benutzer wird über $this->addmsg(level, nachricht) gefüllt. Angemeldeter Benutzer Ausgabe $permissions Mit dem Array $permissions können Sie Rechte definieren, welche in die normale Rechteverwaltung eingebunden werden. Benutzer müssen über das Recht mit dem Index 1 verfügen, um den Button zu sehen. Über die Methode hasperm(id, show_error) können Sie abfragen, ob der angemeldete Benutzer über das Recht verfügt.

8 papaya-version: 4.x Seite: 8 / 9 execmodule() Die Methode execmodule() wird vom System aufgerufen um die Administrationsseite zu erzeugen. Da das Objekt selbst keinen Datenbankzugriff hat, müssen Sie dafür eine von base_db abgeleitete Klasse instanzieren. <?php function execmodule() { if ($this->hasperm(1, true)) { $path = dirname( FILE ); include_once($path.'/beispieladminobjekt.php'); $adminobj = &new beispieladminobjekt; $adminobj->module = &$this; $adminobj->images = &$this->images; $adminobj->msgs = &$this->msgs; $adminobj->layout = &$this->layout; $adminobj->auth_user = &$this->auth_user; $adminobj->initialize(); $adminobj->execute(); $adminobj->getxml();?> Cronjob-Aktion Über cronjob-module können Sie Aufgaben definieren, welche zeitgesteuert ausgeführt werden. Dazu gehört z.b. das Veröffentlichen von Seiten. Das Verhalten wird über zwei Methoden bestimmt. Die Methode checkexecparams() sollte die Vollständigkeit der Daten prüfen. Damit wird vor dem Aktivieren des Benutzers sichergestellt, dass die Aufgabe ausgeführt werden kann. Mit der zweiten Methode execute() wird für die Ausführung der Aufgabe aufgerufen. Zeitberechungsmodule Diese Module werden bisher an zwei Stellen im System genutzt. Bei den Cronjobs und für regelmäßige Termine im Veranstaltungskalender. Das System ruft die Methode getnextdatetime() mit einem Datum auf, um den nächsten Zeitpunkt ermitteln zu können. Sowohl Parameter wie auch Rückgabe sind Unix- Timestamps. Inhaltsmodul Veranstalungskalender Die Inhaltsmodule im Veranstaltungskalenderermöglichen individuellere Daten für einzelne Termine. Sie stellen die Methoden getparsedteaser() für Übersichtsseiten mit mehreren Terminen und getparseddata() für die Anzeige einzelner Termine zur Verfügung. Die Rückgabe beider Funktionen muss gültiges XML sein.

9 papaya-version: 4.x Seite: 9 / 9 <?php function getparseddata() { return '<text><![cdata['.@$this->data['text'].']]></text>';?> function getparsedteaser() { return '<text><![cdata['.@$this->data['text'].']]></text>';