class CMSSiteTreeFilter_StatusRemovedFromDraftPages extends CMSSiteTreeFilter (View source)

Filters pages which have a status "Removed from Draft".

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

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()

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

getFilteredPages()

Filters out all pages who's status is set to "Removed from draft".

array
pagesIncluded()

No description

bool
isPageIncluded(DataObject $page)

Returns TRUE if the given page should be included in the tree.

static 
title()

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::class); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static array get_all_filters()

Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.

Return Value

array

__construct($params = null)

Parameters

$params

string getChildrenMethod()

Method on {@link Hierarchy} objects which is used to traverse into children relationships.

Return Value

string

string getNumChildrenMethod()

Method on {@link Hierarchy} objects which is used find the number of children for a parent page

Return Value

string

array|string getPageClasses(DataObject $page)

Given a page, determine any additional CSS classes to apply to the tree node

Parameters

DataObject $page

Return Value

array|string

SS_List getFilteredPages()

Filters out all pages who's status is set to "Removed from draft".

Return Value

SS_List

array pagesIncluded()

Return Value

array

Map of Page IDs to their respective ParentID values.

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.

Parameters

DataObject $page

Return Value

bool

static title()