Zwingend notwendige Dateien (alle Modularten)

info.php

Die info.php muss angelegt werden und enthält Informationen über Speicherort (Modulverzeichnis), Modulart (Snippet, Admin-Tool oder Seitenmodul), Autor, Beschreibung, Lizenz und ggf. weitere Angaben.

Muster für eine info.php:


<?php
/**
  Copyright (C) 2007,
 Christian Sommer 
  This module is free software. You can redistribute it and/or modify it under
  the terms of the GNU General Public License - version 2 or later,  as published
  by the Free Software Foundation: http://www.gnu.org/licenses/gpl.html.
  This module is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
  GNU General Public License for more details.
 -------------------------------------------------------------------------------
  Modul: XXX für WBCE v1.0.x (http://www.wbce.org)
  Modulbeschreibung
 -------------------------------------------------------------------------------
   v0.10  (Christian Sommer; 11.06.2007)
    + initial release of the module
 -------------------------------------------------------------------------------
**/
$module_directory     = 'gewünschtes Modulverzeichnis angeben';
$module_name          = 'Modulname angeben (wird als Seitenart angezeigt)';
$module_function      = 'page, tool oder snippet';
$module_version       = '0.10';
$module_platform      = '1.0.0';
$module_author        = 'Christian Sommer';
$module_license       = 'GNU General Public License';
$module_description   = 'Kurzbeschreibung des Moduls';
?>

Nach dem öffnenden PHP-Tag (<?php) folgt ein mehrzeiliger Kommentarblock (/** ... **/) mit optionalen Angaben zur gewählten Lizenz, einer Haftungsausschlussklausel und der Entwicklungshistorie. Über die Variablen werden Informationen über das Modul bereitgestellt (siehe Beschreibung). Die Variable $module_function legt fest, ob das Modul als Seitenmodul (page), Verwaltungsprogramm (tool) oder Zusatzfunktion (snippet) ausgeführt werden soll. Die info.php endet mit einem schließendem PHP-Tag (?>).

index.php

Diese Datei verhindert, dass bei ungünstiger Konfiguration des Servers die Dateien und Verzeichnisse innerhalb des Modulverzeichnisses im Browser dargestellt werden,  verhindert also das Aufspüren möglicher Angriffsstellen. Sie beinhaltet nicht mehr als folgende Anweisung:

<?php header('Location: ../index.php'); ?>
install.php

Wird aufgerufen, wenn der Benutzer das Installations-Zip bei Erweiterungen - Module hochlädt und auf "Installieren" klickt und das Modul noch nicht existiert. Nützlich, um z.B. Datenbankentabellen anzulegen oder Dateien zu kopieren.

upgrade.php

Wird aufgerufen, wenn der Benutzer das Installations-Zip bei Erweiterungen - Module hochlädt und auf "Installieren" klickt und das Modul bereits existiert. Nützlich, um z.B. einen Wert zur existierenden Datenbank hinzuzufügen, Dateien auszutauschen...

uninstall.php

Wird beim Deinstallieren über das Backend aufgerufen. Sollte für das Löschen eventuell vom Modul angelegter Datenbanktabellen verwendet werden.