\CMSSiteTreeFilter
Base class for filtering the subtree for certain node statuses.
The simplest way of building a CMSSiteTreeFilter is to create a pagesToBeShown() method that
returns an Iterator of maps, each entry containing the 'ID' and 'ParentID' of the pages to be
included in the tree. The reuslt of a DB::query() can be returned directly.
If you wish to make a more complex tree, you can overload includeInTree($page) to return true/
false depending on whether the given page should be included. Note that you will need to include
parent helper pages yourself.
Synopsis
class CMSSiteTreeFilter
extends Object
{
- // methods
- public static void showInList()
- public void getTree()
- protected void populateIDs()
- public void includeInTree()
Hierarchy
Extends
- Object
Members
protected
- $expanded
- $ids
Methods
protected
- populateIDs() — Populate $this->ids with the IDs of the pages returned by pagesIncluded(), also including the necessary parent helper pages.
public
- getTree()
- includeInTree() — Returns true if the given page should be included in the tree.
- showInList()