RSS
Githubeinfaches PHP Plugin System
Aug 18
Plugin Systeme, sie sind viel gefragt in der heutigen Zeit, jeder will seinen Code schön erweiterbar haben, doch viele haben entweder gar keinen Schimmer wie sie das am besten machen oder sie setzten es teils auf unglaubliche Weise um. Ich habe schon die verrücktesten Kostruktionen gesehen, die Code aus Datenbanken lesen oder wie die phpBB Jungs, die einen ganzen Parser geschrieben haben, der Core Dateien Modifiziert, um an bestimmten Stellen eigenen Code ausführen zu können. Für mich ist das alles Humbug, ein Plugin System muss flexibel und performant sein und nicht zuletzt sollte das ganze so umgesetzt werden, dass vom Benutzer selbst keinerlei Änderung am Code durchgeführt werden muss um ein Plugin einzubauen/zu laden.
Dem habe ich mir angenomen, und zwar habe ein an meinem SimpleLD Framework angelehntes Plugin System (bzw. eine Klasse) geschrieben, die alle aufgezählten Punkte vereint. Folgende Funktionen hat das ganze:
- Überall einsetzbar – Es ist lediglich eine Klasse, welche in jedem PHP Projekt verwendet werde kann
- Sie erlaubt es Code an vorher definierten Stellen im eigenem Programm einzuhängen und auszuführen. (mittels Hooks dt. Haken)
- Die Plugins können ohne Programmier Kentnisse vom Benutzer einfach “installiert” werden. Denn dazu muss lediglich eine Klasse in ein vordefiniertes Verzeichnis kopiert werden.
(Für die Ungeduldigen, hier gehts zum Github Repo: PHP-Plugin-System @ Github)
Durch die geringe Anzahl an Code Zeilen (rund 100 mit Kommentaren) arbeitet das ganze System Performant. Allerdings wird es je nach Anzahl installierter Plugins langsamer, das kann aber durch einen Cache (siehe SimpleLD Framework) umgangen werden.
Wie funktioniert das ganze?
Die Funktionsweise ist ganz simpel. Plugins bestehen aus ganz normalen Klassen mit public Methoden, welche sich alle in einem von ihnen bestimmten Verzeichnis befinden. Von dort liest das Plugin System alle Klassen ein und speichert Methoden als sogenannte Hooks (dt. Haken) in einem Array. Falls im Code ein solcher Hook aufgerufen wird, werden alle Plugins mit einer passenden Methode herausgesucht und aufgerufen.
Praktisches Beispiel
Plugin Klasse (sample.php)
class sample { public function helloWorld() { echo "Hello World!"; } }
Wichtig: Die Klasse muss exakt so wie die Datei benannt werden! Alle Methoden ohne beginnendes _ werden als Hooks verwendet!
Datei in der das Plugin verwendet wird (index.php)
// laden des Plugin Systems include('plugins.class.php'); // starten des Systems mit Übergabe des Plugin Verzeichnisses plugins::start('plugin/ordner/'); // nun können wir einen Hook aufrufen plugins::call('helloWorld'); // dann noch einen anderen plugins::call('foo');
Mit Parametern
Natürlich kann an Hooks auch Parameter übergeben werden. Dies geschieht in Form eines Arrays:
plugins::call('foo', array('Parameter 1', 'Parameter 2', 'Parameter 3'));
Die Methode des Plugin sieht dann folgendermaßen aus:
public function foo($parameter1, $parameter2, $parameter3) { // was auch immer wir tun möchten ... }
Dabei muss allerdings beachtet werden, dass die übergeben Parameter alle von der Methode entgegen genommen werden müssen, ansonsten bricht PHP mit einem Fehler ab.
Nimmt man Änderungen an der Parametern innerhalb des Hooks vor und will diese an den Orginal Code wieder “zurückgeben”, bzw mitteilen, setzt man einfach & vor die Variable:
$var = "foo"; plugins::call('foo', array(&$var)); // Inhalt nach Änderung durch den Hook foo echo $var;
Die Methode des Plugin sieht dann folgendermaßen aus:
public function foo(&$blub) { // hier können wir nun $blub ändern }
Source Code beziehen
Der Code kann hier mit Beispielen in meinem Git Repo heruntergeladen werden:
http://github.com/LinuxDoku/PHP-Plugin-System/
oder für die faulen unter uns der Direktlink
… ich bin der Direktlink zur Zip Datei …
Tipps’n Tricks
- Der Verzeichnis Parser liest die Plugins nach altbekannten Regeln des Alphabets (dem ABC
) ein, demzufolge werden Hooks, deren Plugin Namen z.B. mit A beginnen vor Hooks, deren Plugin Namen mit M beginnen ausgeführt. Sollte dies nicht gewünscht sein, kann man sich an der Methode “load” des System zu schaffen gemacht werden. - Beim Starten des System muss dem Plugin Ordnername immer ein Endendes / (Slash) mitgegeben werden!
- Es empfiehlt sich das System in einer Global verwendeten Datei zu Starten, da ansonsten ziemlich viele Ressourcen benötigt werden. Und ein mehrfacher Start unnötig ist.
Letzte Kommentare