class GridFieldFooter extends AbstractGridFieldComponent implements GridField_HTMLProvider (View source)

Adding this class to a GridFieldConfig} of a {@link GridField adds a footer bar to that field.

The footer looks just like the GridFieldPaginator control, except without the pagination controls.

It only display the "Viewing 1-8 of 8" status text and (optionally) a configurable status message.

The purpose of this class is to have a footer that can round off GridField without having to use pagination.

Traits

A class that can be instantiated or replaced via DI

Properties

protected string $message

A message to display in the footer

protected bool $showrecordcount

True to show record count

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
__construct(string $message = null, bool $showrecordcount = true)

No description

public
array
getHTMLFragments(GridField $gridField)

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

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

__construct(string $message = null, bool $showrecordcount = true)

No description

Parameters

string $message

A message to display in the footer

bool $showrecordcount

array getHTMLFragments(GridField $gridField)

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

Here are 4 built-in fragments: 'header', 'footer', 'before', and 'after', but components may also specify fragments of their own.

To specify a new fragment, specify a new fragment by including the text "$DefineFragment(fragmentname)" in the HTML that you return.

Fragment names should only contain alphanumerics, -, and _.

If you attempt to return HTML for a fragment that doesn't exist, an exception will be thrown when the GridField is rendered.

Parameters

GridField $gridField

Return Value

array