CMSSiteTreeFilter_Search
class CMSSiteTreeFilter_Search extends CMSSiteTreeFilter (View source)
Traits
A class that can be instantiated or replaced via DI
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.
Method on {@link Hierarchy} objects which is used to traverse into children relationships.
Method on {@link Hierarchy} objects which is used find the number of children for a parent page
Given a page, determine any additional CSS classes to apply to the tree node
Retun an array of maps containing the keys, 'ID' and 'ParentID' for each page to be displayed in the search.
No description
Details
static Injectable
create(array ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static array
get_all_filters()
Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.
__construct($params = null)
string
getChildrenMethod()
Method on {@link Hierarchy} objects which is used to traverse into children relationships.
string
getNumChildrenMethod()
Method on {@link Hierarchy} objects which is used find the number of children for a parent page
array|string
getPageClasses(DataObject $page)
Given a page, determine any additional CSS classes to apply to the tree node
SS_List
getFilteredPages()
Retun an array of maps containing the keys, 'ID' and 'ParentID' for each page to be displayed in the search.
array
pagesIncluded()
bool
isPageIncluded(DataObject $page)
Returns TRUE if the given page should be included in the tree.
Caution: Does NOT check view permissions on the page.