class CMSSiteTreeFilter_PublishedPages extends CMSSiteTreeFilter (View source)

This filter will display the SiteTree as a site visitor might see the site, i.e only the pages that is currently published.

Note that this does not check canView permissions that might hide pages from certain visitors

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public static 
array
get_all_filters()

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

public static 
string
title()

Get a title for this filter to display to the user (e.g. in a dropdown field).

public
getFilteredPages(DataList $list)

Filters out all pages who's status who's status that doesn't exist on live

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

Parameters

mixed ...$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

static string title()

Get a title for this filter to display to the user (e.g. in a dropdown field).

Return Value

string

DataList getFilteredPages(DataList $list)

Filters out all pages who's status who's status that doesn't exist on live

Parameters

DataList $list

Return Value

DataList