Die API

Beitragsseiten

Das Interface

Um das Interface verwenden zu können, muss es zuvor in eure Erweiterung eingebunden und instanziert werden. Dies geschieht durch folgenden Codeabschnitt:

$file = JPATH_ROOT.DS.'components'.DS.'com_joomgallery'.DS.'interface.php';
if(!file_exists($file))
{
JError::raiseError(500, 'JoomGallery seems not to be installed');
}
else
{
require_once $file;
$interface = new JoomInterface();
}

Die Variable '$interface' enthält nun das Interface-Objekt der Galerie (sofern die JoomGallery installiert ist).

Jetzt könnt Ihr die Funktionen, die das Interface zur Verfügung stellt, in Eurer Erweiterung verwenden.
Ein Aufruf sieht zum Beispiel so aus:

$interface->getPageHeader();

oder falls etwas von der Funktion zurückgegeben wird, so:

$images = $interface->getPicsOfUser($userid);

Die Funktion 'getPageHeader' ist wichtig, falls Eure Erweiterung Bilder oder ähnliches ausgeben soll und ihr die Styledefinitionen der Galerie verwenden wollt, da sie die CSS-Dateien der JoomGallery einbindet.

Am besten Ihr seht euch die Interface-Datei einmal selbst an ('components/com_joomgallery/interface.php'), zu jeder Funktion darin sind Erklärungen im jeweiligen Header dazu vorhanden, was die Funktion macht, was sie eventuell zurückgibt und welche Parameter ihr übergeben werden müssen.

Hier sei nur noch die Funktion 'addConfig()' erwähnt, mit der Ihr Einstellungen des Interfaces vornehmen könnt, wie zum Beispiel mit welcher Art ein Bild geöffnet werden soll:

$interface->addConfig('openimage', 6);

Die Zahl 6 steht hier für die Slimbox, weitere Zuordnungen findet Ihr in folgender Liste:

0 => Normale Ansicht
1 => Neues Fenster
2 => JavaScript Fenster
3 => DHTML - Container
5 => Thickbox3
6 => Slimbox
12 => zusätzlich installierte Plugins

Falls 'openimage' nicht gesetzt wird, verwendet das Interface die entsprechende Einstellung des Konfigurationsmanagers der Galerie ('Öffnen der Detailansicht' im Tab 'Kategorie-Ansicht' -> 'Generelle Einstellungen').

Weitere Optionen sind zum Beispiel 'group', 'limit' oder 'type'.

Joomla!®

Joomla! ist freie, unter der GNU/GPL-Lizenz veröffentlichte Software. Der Name Joomla! und das Logo werden unter einer limitierten Lizenz durch Open Source Matters als Rechteinhaber in den USA und anderen Staaten vergeben. Joom::Gallery ist weder Mitglied noch Teil des Joomla!-Projekts oder von Open Source Matters.