class GridFieldPageCount implements GridField_HTMLProvider (View source)

GridFieldPage displays a simple current page count summary.

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

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

Traits

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

Properties

static private bool $require_paginator

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

Methods

static Config_ForClass
config()

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

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

__construct(string $targetFragment = 'before')

No description

array
getHTMLFragments(GridField $gridField)

No description

Details

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(string $targetFragment = 'before')

Parameters

string $targetFragment

The fragment indicating the placement of this page count

array getHTMLFragments(GridField $gridField)

Parameters

GridField $gridField

Return Value

array