Die Klasse ToFolksModul

Mit Hilfe dieser Klasse können Sie die Eigenschaften eines Moduls auslesen, welches Sie sich zuvor über die globale Variable $toFolks geholt haben:

global $toFolks;
$myModul = $toFolks->GetModul('mymodulname');
...

 

Eigenschaften:

  • title
    Der Titel des Moduls.  Um auszeichnende Zeichen zu wandeln, müssen Sie die PHP Funktion htmlspecialchars() benutzen.
  • parameters
     Hier findet sich ein assoziatives Array mit  den frei definierten Parametern des Moduls.
    Jedes Element dieses Arrays ist ein Objekt von dem Typ, den Sie bei der Definition der Parameter festgelegt haben. Der Key des Arrays ist hierbei der von Ihnen bei der Definition vergebene Begriff.

    // ein Modul
    $myModul = $toFolks->GetModul('mymodulname');
    // ein Char, welches im Typ mit dem Namen "email" definiert wurde
    $targetMail = $myModul->parameters["email"]->mailto;

    Wie Sie bei jedem Objekt an die gewünschten Daten kommen, entnehmen Sie bitte der Beschreibung der einzelnen Objekte hier in der API.

Methoden:

  • array(ToFolksDocument) GetDocuments()
    Liefert bei Content-Modulen die verknüpften publizierten Dokumente zurück.