Typepress - Funktionsreferenz

Die nachfolgende Übersicht erläutert Ihnen alle Funktionen, die Sie für die Erstellung des Layouts Ihres Internetauftrittes benutzen können:

Für Typepress ab der Version 1.6.2 gültig

Content

Syntax:string Content ([integer $id])
Beschreibung:Anzeige des Inhaltes einer Webseite
Parameter:id → ID der Webseite (optional, Standard = aktuelle ID)
Rückgabewert:Anzeige des Inhalt der Webseite
Beispiel:echo $TP->Content();
echo $TP->Content(1);

Id

Syntax:void Id (integer $id)
Beschreibung:ID der aktuellen Webseite setzen
Hinweis:Diese Funktion wird vor der Anzeige der aktuellen Webseite automatisch aufgerufen
Parameter:id → ID der Webseite
Rückgabewert:kein
Beispiel:$TP->Id($_GET["id"]);
$TP->Id(1);

LanguageMenu

Syntax:string LanguageMenu ([array $images])
Beschreibung:Anzeige des Sprachen-Menüs
Parameter:images → Assoziatives Array ("Sprache" => "Bild")
Rückgabewert:Menü
Beispiel:echo $TP->LanguageMenu();
echo $TP->LanguageMenu(array(
"en" => "layout/".$TP->Layout()."/images/icon_en_16x16.png",
"de" => "layout/".$TP->Layout()."/images/icon_de_16x16.png"
 ));

Layout

Syntax:string Layout ()
Beschreibung:Pfad zum aktuellen Layout-Verzeichnis zurückgeben
Hinweis:Alle Layouts sind im Layout-Verzeichnis (../layout/) gespeichert
Parameter:kein
Rückgabewert:Layout-Verzeichnispfad
Beispiel:echo $TP->Layout()

LayoutName

Syntax:string LayoutName ()
Beschreibung:Name des aktuellen Layouts zurückgeben
Hinweis:Alle Layouts sind im Layout-Verzeichnis (../layout/) gespeichert
Parameter:kein
Rückgabewert:Layout-Name
Beispiel:echo $TP->LayoutName()

MenuIni

Syntax:void MenuIni (string $key, string $value)
Beschreibung:Menü intialisieren

Schlüssel und Werte:
class = CSS-Klassenname (Standard = "item")
expand = Alle Untermenüpunkte anzeigen (Standard = false)
extern = Anzeige des Menüs ohne Angabe von CSS-Klassen (Standard = false)
inline = Anzeige des Untermenüs (Standard = false)
separator = Trennzeichen (Standard = "")
Hinweis:Nach dem anschließenden Aufruf der Menu-Funktion wird die Initialisierung wieder automatisch auf den Standard zurückgesetzt.
Parameter:key → Schlüssel
value → Wert
Rückgabewert:kein
Beispiel:$TP->MenuIni("class", "menu_item")

Menu

Syntax:string Menu (string $name)
Beschreibung:Anzeige des Menüs
Parameter:name → Menüname
Rückgabewert:Menü
Beispiel:echo $TP->Menu("Main");

MenuRedirect

Syntax:string MenuRedirect (string $name)
Beschreibung:Automatische Weiterleitung vom Hauptmenüpunkt zum ersten Untermenüpunkt
Parameter:name → Menüname
Rückgabewert:kein
Beispiel:echo $TP->MenuRedirect("Main");

MenuPath

Syntax:string MenuPath (string $name [, string $separator])
Beschreibung:Anzeige des aktuellen Menüpfades (Hauptmenüpunkt » Untermenüpunkt » Unter-Untermenüpunkt » ...)
Parameter:name → Menüname
separator → Trennzeichen (optional, Standard = "»")
Rückgabewert:Menüpfad
Beispiel:echo $TP->MenuPath("Main");
echo $TP->MenuPath("Main", ">");

NumberMenu

Syntax:string NumberMenu (string $name [, boolean $all] [, integer $left] [, integer $right])
Beschreibung:Anzeige des Nummern-Menüs (z.B. 1,2,3,...,18,19,20)
Parameter:name → Menüname
all → Alle Menüpunkte anzeigen ohne "..." (optional, Standard = false)
left → Anzahl Menüpunkte auf der linken Seite (optional, Standard = 3)
right → Anzahl Menüpunkte auf der rechten Seite (optional, Standard = 3)
Rückgabewert:Menü
Beispiel:echo $TP->NumberMenu("Main");
echo $TP->NumberMenu("Main", true);
echo $TP->NumberMenu("Main", false, 10);
echo $TP->NumberMenu("Main", false, 5, 5);

SessionEnable

Syntax:string SessionEnable ()
Beschreibung:Server-Session aktivieren
Hinweis:Die Aktivierung einer Server-Session ist in der Regel nicht nötig, Ausnahmen sind z.B. die Shop-Anwendung
Parameter:kein
Rückgabewert:kein
Beispiel:echo $TP->SessionEnable();

Template

Syntax:string Template (string $name)
Beschreibung:Template in die Webseite einbinden
Hinweis:Alle Templates sind im Template-Verzeichnis (../wcms/template/) gespeichert
Parameter:name → Template-Name
Rückgabewert:Template-Ausgabe
Beispiel:echo $TP->Template("Name");

Title

Syntax:string Title ([string $title])
Beschreibung:Titel der Webseite anzeigen
Hinweis:Diese Funktion im Head-Bereich Ihres Layouts verwenden
Parameter:title → Titel der Webseite (optional, Standard = "Typepress")
Rückgabewert:Titel der Webseite
Beispiel:echo $TP->Title();
echo $TP->Title("Titel");

UpdateDate

Syntax:string UpdateDate ([string $format])
Beschreibung:Anzeige des letzen Update-Zeitpunktes des Internetauftrittes
Parameter:format → Format der Datum-Zeit-Ausgabe (optional, Standard = "d.m.Y")
Rückgabewert:Update-Zeitpunkt
Beispiel:echo $TP->UpdateDate();
echo $TP->UpdateDate("d.m.Y h:i:s");