Server-Module erstellen

Aus sourceDESK Wiki
Wechseln zu: Navigation, Suche

Um Hosting-Produkte automatisch einzurichten, können Sie auch eigene Server-Module schreiben.

Dateistruktur

Ein Server-Modul bekommt ein eigenes Verzeichnis unter modules/provisioning. In diesem Verzeichnis muss sich eine PHP-Datei mit dem gleichen Namen wie das Verzeichnis und der Endung .php befinden. In dieser PHP-Datei wird eine Klasse definiert, die von der Klasse Provisioning erbt.

Attribute

Es werden mehrere Attribute innerhalb der erstellten Klasse benötigt, die höchstens protected sein dürfen:

  • $name gibt einen Anzeigenamen für das Modul an
  • $short gibt den Kurznamen des Moduls an, das entspricht dem Verzeichnis- bzw. Dateinamen

Konfiguration

Es wird eine Methode Config($id, $product = true) benötigt, diese bekommt eine Produkt-ID ($product = true) oder Vertrags-ID ($product = false) als Argument. Hier können Sie Form-Elemente erstellen. Bitte geben Sie Eingabefelder die CSS-Klasse prov-settings und ein Attribut data-setting mit dem Kurznamen der Einstellung, damit die Daten per Ajax übernommen werden können.

Beispiel:

<input type="text" data-setting="domain" value="<?=$this->getOption("domain");?>" placeholder="sourceway.de" class="form-control prov_settings" />

Sie können auch die Server-Verbindung prüfen lassen oder Daten vom Server abrufen - Beispiele hierzu finden Sie in den verschiedenen mitgelieferten Server-Modulen.

Vertrag erstellen

Sie benötigen eine Methode Create($id). Diese erhält die ID des Vertrages als Argument und soll den Vertrag einrichten. Zunächst sollten Sie $this->loadOptions($id) ausführen, um die Vertragsdetails zu laden. Wenn Sie die Kundendaten benötigen, können Sie mit $u = $this->getClient($id) eine Instanz der Klasse User abrufen.

Ein Zugriff auf Modul-Einstellungen ist mit $this->getOption("SHORT_NAME") möglich. Als Rückgabe der Funktion wird ein zweidimensionales Array erwartet. Im Erfolgsfall enthält das Array an erster Stelle true und an zweiter Stelle ein Array mit Vertragsdetails. Im Fehlerfall muss an erster Stelle false und an zweiter Stelle eine Fehlermeldung als String stehen.

Vertrag löschen

Wenn Sie die Löschung eines bestehenden Vertrages ebenfalls in sourceDESK integrieren möchten, können Sie die Methode Delete($id) implementieren. Diese muss ein Array zurückgeben, das im Erfolgsfall ein Element - true - besitzt und im Fehlerfall ein Element false sowie einen Fehlerstring als zweites Element zurückgibt.

Vertrag sperren / entsperren

Über die Methoden Suspend($id) und Unsuspend($id) können Sie Verträge direkt aus sourceDESK sperren oder wieder entsperren. Die Rückgabe wird wie bei der Löschung eines Vertrages erwartet.

Für Schnittstellen, die nur die Übergabe eines Status verlangen, also keine separaten Endpunkte für Sperrung und Entsperrung haben, können Sie wie folgt arbeiten:

public function Suspend($id, $status = 1) {
    $this->loadOptions($id);
    // ...
    return Array(true);
}
 
public function Unsuspend($id) {
    return $this->Suspend($id, 0);
}

Wichtig ist hierbei, dass der zweite Parameter von Suspend() einen Standard-Wert bekommt, da sourceDESK die Funktion ansonsten nicht aufrufen kann.

Paket wechseln

Über die Methode ChangePackage($id) können Sie einen Paketwechsel direkt aus sourceDESK initiieren. Nach Wechsel des Produktes können Sie so die Änderungen direkt an den Server übermitteln. Das Rückgabeformat entspricht dem der Lösch- und Sperr-Methoden.

Modul-Ausgabe

Sie können und sollten über die Methode Output($id, $task = "") HTML-Code zurückgeben, der im Kundenbereich und in der Administration angezeigt wird. Diese Methode behandelt auch den Aufruf Ihrer eigenen Aktionen, dann ist das Argument $task mit der entsprechenden Aktion gefüllt.

E-Mailvariablen

...

Eigene Funktionen

...

API-Integration

...

Beispiel-Code

...