class GridFieldPageCount extends AbstractGridFieldComponent implements GridField_HTMLProvider (View source)

GridFieldPage displays a simple current page count summary.

E.g. "View 1 - 15 of 32"

Depends on GridFieldPaginator} being added to the {@link GridField.

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Config options

require_paginator bool

Flag indicating whether or not this control should throw an error if a GridFieldPaginator} is not present on the same {@link GridField

Properties

protected string $targetFragment

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

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
__construct(string $targetFragment = 'before')

No description

protected
getPaginator(GridField $gridField)

Retrieves an instance of a GridFieldPaginator attached to the same control

public
array
getHTMLFragments(GridField $gridField)

No description

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

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

__construct(string $targetFragment = 'before')

No description

Parameters

string $targetFragment

The fragment indicating the placement of this page count

protected GridFieldPaginator getPaginator(GridField $gridField)

Retrieves an instance of a GridFieldPaginator attached to the same control

Parameters

GridField $gridField

The parent gridfield

Return Value

GridFieldPaginator

The attached GridFieldPaginator, if found.

Exceptions

LogicException

array getHTMLFragments(GridField $gridField)

No description

Parameters

GridField $gridField

Return Value

array