SilverStripe\CMS\Controllers\CMSSiteTreeFilter_Search
Synopsis
class CMSSiteTreeFilter_Search
extends CMSSiteTreeFilter
{
- // Inherited members from CMSSiteTreeFilter
- protected array $params;
- protected $_cache_ids;
- protected $_cache_highlight_ids;
- protected array $_cache_expanded;
- protected $childrenMethod;
- protected string $numChildrenMethod;
- // methods
- public static void title()
- public SS_List getFilteredPages()
- // Inherited methods from CMSSiteTreeFilter
- public static array get_all_filters()
- public void __construct()
- public void getChildrenMethod()
- public void getNumChildrenMethod()
- public void getPageClasses()
- public abstract SS_List getFilteredPages()
- public array pagesIncluded()
- protected void populateIDs()
- public void isPageIncluded()
- protected DataList applyDefaultFilters()
- protected array mapIDs()
Hierarchy
Members
protected
- $_cache_expanded — array
- $_cache_highlight_ids
—
array
Subset of $_cache_ids which include only items that appear directly in search results. - $_cache_ids
—
array
List of filtered items and all their parents - $childrenMethod — string
- $numChildrenMethod — string
- $params
—
array
Search parameters, mostly properties on {@link SiteTree}.
Methods
public
- getFilteredPages() — Retun an array of maps containing the keys, 'ID' and 'ParentID' for each page to be displayed in the search.
- title()
Inherited from SilverStripe\CMS\Controllers\CMSSiteTreeFilter
protected
- applyDefaultFilters() — Applies the default filters to a specified DataList of pages
- mapIDs() — Maps a list of pages to an array of associative arrays with ID and ParentID keys
- populateIDs() — Populate the IDs of the pages returned by pagesIncluded(), also including the necessary parent helper pages.
public
- getChildrenMethod()
- getFilteredPages() — Gets the list of filtered pages
- getNumChildrenMethod()
- getPageClasses()
- get_all_filters() — Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.
- isPageIncluded()
- pagesIncluded()