PhPoint Module - Eigene Module erstellen

Aus OneNext Knowledge Base

Modmaker verwenden

Modmaker ist eine Kommandozeilenerweiterung zur einfacheren Erstellung von Modulen für phPoint. Es legt die Verzeichnisstruktur des Moduls und eine INI Datei mit benötigten Informationen an und wird folgendermaßen aufgerufen.

./phpoint module:create --name=Modulname

Anschließend öffnet sich eine interaktive Eingabeaufforderung. Folgende Werte werden dabei abgefragt:

Q: Author name [unknown]:
   Der Name des Autors (Standard = unknown)
Q: Pages (use * as wildcard): *
   Auf welchen Seiten soll das Modul geladen werden
Q: Version: *
   Version des Moduls (z.B.: 1.0.3)

Q: Revision [20111220]:
   Revision (Standard = Aktuelles Datum JahrMonatTag)
Q: Description: *
   Eine kurze Beschreibung des Moduls
Q: Compatibility [1.11.15]:
   Kompatibilität mit phPoint ab Version (Standard = Installierte Version)

Q: Javascripts (colon separated) [static/script.js]:
   Durch einen Doppelpunkt getrennte Javascript Dateien (Standard = static/script.js)
Q: Stylesheets (colon separated) [static/style.css]:
   Durch einen Doppelpunkt getrennte CSS Dateien (Standard = static/style.css)
Q: Template:
   Das Haupttemplate (meist HTML) des Moduls (Bei fehlendem Wert wird nur die PHP Logik ausgeführt, wenn vorhanden)

Q: Pre include:
   Die PHP Datei die vor dem Rendern der Seite eingebunden werden soll
Q: Main include:
   Die PHP Datei die während des Renderns der Seite eingebunden werden soll
Q: Post include:
   Die PHP Datei die nach dem Rendern der Seite eingebunden werden soll

Alle Angaben in eckigen Klammern [] sind Standardwerte, die gesetzt werden wenn sie keinen Wert angeben. Angaben die mit einem Asterisk * gekennzeichnet sind, sind Pflichtangaben! In der Abfrage "Pages", können sie ein Asterisk * auch als Wildcard verwenden. Das Modul wird dann in allen aufgerufenen Seiten eingebunden.

Die INI Datei kann nachträglich manuell in einem Editor angepasst werden. Achtung! Ab phPoint Version 1.12.0 werden INI Dateien gecached. Nach einer Änderung muss der phPoint Cache manuell geleert werden. Dies funktioniert entweder über die Kommandozeile mit folgendem Befehl:

./phpoint cache:cleanup --ext=ini,conf

oder über das Backend im Startbereich: Dashboard => Status => Compiled config

Module entfernen

Einmal angelegte Module lassen sich natürlich auch wieder entfernen. Modmaker wird dazu mit dem Parameter -r und dem Namen des Moduls aufgerufen.

./phpoint module:remove --name=Modulname

Sie werden gefragt, ob sie das Modul wirklich entfernen möchten. Bestätigen sie die Frage mit y wenn sie sicher sind.

Q: Sure? [y/n]: y
I: Module Modulname removed