Die Klasse ToFolksDocument

Die Objekte vom Typ ToFolksDocument stellen die zentralen Inhalt Ihres Webauftritts dar. Natürlich können sich Inhalte wie Listenüberschriften auch in den Parametern von Modulen und Menü-Items verbergen, aber dennoch geht es in erster Linie um die Dokumente. Das wichtigste Dokument ist hierbei sicherlich das Dokument, welches in einer Volldarstellung angezeigt werden soll. Sie finden es in der globalen Variable $toFolks->selectedDocument

Eigenschaften:

  • title
    Der Titel des Dokuments.  Um auszeichnende Zeichen zu wandeln, müssen Sie die PHP Funktion htmlspecialchars() benutzen.
  • shortDescription
    Die Kurzbeschreibung des Dokuments. Sie wird im Eingabeformular verfügbar, wenn Sie das TitleAddOn Property in der XML - Definition freischalten. Um auszeichnende Zeichen zu wandeln, müssen Sie die PHP Funktion htmlspecialchars() benutzen.
  • creationTimestamp
    PHP DateTime mit dem Datum und Uhrzeit des Erstellungszeitpunkts des Dokuments. 
  • lastEditTimestamp
    PHP DateTime mit dem Datum und Uhrzeit des letzten Änderungszeitpunkts des Dokuments.
  • documentType
    Der Call-Name des Dokumenten-Typs, so, wie er bei der Definition des Dokument-Typs von Ihnen vergeben wurde.
  • content
    Hier findet sich ein assoziatives Array mit  den Inhalten des Dokuments (abgesehen von Titel, Kurzbeschreibung und Metadaten, die Sie im direkten Zugriff haben).
    Jedes Element dieses Arrays ist ein Objekt von dem Typ, den Sie bei der Definition des Dokumenten-Typs festgelegt haben. Der Key des Arrays ist hierbei der von Ihnen bei der Definition vergebene Begriff.

    // das aktuelle Dokument
    $doc = $toFolks->selectedDocument;
    // der Titel
    echo $doc->title;
    // ein Char, welches im Typ mit dem Namen "untertitel" definiert wurde
    echo $doc->content["untertitel"]->value;

    Wie Sie bei jedem Objekt an die gewünschten Daten kommen, entnehmen Sie bitte der Beschreibung der einzelnen Objekte hier in der API.
  • selectedPage
    Hier finden Sie die aktuelle Seitennummer des Dokuments, falls es sich um ein paginiertes Dokument handelt.
  • menuItem
    Dies ist ein Objekt vom Typ ToFolksMenuItem, welches Ihnen Zugriff auf das Menü-Item bietet, unter welchem das Dokument liegt. 
  • id
    Die Datenbank-ID des Dokuments.
  • url
    Die komplette ULR des Dokuments.
  • nakedUrl
    Hier ist die "nackte" URL des Dokuments hinterlegt. Diese URL enthält weder Paginationen, Parameter oder eine Dokument-Endung.

Methoden:

  • array(ToFolksDocument) GetReferencedBy()
    Durch den Aufruf dieser Methode kann man eine Liste aller Dokumente erhalten, die dieses Dokument in irgend einem Property referenzieren.
  • string GetPagination(int <numberOfElements>, int <maxItemsPerPage>, int <maxVisiblePageNumbers>, string <textFirst>, string <textPrevious>, string <textNext>, string <textLast>, string <separator>)
    Liefert eine Pagination für das Dokument zurück. Dies ist z.B. hilfreich, wenn ein Dokument eine Bilderstrecke darstellt, die paginiert werden soll.
    <numberOfElements>: die maximale Anzahl der Elemente, in die das Dokument unterteilt werden soll
    <maxItemsPerPage>: die maximale Anzahl von Elementen pro Seite
    <maxVisiblePageNumbers>: die maximale Anzahl angezeigter Seitennummern
    <textFirst>: Text für den Rewind zum Beginn des Dokuments (wenn leer, dann keine Anzeige)
    <textPrevious>: Text für den Rewind zur vorhergehenden Seite des Dokuments (wenn leer, keine Anzeige)
    <textNext>: Text für den Vorlauf zur nächsten Seite des Dokuments (wenn leer, keine Anzeige)
    <textLast>: Text für den Sprung zur letzten Seite des Dokuments (wenn leer, keine Anzeige)
    <separator>: Text für den Separator zwischen den Seitenzahlen
    Diese Methode steht Ihnen beim Schreiben des Scripts von dynamsichen Modulen oder dynamischen Menüs nicht zur Verfügung.