Hinweise zu Templates - Variablen, Konstanten, Funktionen
Für die Gestaltung von Designvorlagen ist es wichtig zu wissen, welche benutzbaren Variablen und Funktionen es gibt und was diese bewirken. Nachfolgend werden alle verfügbaren Variablen und Funktionen beschrieben, die in einer index.php der Designvorlage vorkommen können.
Wichtige Variablen bzw. Konstanten
Normalerweise reicht es, in einer Vorlage Konstanten und Funktionen zu verwenden, aber auch Variablen bzw. Arrays sind möglich. So können alle Variablen der System-Sprachdatei in einer Vorlage integriert werden (z.B. $TEXT['MENU'] könnte als Überschrift für ein Menü-Block stehen).
| Konstanten | Beschreibung |
|---|---|
| LANGUAGE | Aktuelle Sprache |
| DEFAULT_CHARSET | Aktueller Zeichensatz |
| TEMPLATE_DIR | Verzeichnis der aktuellen Vorlage |
| BC_URL | Relatives Root-Verzeichnis von BelCal |
| FRONTEND_LOGIN | Abfrage der Option, ob Anmeldung (Admins) ein- oder ausgeschaltet (true/false) |
| FRONTEND_ACCESS | Abfrage der Option ab Version 2.72, ob Anmeldung (Benutzer) ein- oder ausgeschaltet (true/false) |
| SHOW_MENU | Abfrage der Option, ob mehrere Menüs ein- oder ausgeschaltet (wenn ja, wird Menü immer angezeigt, sonst erst ab 2. Objekt) - PROFI-Version |
| SITE_TITLE | Seitentitel für gesamtes Projekt aus Optionen* |
| SITE_HEADER | Projekt-Kopfzeile aus Optionen* |
| SITE_DESCRIPTION | Projekt-Beschreibung für Suchmaschinen aus Optionen* |
| SITE_KEYWORDS | Projekt-Keywords für Suchmaschinen aus Optionen* |
| OBJECT_TITLE | Titel des aktuellen Objektes* |
| MENU_TITLE | Aktuell aufgerufener Menü-Punkt* |
* Mit diesem Zeichen gekennzeichnete Konstanten werden besser über Funktionen verwendet.
Wichitge Funktionen für Vorlagen
- object_title('spacer','template')
Es wird eine Zeile template erzeugt und dargestellt, die spacer als Trennzeichen verwendet.
Beispiel: object_title('-','[SITE_TITLE][SPACER][OBJECT_TITLE]') erzeugt die Zeile "Projekttitel-Objekttitel" (Standardeinstellung ohne Parameter).
Verwendet werden können SITE_TITLE, OBJECT_TITLE, MENU_TITLE. - object_description() / object_keywords()
Diese Funktionen erzeugen die Beschreibung bzw. Keywords für Suchmaschienen. Dabei werden Daten aus Objekten verwendet, wenn diese erfasst sind, sonst die Daten aus den Optionen (SITE_DESCRIPTION und SITE_KEYWORDS). - object_header('datumsformat') / object_footer('datumsformat')
Es wird die Kopf- bzw. Fußzeile aus Optionen erzeugt und dargestellt, wobei "datumsformat" nur benötigt wird, wenn unter Optionen die Variable [YEAR] (aktuelles Datum) verwendet wurde. Als Stndard-Format ist 'Y' für vierstellige Jahreszahl eingestellt. - show_menu(parameter)
Diese Funktion erzeugt das Menü. Zu den Parametern siehe unter Menü-Formatierungen. Ohne Parameter werden die Standard-Parameter verwendet, die für eine einfache Darstellung ausreichend sind. - object_content(block)
Anzeige der Abschnitte eines Objektes. Für block wird die Nummer laut Template verwendet, standardmäßig ist block=1 (Haupt-Content). Blöcke sind nur in der PFOFI-Version verfügbar. - show_login_form(type, redirect, nl)
Es wird ein Anmeldeformular erzeugt und dargestellt.
Beispiel: show_login_form('users') erzeugt ein Anmeldeformular für registrierte Benutzer im Frontend. Als type kann 'users', 'admins' oder 'guests' verwendet werden. Für redirect gilt ein angegebener Link zu einem Objekt (Standard ist aktuelles Objekt). Das nl steht für newline und bedeutet, dass die Eingabefelder untereinander stehen (Standard). Verwendet werden können hier '<br />', '<hr />' oder für Felder nicht untereinander ' '. Um dieses Login-Formular benutzen zu können, muss die Anmeldung in den Optionen eingeschaltet sein. - register_frontend_modfiles('css') / register_frontend_modfiles('js') / register_frontend_modfiles('jquery')
Mit dieser Funktion werden die Dateien frontend.css bzw. frontend.js aus Modulen eingelesen, wenn diese vorhanden sind. Außerdem wird ein Patch für die Anzeige von Transparenz bei png-Grafiken für den IE < 7 damit integriert. Wird eine dieser Funktionen nicht angegeben, so können die dazugehörigen Funktionen nicht verwendet werden.