CMSSiteTreeFilter_StatusDraftPages
class CMSSiteTreeFilter_StatusDraftPages extends CMSSiteTreeFilter (View source)
Filters pages which have a status "Draft".
Traits
A class that can be instantiated or replaced via DI
Properties
| protected deprecated | array | $params | Search parameters, mostly properties on SiteTree. |
from CMSSiteTreeFilter |
| protected deprecated | array | $_cache_ids | List of filtered items and all their parents |
from CMSSiteTreeFilter |
| protected deprecated | array | $_cache_highlight_ids | Subset of $_cache_ids which include only items that appear directly in search results. |
from CMSSiteTreeFilter |
| protected deprecated | array | $_cache_expanded | from CMSSiteTreeFilter | |
| protected deprecated | string | $childrenMethod | from CMSSiteTreeFilter | |
| protected deprecated | string | $numChildrenMethod | from CMSSiteTreeFilter |
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.
Populate the IDs of the pages returned by pagesIncluded(), also including the necessary parent helper pages.
Applies the default filters to a specified DataList of pages
Maps a list of pages to an array of associative arrays with ID and ParentID keys
Details
static Injectable
create(mixed ...$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::class); $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)
No description
string
getChildrenMethod()
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it.
No description
string
getNumChildrenMethod()
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it.
No description
array|string
getPageClasses(DataObject $page)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
No description
SS_List
getFilteredPages()
Filters out all pages who's status is set to "Draft".
array
pagesIncluded()
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
No description
protected
populateIDs()
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
Populate the IDs of the pages returned by pagesIncluded(), also including the necessary parent helper pages.
bool
isPageIncluded(DataObject $page)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
No description
protected DataList
applyDefaultFilters(DataList $query)
deprecated
deprecated 5.4.0 Will be replaced with a SearchContext subclass
Applies the default filters to a specified DataList of pages
protected array
mapIDs(SS_List $pages)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
Maps a list of pages to an array of associative arrays with ID and ParentID keys
static
title()
No description