Die Dokument-Klasse ToFolksReference

Die Klasse ToFolksReference wird zur Eingabe von einfachen Referenzen, mehrfachen Referenzen und Related-Items bei der Dokument-Typ-Definition benutzt. Sie wird über die Eigenschaft content des Dokuments angesprochen.

Achten Sie darauf, dass Referenzen, ähnlich wie bei Bildern, im Grundsatz immer Mehrfach-Referenzen sind. Dies bedeutet, dass sie nicht so ausgelesen werden

$doc->content["myreference"]->reference;


sondern immer so

$doc->content["myreference"][0]->reference;
$doc->content["myreference"][1]->reference;
$doc->content["myreference"][...]->reference;
 

Auch, wenn es sich nur um eine einfache Referenz handelt. 

Eigenschaften:

  • title
    Titel des Zieldokuments, Titel der Datei bzw. Titel des Menü-Items.
  • description
    Hier findet sich die Kurzbeschreibung (shortDescription) bei einer Dokument-Referenz bzw. die Beschreibung bei einer Datei-Referenz. Bei einer Referenz auf ein Menü-Item ist die description leer.
  • referenceType
    'D' für Dokumentreferenz, 'M' für eine Referenz auf ein Menü-Item und 'F' für eine Referenz auf eine Datei. 
  • documentId
    Hier steht, im Falle einer Dokument-Referenz die ID des Dokuments ansonsten null. Diese ID kann benutzt werden, um das entsprechende Dokument über die Funktion $toFolks->GetDocument(int <ID>) zu bekommen.
  • menuItemId
    Hier steht, im Falle einer Menü-Item-Referenz die ID des Menü-Items, ansonsten null. Diese ID kann benutzt werden, um das entsprechende Dokument über die Funktion $toFolks->GetMenuItem(<ID>) zu bekommen.
  • isLive
    Für ein publiziertes Dokument, ein sichtbares Menü oder eine publizierte Datei true, sonst false.
  • url
    Die URL auf das Ziel.
  • reference
    Falls das Ziel publiziert ist, bzw. das Menü-Item sichtbar, enthält diese Eigenschaft einen kompletten Anchor TAG auf das Ziel. Sollte das Ziel nicht publiziert sein, enthält diese Eigenschaft den gleichen Wert, wie die Eigenschaft title.
  • mimeType
    Der MimeTyp, falls es sich um eine Datei-Referenz handelt.
  • downloadCounter
    Die Anzahl der Downloads, wenn es sich um eine Datei-Referenz handelt, sonst 0.
  • fileLocation
    Hier finden Sie den Pfad incl. Dateinamen auf die Datei, falls es sich bei der Referenz um eine Datei-Referenz handelt. Diesen Pfad benutzen Sie immer dann, wenn Sie z.B. eine Flash Animation einbinden möchten. Dann können Sie nicht den URL auf die Datei benutzen, sondern verwenden im Object-Tag die fileLocation.
  • fileName
    Hier finden Sie den Namen der Datei, falls es sich bei der Referenz um eine Datei-Referenz handelt.
  • displayName
    Hier steht der Anzeige-Name, so wie er von Ihnen in der Dokument-Typ-Definition vergeben wurde.
  • type
    Type enthält den Namen der Klasse, also "ToFolksReference"