class PaginationPlugin implements FieldPlugin, SchemaUpdater (View source)

Generic pagination functionality for a query that can be customised in subclasses

Traits

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

A class that can be instantiated or replaced via DI

Constants

IDENTIFIER

Config options

default_limit int
max_limit int
resolver ?callable

Properties

Methods

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

No description

protected
array
getPaginationResolver(array $config)

No description

public static 
void
updateSchema(Schema $schema)

No description

public
void
apply(Field $field, Schema $schema, array $config = [])

No description

public static 
array
createPaginationResult(int $total, iterable $limitedResults, int $limit, int $offset)

No description

public static 
mixed
noop($obj)

"node" is just structural and should use a noop

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 uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

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

string getIdentifier()

No description

Return Value

string

protected array getPaginationResolver(array $config)

No description

Parameters

array $config

Return Value

array

Exceptions

SchemaBuilderException

static void updateSchema(Schema $schema)

No description

Parameters

Schema $schema

Return Value

void

Exceptions

SchemaBuilderException

void apply(Field $field, Schema $schema, array $config = [])

No description

Parameters

Field $field
Schema $schema
array $config

Return Value

void

Exceptions

SchemaBuilderException

static array createPaginationResult(int $total, iterable $limitedResults, int $limit, int $offset)

No description

Parameters

int $total
iterable $limitedResults
int $limit
int $offset

Return Value

array

static mixed noop($obj)

"node" is just structural and should use a noop

Parameters

$obj

Return Value

mixed