Die Joomla!-API ist die Schnittstelle, die Joomla! den Programmierern von Erweiterungen zur Verfügung stellt. Sie umfasst eine Vielzahl von Klassen und Funktionen und ist so umfangreich, dass sie allein ein ganzes Buch füllen würde. Wir wollen Ihnen im Folgenden die wichtigsten Bestandteile vorstellen.
Wenn Ihr Skript innerhalb des Joomla!-Frameworks ausgeführt wird, sind viele Funktionen des Systems verfügbar. Hier ist eine Auswahl. Die Funktionen, die in Joomla 1.1 veraltet sind, sind angegeben.
Tabelle A.1 Funktionen im Joomla!-Framework
| Funktion
|
Beschreibung
|
| initEditor()
|
Nimmt den Code des WYSIWYG-Editors mit in die Seite auf.
Joomla 1.1: JEditor::init
|
| mosCountModules
([string $position])
|
Gibt die Anzahl der Module an einer Position aus.
$position. Name der Position, für die die Module gezählt werden sollen. Standardwert ist left.
|
| mosErrorAlert
(mixed $text)
|
Gibt eine Fehlermeldung aus.
$text. Text, der ausgeben werden soll.
Joomla 1.1: josErrorAlert
|
| mosFormatDate(
string $date,
[string $format])
|
Gibt entsprechend der lokalen Einstellungen die formatierte Version eines Datumsstrings aus.
$date. Datum im datetime-Format.
$format. Formatierungsstring.
|
| mosGetParam(
array &$arr,
string $name,
[mixed $default],
[int $mask ])
|
Holt den Wert eines Übergabeparameters ab. Dabei werden HTML-Tags und Leerzeichen am Anfang und Ende entfernt.
$arr. PHP-Variable, von der die Übergabe abgeholt werden soll. Beispiele sind $_GET, $_POST oder $_COOKIE.
$name. Name des Parameters.
$default. Vorgabewert, wenn der Parameter nicht gefunden wurde.
$mask. Schaltet die Filter aus. Gültige Werte sind: _MOS_ALLOWHTML: Lässt Tags zu. _MOS_NOTRIM: Lässt Leerzeichen zu. _MOS_ALLOWRAW: Keine Filterung.
|
| mosLoadModules(
[string $position],
[int $style])
|
Lädt die Module für eine angegebene Position.
$position. Name der Position.
$style. Gibt an, wie die Module ausgegeben werden:
0: übereinander in Tabelle
1: nebeneinander in Tabelle
–1: unformatiert
–2: in einzelnen <div>-Tags
–3: in dreifachen <div>-Tags für abgerundete Ecken
|
| mosMainBody()
|
Gibt den Inhalt des Contentbereichs aus.
|
| mosMail (
string $from,
string $fromname,
string $recipient,
string $subject,
string $body)
|
Versendet eine E-Mail über den phpMailer.
$from. E-Mail-Adresse des Absenders.
$fromname. Name des Absenders.
$recipient. E-Mail-Adresse des Empfängers. Hier kann auch ein Array mit Adressen übergeben werden.
$subject. Betreff der Mail.
$body. Inhalt der Mail.
Joomla 1.1: josMail
|
| mosNotAuth()
|
Gibt die Meldung aus, dass der Benutzer diesen Bereich nicht sehen darf.
|
| mosPathWay()
|
Gibt den Klickpfad aus.
Joomla 1.1: mosLoadModule('breadcrumbs');
|
| mosReadDirectory
(string $path)
|
Liest die Dateien aus einem Verzeichnis.
$path. Der relative Pfad des Verzeichnisses.
Joomla 1.1: JFolder::files oder JFolder::folders
|
| mosRedirect
(string $url)
|
Weiterleitung auf eine andere Seite.
$url. Zieladresse.
Joomla 1.1: josRedirect
|
| mosShowHead()
|
Gibt den HTML-Head-Bereich aus.
|
| mosToolTip(
string $tooltip,
[string $title],
[int $width],
[string $image],
[string $text],
[string $href],
[boolean $link])
|
Gibt den HTML-Code für ein Tooltip und das zugehörige Icon aus. Die JavaScript-Bibliothek overlib_mini.js muss eingebunden sein.
$tooltip. Text der Anzeige.
$title. Text im Titelfeld.
$width. Breite des Tooltip.
$image. Icon, das angezeigt werden soll. Der Pfad muss relativ zu /includes/js/ThemeOffice sein. Wenn der Parameter $text einen Wert hat, wird kein Bild angezeigt.
$text. Text, der als Basis für das Tooltip dient.
$href. Adresse, die angezeigt werden soll, wenn auf die Tooltip-Basis geklickt wird.
$link. Gibt an, ob die Basis verlinkt werden soll.
|
| sefRelToAbs
(string $url)
|
Konvertiert eine URL in ein suchmaschinenfreundliches Format.
$url. Die Internet-Adresse, die konvertiert werden soll.
|
