\SnippetHierarchy
Synopsis
class SnippetHierarchy
extends DataExtension
{
- // members
- protected $markedNodes;
- protected $markingFilter;
- protected Int $_cache_numChildren;
- protected static array $marked = ;
- protected static array $expanded = ;
- protected static array $treeOpened = ;
- // methods
- public void validate()
- public array parentStack()
- public DataObject getParent()
- public SS_List getAncestors()
- public DataObject naturalNext()
- public int markPartialTree()
- public void markChildren()
- public void markById()
- public void markToExpose()
- public int numChildren()
- public string getChildrenAsUL()
- public void setMarkingFilter()
- public void setMarkingFilterFunction()
- public boolean markingFilterMatches()
- protected void markingFinished()
- public void markingClasses()
- public void markedNodeIDs()
- public void markExpanded()
- public void markUnexpanded()
- public void markOpened()
- public boolean isMarked()
- public boolean isExpanded()
- public void isTreeOpened()
- public void partialTreeAsUL()
- public int getDescendantIDList()
- public void loadDescendantIDListInto()
- public SS_List Children()
- public SS_List AllChildren()
- public SS_List AllChildrenIncludingDeleted()
- public SS_List doAllChildrenIncludingDeleted()
- public SS_List stageChildren()
- public String getBreadcrumbs()
- public void naturalPrev()
- public void flushCache()
- public static void reset()
Hierarchy
Extends
- DataExtension
Tasks
Line | Task |
---|---|
617+ | Write! |
Members
protected
- $_cache_numChildren — Int
- $expanded
—
boolean
True if this DataObject is expanded. - $marked
—
boolean
True if this DataObject is marked. - $markedNodes
- $markingFilter
- $treeOpened
—
boolean
True if this DataObject is opened.
Methods
protected
- markingFinished() — Ensure marked nodes that have children are also marked expanded.
public
- AllChildren() — Return all children, including those 'not in menus'.
- AllChildrenIncludingDeleted() — Return all children, including those that have been deleted but are still in live.
- Children() — Get the children for this DataObject.
- doAllChildrenIncludingDeleted()
- flushCache()
- getAncestors() — Return all the parents of this class in a set ordered from the lowest to highest parent.
- getBreadcrumbs() — Returns a human-readable, flattened representation of the path to the object, using its {@link Title()} attribute.
- getChildrenAsUL() — Returns the children of this DataObject as an XHTML UL. This will be called recursively on each child, so if they have children they will be displayed as a UL inside a LI.
- getDescendantIDList() — Get a list of this DataObject's and all it's descendants IDs.
- getParent() — Get the parent of this class.
- isExpanded() — Check if this DataObject is expanded.
- isMarked() — Check if this DataObject is marked.
- isTreeOpened() — Check if this DataObject's tree is opened.
- loadDescendantIDListInto() — Get a list of this DataObject's and all it's descendants ID, and put it in $idList.
- markById() — Mark the children of the DataObject with the given ID.
- markChildren() — Mark all children of the given node that match the marking filter.
- markExpanded() — Mark this DataObject as expanded.
- markOpened() — Mark this DataObject's tree as opened.
- markPartialTree() — Mark a segment of the tree, by calling mark().
- markToExpose() — Expose the given object in the tree, by marking this page and all it ancestors.
- markUnexpanded() — Mark this DataObject as unexpanded.
- markedNodeIDs() — Return the IDs of all the marked nodes
- markingClasses() — Return CSS classes of 'unexpanded', 'closed', both, or neither, depending on the marking of this DataObject.
- markingFilterMatches() — Returns true if the marking filter matches on the given node.
- naturalNext() — Get the next node in the tree of the type. If there is no instance of the className descended from this node, then search the parents.
- naturalPrev() — Get the next node in the tree of the type. If there is no instance of the className descended from this node, then search the parents.
- numChildren() — Return the number of direct children.
- parentStack() — Return an array of this page and its ancestors, ordered item -> root.
- partialTreeAsUL() — Return a partial tree as an HTML UL.
- reset()
- setMarkingFilter() — Filter the marking to only those object with $node->$parameterName=$parameterValue
- setMarkingFilterFunction() — Filter the marking to only those where the function returns true.
- stageChildren() — Return children from the stage site
- validate() — Validate the owner object - check for existence of infinite loops.