obj objRef getHierarchy

Verfügbar für: Content Management Server, Template Engine

Aufgabe: Liefert die unterhalb des angegebenen Ordners liegende Ordnerhierarchie zurück.

Syntax:

obj (withId objId) | (withPath path) | root getHierarchy {parameter value}

Zusatzinformationen: Die Hierarchie enthält nur die IDs der Dateien, auf die der Benutzer lesend zugreifen darf (TE-Benutzer haben immer root-Zugriff und können daher alle Dateien lesen). Die Hierarchie wird als eine Tcl-Liste mit zwei Elementen zurückgegeben. Das erste Element dieser Liste kann 0 oder 1 sein und zeigt an, ob die Hierarchie abgeschnitten werden musste (1) oder nicht (0). Das zweite Element ist eine Liste, die die eigentliche Hierarchie enthält. In dieser Liste ist jede CMS-Datei, die kein Ordner ist, durch ihre ID repräsentiert. Ordner dagegen sind als Listen repräsentiert, deren erstes Element die ID des Ordners und deren zweites Element der Inhalt des Ordners in Form einer Liste ist.

Funktionsparameter:

  • parameter spezifiziert den Namen eines Parameters, dessen Wert im entsprechenden value erwartet wird. Es gibt die folgenden Parameternamen:

    • maxDepth: gibt die maximale Tiefe an, die die ermittelte Hierarchie aufweisen darf. Der voreingestellte Wert ist 4, sofern er nicht durch die Benutzereinstellung maxHierarchyDepth (in den persönlichen Einstellungen oder den allgemeinen Benutzereinstellungen userManagement.preferences) überschrieben wurde.

      Der Wert -1 steht für eine unbeschränkte Tiefe (ab Version 6.7.2).

    • maxLines: gibt die Anzahl der Dateien an, die maximal in der zurückgegebenen Hierarchie enthalten sein dürfen. Der voreingestellte Wert ist 200, sofern er nicht durch die Benutzereinstellung maxHierarchyLines (in den persönlichen Einstellungen oder den allgemeinen Benutzereinstellungen userManagement.preferences) überschrieben wurde.

      Der Wert -1 steht für eine unbeschränkte Anzahl (ab Version 6.7.2).

    • objTypes: gibt die Liste der Dateitypen an, auf die die Hierarchie beschränkt werden soll. Voreingestellt sind nur Dateien vom Typ publication in der Hierarchie enthalten. Wird dieser Parameter angegeben und fehlt in der Liste der Typ publication, so ergibt sich keine Hierarchie.

  • value enthält den Wert für den betreffenden Parameter.

Rückgabewert bei Erfolg: die Hierarchie als kodierte Tcl-Liste (stringlist).

Erforderliche Rechte (nur CM): der Benutzer muss das Recht permissionRead für die angegebene Datei haben.

Beispiel:

CM>obj root getHierarchy
0 {2001 {2012 {2086 2099}}}

Verwenden Sie den folgenden Befehl, um Ihre persönliche maxHierarchyLines-Einstellung zu ändern.

CM>userConfig setTexts maxHierarchyLines 250
Weiterführende Links