Die globale Variable $toFolks

Die globale Variable $toFolks, vom Typ ToFolks, ist sicher die häufigste, die Ihnen begegenen wird. Sie wird in der Regel in allen Templates, Menüs und Modulen gleich zu Beginn eingebunden:

global $toFolks;

Eigenschaften:

  • domain
    Hier findet sich der im CMS hinterlegte Domainname (2FOLKS Client -> Globale Einstellungen).
  • documentExtension
    Dateiendung der Dokumente (php | html | ...) (2FOLKS Client -> Globale Einstellungen)
    Beachten Sie bitte, dass bei der Verwendung von dynamischen Modulen oder Menüs der Server Dateien mit der jeweiligen Endung an den PHP-Preprozessor übergeben können muss.
  • stylesheet
    Enthält einen kompletten Link für die Einbindung eines Style Sheets, für den Fall, dass in den globalen Einstellungen eines eingestellt ist. Ansonsten ist das Property leer. (2FOLKS Client -> Globale Einstellungen)
    Über den 2FOLKS Client wird immer nur ein Stylesheet eingebunden. Sie können im Template jederzeit noch weitere Stylesheets einbinden, aber nur das im Client eingebundene Stylesheet wird auch zu Anzeige im HTML Property-Editor benutzt.
  • favicon
    Enthält einen kompletten Link für den Header als Referenz auf das Favicon, falls eines in den globalen Einstellungen eingestellt ist – ansonsten einen Leerstring.
  • pageTitle
    Name der HTML Seite. Der Name wird im Falle von Listendarstellungen aus den Parametern des Menü-Items bezogen. Bei Vollansichten aus den Metadaten des entsprechenden Dokuments.
  • metaKeywords
    META Keywords der HTML Seite. Die Keywords werden im Falle von Listendarstellungen aus den Parametern des Menü-Items bezogen. Bei Vollansichten aus den Metadaten des entsprechenden Dokuments.
  • metaDescription
    META Description der HTML Seite. Die Description wird im Falle von Listendarstellungen aus den Parametern des Menü-Items bezogen. Bei Vollansichten aus den Metadaten des entsprechenden Dokuments.
  • sessionNeeded
    true: Mindestens ein Menü oder Modul benötigt eine Session und daher wurde vor allen Ausgaben ein start_session(); eingefügt:
    false: Kein Session wurde gestartet.
  • selectedMenuItem
    Das aktuell selektierte Menü-Item als Objekt der Klasse ToFolksMenueItem.
  • menuItems
    Array mit allen Menü-Items des Typs ToFolksMenuItem. Key des Arrays ist die ID des Menü-Items.
  • selectedDocument
    Das aktuell angezeigte Dokument als Objekt der Klasse ToFolksDocument.
  • urlParameters
    Assoziatives Array mit Name-Value Pairs, die als Parameter übergeben wurden. (In URL durch $ getrennt).
  • isHomepage
    true: Bei der aktuellen Seite handelt es sich um die Homepage.
    false: Bei der aktuellen Seite handelt es sich nicht um die Homepage (was sonst...).
  • nogif
    Platzhalter für einen Link auf ein leeres Bild. Kann als Source-Attribut für ein leeres Bild verwendet werden.
    src="<?php echo $toFolks->nogif; ?>"
  • gfxPath
    Stellt den Pfad auf das GFX-Verzeichnis zur Verfügung (abschließender Slash enthalten)
    src="<?php echo $toFolks->gfxPath ?>meinbild.gif"
  • scriptPath
    Stellt den Pfad zu den von Ihnen eingegebenen Scripten bereit (abschließender Slash enthalten)
    require_once($toFolks->scriptPath.'color.php');

Methoden:

  • void IncludeMenu(string <Call-Name des Menüs>)
    Ruft ein Menü anhand des Call-Name auf und fügt es an der aufrufenden Stelle in das Dokument ein. Der Aufruf erfolgt in der Regel in einem Template.
    Bei statischen Menüs wird der Menü-Code ausgeführt und die Ausgabe des Menüs an der Stelle des Aufrufs eingefügt.
    Diese Methode steht Ihnen beim Schreiben des Scripts von dynamsichen Modulen oder dynamischen Menüs nicht zur Verfügung.
  • void IncludeModul(string <Call-Name des Moduls>)
    Ruft ein Modul anhand des Call-Name auf und fügt es an der aufrufenden Stelle in das Dokument ein. Der Aufruf erfolgt in der Regel in einem Template.
    Bei statischen Modulen wird das Modul ausgeführt und die Ausgabe des Moduls an der Stelle des Aufrufs eingefügt.
    Diese Methode steht Ihnen beim Schreiben des Scripts von dynamsichen Modulen oder dynamischen Menüs nicht zur Verfügung.
  • ToFolksModul GetModul(string <Call-Name des Moduls>)
    Liefert ein Objekt vom Typ ToFolksModul anhand seines Call-Name zurück um z.B. die Parameter des Moduls auszulesen. Dieser Aufruf erfolgt in der Regel in einem Modul.
  • array(ToFolksMenuItem) GetMenuItems(string <Call-Name des Menüs>)
    Liefert die Liste der ersten Ebene der Menü Items eines Menüs zurück. Parameter ist der Call-Name, das Ergebnis ist ein Array von Variablen des Typs ToFolksMenuItem.
  • ToFolksDocument GetDocument(int <ID des Dokuments>)
    Liefert ein Dokument als Objekt vom Typ ToFolksDocument anhand der übergebenen ID zurück.
    Es werden nur publizierte Dokumente zurückgeliefert.